pathstrk.h

Go to the documentation of this file.
00001 // $Id: pathstrk.h 1282 2006-06-09 09:46:49Z alex $
00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
00003 ================================XARAHEADERSTART===========================
00004  
00005                Xara LX, a vector drawing and manipulation program.
00006                     Copyright (C) 1993-2006 Xara Group Ltd.
00007        Copyright on certain contributions may be held in joint with their
00008               respective authors. See AUTHORS file for details.
00009 
00010 LICENSE TO USE AND MODIFY SOFTWARE
00011 ----------------------------------
00012 
00013 This file is part of Xara LX.
00014 
00015 Xara LX is free software; you can redistribute it and/or modify it
00016 under the terms of the GNU General Public License version 2 as published
00017 by the Free Software Foundation.
00018 
00019 Xara LX and its component source files are distributed in the hope
00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the
00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00022 See the GNU General Public License for more details.
00023 
00024 You should have received a copy of the GNU General Public License along
00025 with Xara LX (see the file GPL in the root directory of the
00026 distribution); if not, write to the Free Software Foundation, Inc., 51
00027 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00028 
00029 
00030 ADDITIONAL RIGHTS
00031 -----------------
00032 
00033 Conditional upon your continuing compliance with the GNU General Public
00034 License described above, Xara Group Ltd grants to you certain additional
00035 rights. 
00036 
00037 The additional rights are to use, modify, and distribute the software
00038 together with the wxWidgets library, the wxXtra library, and the "CDraw"
00039 library and any other such library that any version of Xara LX relased
00040 by Xara Group Ltd requires in order to compile and execute, including
00041 the static linking of that library to XaraLX. In the case of the
00042 "CDraw" library, you may satisfy obligation under the GNU General Public
00043 License to provide source code by providing a binary copy of the library
00044 concerned and a copy of the license accompanying it.
00045 
00046 Nothing in this section restricts any of the rights you have under
00047 the GNU General Public License.
00048 
00049 
00050 SCOPE OF LICENSE
00051 ----------------
00052 
00053 This license applies to this program (XaraLX) and its constituent source
00054 files only, and does not necessarily apply to other Xara products which may
00055 in part share the same code base, and are subject to their own licensing
00056 terms.
00057 
00058 This license does not apply to files in the wxXtra directory, which
00059 are built into a separate library, and are subject to the wxWindows
00060 license contained within that directory in the file "WXXTRA-LICENSE".
00061 
00062 This license does not apply to the binary libraries (if any) within
00063 the "libs" directory, which are subject to a separate license contained
00064 within that directory in the file "LIBS-LICENSE".
00065 
00066 
00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
00068 ----------------------------------------------
00069 
00070 Subject to the terms of the GNU Public License (see above), you are
00071 free to do whatever you like with your modifications. However, you may
00072 (at your option) wish contribute them to Xara's source tree. You can
00073 find details of how to do this at:
00074   http://www.xaraxtreme.org/developers/
00075 
00076 Prior to contributing your modifications, you will need to complete our
00077 contributor agreement. This can be found at:
00078   http://www.xaraxtreme.org/developers/contribute/
00079 
00080 Please note that Xara will not accept modifications which modify any of
00081 the text between the start and end of this header (marked
00082 XARAHEADERSTART and XARAHEADEREND).
00083 
00084 
00085 MARKS
00086 -----
00087 
00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
00089 designs are registered or unregistered trademarks, design-marks, and/or
00090 service marks of Xara Group Ltd. All rights in these marks are reserved.
00091 
00092 
00093       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
00094                         http://www.xara.com/
00095 
00096 =================================XARAHEADEREND============================
00097  */
00098 // Definition of Path Stroking classes (used in stroke providing)
00099 
00100 #ifndef INC_PATHSTRK
00101 #define INC_PATHSTRK
00102 
00103 #include "pathtrap.h"
00104 //#include "attr.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00105 
00106 #include "strkcomp.h"
00107 
00108 class DocCoord;
00109 class ValueFunction;
00110 class Node;
00111 
00112 
00114 // Base class
00116 
00117 
00118 /******************************************************************************************
00119 
00120 >   class PathStroker : public CC_CLASS_MEMDUMP
00121 
00122     Author:     Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
00123     Created:    30/12/96
00124 
00125     Purpose:    Abstract Base class
00126                 Converts a Trapezoid (See ProcessPathToTrapezoids, pathtrap.h) stroke
00127                 definition into an output path.
00128 
00129                 The base class strokes a path with variable-width
00130 
00131 ******************************************************************************************/
00132 
00133 class PathStroker : public CC_CLASS_MEMDUMP
00134 {
00135     CC_DECLARE_MEMDUMP(PathStroker);
00136 
00137 public:         // Construction/Destruction
00138     PathStroker();
00139     PathStroker(ValueFunction *WidthFunction, INT32 LineWidth, LineCapType CapType);
00140     virtual ~PathStroker() { }
00141 
00142 public:         // Public interface
00143     virtual BOOL StrokePath(TrapsList *pTraps, Path *pOutput);
00144             // Go forth and stroke thine path
00145 
00146     // Smoothed version of above...
00147     virtual BOOL StrokeSmoothPath(TrapsList *pTraps, Path *pOutput);
00148 
00149 
00150 protected:      // Internal helper functions
00151     BOOL MapLineForwards(TrapEdgeList *Traps, Path *pOutput);
00152     void RecursiveMapLineForwards(  TrapEdge *pEdge1, DocCoord &Point1,
00153                                     TrapEdge *pEdge2, DocCoord &Point2,
00154                                     Path *pOutput);
00155 
00156     BOOL MapLineBackwards(TrapEdgeList *Traps, Path *pOutput);
00157     void RecursiveMapLineBackwards( TrapEdge *pEdge1, DocCoord &Point1,
00158                                     TrapEdge *pEdge2, DocCoord &Point2,
00159                                     Path *pOutput);
00160 
00161     BOOL MapLineCap(LineCapType CapType, TrapEdge *pEdge, BOOL IsStartCap,
00162                                     Path *pOutput);
00163 
00164 protected:
00165     ValueFunction *pWidthFunction;                  // ValueFunction providing width information
00166     INT32 MaxWidth;                                 // Maximum width (in millipoints) of the stroke
00167     LineCapType CapStyle;                           // Line cap style (butt, round, or square)
00168     INT32 RecursionDepth;                           // Recursion depth counter to avoid stack overflows
00169 };
00170 
00171 
00172 
00173 
00174 
00176 // Derived classes
00178 
00179 
00180 /******************************************************************************************
00181 
00182 >   class PathStrokerVector : public PathStroker
00183 
00184     Author:     Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
00185     Created:    20/2/97
00186 
00187     Purpose:    Path stroker
00188                 Converts a Trapezoid (See ProcessPathToTrapezoids, pathtrap.h) stroke
00189                 definition into an output path.
00190 
00191                 This "moulds" all the elements (beziers/lines) of a given path to lie
00192                 within a stroke envelope defined by the provided trapezoid list
00193 
00194 ******************************************************************************************/
00195 
00196 class PathStrokerVector : public PathStroker
00197 {
00198     CC_DECLARE_MEMDUMP(PathStrokerVector);
00199 
00200 public:
00201     PathStrokerVector(ValueFunction *WidthFunction, INT32 LineWidth,
00202                         LineCapType CapType, DocRect *pSourceBounds);
00203 
00204 public:         // Public interface
00205     void PrepareToStroke(TrapEdgeList *pTraps);
00206             // Prepare for stroking. Must be called before StrokePath/MapCoord
00207 
00208     virtual BOOL StrokePath(TrapsList *pTraps, Path *pOutput);  // DO NOT USE this version!
00209     virtual BOOL StrokePath(Path *pSourceVector, Path *pOutput);
00210             // Go forth and stroke thine path
00211 
00212     DocCoord MapCoord(DocCoord *pCoord);
00213             // Maps a coordinate across from the source space to the output space
00214             // Called internally, and also from FillGeometryAttribute::MouldIntoStroke
00215 
00216     double GetScaleFactor(void);
00217             // Returns a scaling factor indicating how much larger/smaller the mapped
00218             // brush is than it was in the original brush definition. This is used
00219             // to scale line widths etc to keep aspect ratios approximately correct.
00220 
00221 protected:      // Internal helper functions
00222     void FindEdgeForCoord(DocCoord *pCoord, UINT32 StartIndex, INT32 Direction,
00223                             /* TO */ TrapEdge *pOutput);
00224             // Computes a TrapEdge structure for the exact Position of a source Coord
00225 
00226     void MapMove(DocCoord *pCoord);
00227     void MapLine(DocCoord *pCoord1, DocCoord *pCoord2);
00228     void MapBezier(DocCoord *pCoords);
00229             // Map a Move/Line/BezierTo into the output path
00230 
00231     void RecursiveMapLine(TrapEdge *pEdge1, DocCoord &Point1, double Width1,
00232                           TrapEdge *pEdge2, DocCoord &Point2, double Width2,
00233                           INT32 Direction, Path *pOutput);
00234             // Recursively maps points from a straight line onto the stroke
00235 
00236     void RecursiveMapBezier(DocCoord *pCoords,  DocCoord *p1, double t1,
00237                                                 DocCoord *p2, double t2);
00238             // Recursively maps points from a bezier onto the stroke
00239 
00241 public:
00242     static StrokeHandle GetCurrentBrush(void);
00243             // Returns the current brush. If there isn't one, it builds one
00244 
00245     static void BodgeRipSelection(BOOL Repeating = FALSE);
00246             // ****!!!! BODGE - will be moved elsewhere later. Rips the selection
00247             // out of the document and uses it as the new stroke brush
00248     static StrokeHandle CurrentStroke;
00250 
00251 
00252 private:        // Member globals to save passing loads of parameters
00253     Path        *pPath;                             // Current source path from the brush
00254     DocRect     *pBounds;                           // Bounds of the brush
00255     double      BoundsWidth;                        // Cached width of the bounds
00256     double      BoundsHalfHeight;                   // Cached half-height of the bounds
00257     double      BoundsYCentre;                      // Cached centre (Y) of the bounds
00258 
00259     Path        *pOutput;                           // Path to recieve mapped output data
00260 
00261     TrapEdgeList*pCurrentEdgeList;                  // Currently active trapezoid edge list
00262     UINT32 FirstEdge;                                   // First trapedge containing the current path
00263     UINT32 LastEdge;                                    // Last trapedge containing the current path
00264 };
00265 
00266 
00267 #endif
00268 

Generated on Sat Nov 10 03:46:29 2007 for Camelot by  doxygen 1.4.4