gfx/thebes/public/gfxPath.h

   1 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   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 IBM Corporation code.
  16  *
  17  * The Initial Developer of the Original Code is IBM Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2007
  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 the GNU General Public License Version 2 or later (the "GPL"), or
  25  * 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 GFX_PATH_H
  38 #define GFX_PATH_H
  39
  40 #include "gfxTypes.h"
  41
  42 class gfxContext;
  43 struct gfxPoint;
  44 typedef struct cairo_path cairo_path_t;
  45
  46 /**
  47  * Class representing a path. Can be created by copying the current path
  48  * of a gfxContext.
  49  */
  50 class THEBES_API gfxPath {
  51     THEBES_INLINE_DECL_REFCOUNTING(gfxPath)
  52
  53     friend class gfxContext;
  54
  55 protected:
  56     gfxPath(cairo_path_t* aPath);
  57
  58 public:
  59     virtual ~gfxPath();
  60
  61 protected:
  62     cairo_path_t* mPath;
  63 };
  64
  65 /**
  66  * Specialization of a path that only contains linear pieces. Can be created
  67  * from the existing path of a gfxContext.
  68  */
  69 class THEBES_API gfxFlattenedPath : public gfxPath {
  70     friend class gfxContext;
  71
  72 protected:
  73     gfxFlattenedPath(cairo_path_t* aPath);
  74
  75 public:
  76     virtual ~gfxFlattenedPath();
  77
  78     /**
  79      * Returns calculated total length of path
  80      */
  81     gfxFloat GetLength();
  82
  83     /**
  84      * Returns a point a certain distance along the path.  Return is
  85      * first or last point of the path if the requested length offset
  86      * is outside the range for the path.
  87      * @param aOffset offset inpath parameter space (x=length, y=normal offset)
  88      * @param aAngle optional - output tangent
  89      */
  90     gfxPoint FindPoint(gfxPoint aOffset,
  91                        gfxFloat* aAngle = nsnull);
  92 };
  93
  94 #endif