layout/svg/base/src/nsSVGGeometryFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is the Mozilla SVG project.
  16  *
  17  * The Initial Developer of the Original Code is IBM Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2006
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either of the GNU General Public License Version 2 or later (the "GPL"),
  25  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #ifndef __NS_SVGGEOMETRYFRAME_H__
  38 #define __NS_SVGGEOMETRYFRAME_H__
  39
  40 #include "nsFrame.h"
  41
  42 class nsSVGPaintServerFrame;
  43 class gfxContext;
  44
  45 typedef nsFrame nsSVGGeometryFrameBase;
  46
  47 /* nsSVGGeometryFrame is a base class for SVG objects that directly
  48  * have geometry (circle, ellipse, line, polyline, polygon, path, and
  49  * glyph frames).  It knows how to convert the style information into
  50  * cairo context information and stores the fill/stroke paint
  51  * servers. */
  52
  53 class nsSVGGeometryFrame : public nsSVGGeometryFrameBase
  54 {
  55 protected:
  56   nsSVGGeometryFrame(nsStyleContext *aContext) : nsSVGGeometryFrameBase(aContext) {}
  57
  58 public:
  59   // nsIFrame interface:
  60   NS_IMETHOD Init(nsIContent* aContent,
  61                   nsIFrame* aParent,
  62                   nsIFrame* aPrevInFlow);
  63
  64   virtual PRBool IsFrameOfType(PRUint32 aFlags) const
  65   {
  66     return nsSVGGeometryFrameBase::IsFrameOfType(aFlags & ~(nsIFrame::eSVG));
  67   }
  68
  69   // nsSVGGeometryFrame methods:
  70   NS_IMETHOD GetCanvasTM(nsIDOMSVGMatrix * *aCanvasTM) = 0;
  71   PRUint16 GetClipRule();
  72   PRBool IsClipChild();
  73
  74   float GetStrokeWidth();
  75
  76   /*
  77    * Set up a cairo context for filling a path
  78    * @return PR_FALSE to skip rendering
  79    */
  80   PRBool SetupCairoFill(gfxContext *aContext);
  81   /*
  82    * Set up a cairo context for measuring a stroked path
  83    * @return PR_FALSE if there is no stroke
  84    */
  85   PRBool SetupCairoStrokeGeometry(gfxContext *aContext);
  86   /*
  87    * Set up a cairo context for hit testing a stroked path
  88    * @return PR_FALSE if there is no stroke
  89    */
  90   PRBool SetupCairoStrokeHitGeometry(gfxContext *aContext);
  91   /*
  92    * Set up a cairo context for stroking a path
  93    * @return PR_FALSE to skip rendering
  94    */
  95   PRBool SetupCairoStroke(gfxContext *aContext);
  96
  97 protected:
  98   nsSVGPaintServerFrame *GetPaintServer(const nsStyleSVGPaint *aPaint,
  99                                         nsIAtom *aType);
 100
 101 private:
 102   nsresult GetStrokeDashArray(double **arr, PRUint32 *count);
 103   float GetStrokeDashoffset();
 104
 105   // Returns opacity that should be used in rendering this primitive.
 106   // In the general case the return value is just the passed opacity.
 107   // If we can avoid the expense of a specified group opacity, we
 108   // multiply the passed opacity by the value of the 'opacity'
 109   // property, and elsewhere pretend the 'opacity' property has a
 110   // value of 1.
 111   float MaybeOptimizeOpacity(float aOpacity);
 112 };
 113
 114 #endif // __NS_SVGGEOMETRYFRAME_H__