pbecomea.h

Go to the documentation of this file.
00001 // $Id: pbecomea.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 //
00099 // Declaration of PathBecomeA.
00100 //
00101 
00102 #ifndef INC_PBECOMEA
00103 #define INC_PBECOMEA
00104 
00105 //#include "becomea.h"  // derivation from BecomeA. - in camtypes.h [AUTOMATICALLY REMOVED]
00106 
00107 
00108 
00109 /********************************************************************************************
00110 
00111 >   class PathBecomeA : public BecomeA
00112 
00113     Author:     Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>
00114     Created:    10 February 2000
00115     Purpose:    Converts nodes to paths.
00116 
00117     Notes:      Karim 31/10/2000
00118                 Moved into its own source files from nodeclip.h/.cpp, as it really isn't
00119                 related to NodeClipView et al.
00120 
00121 ********************************************************************************************/
00122 class PathBecomeA : public BecomeA
00123 {
00124 // runtime class info.
00125 CC_DECLARE_MEMDUMP(PathBecomeA)
00126 
00127 public:
00128 
00129 enum OutlineRules
00130 {
00131     STRIP_OUTLINES,     //  remove areas covered by outline from the final path.
00132     ADD_OUTLINES,       //  add areas covered by outline to the final path.
00133     IGNORE_OUTLINES     //  don't worry about outlines at all.
00134 };
00135 
00136     // constructor/destructor.
00137     PathBecomeA(    BecomeAReason baReason, CCRuntimeClass* pClass,
00138                     UndoableOperation* pUndoOp, BOOL bSel, Path* pResultPath,
00139                     enum OutlineRules OutlineRule = IGNORE_OUTLINES );
00140     ~PathBecomeA();
00141 
00142     // the passback method to be called by Node::DoBecomeA when Reason == BECOMEA_PASSBACK.
00143     virtual BOOL PassBack(  NodeRenderableInk* pNewNode,
00144                             NodeRenderableInk* pCreatedByNode,
00145                             CCAttrMap* pAttrMap = NULL );
00146 
00147 protected:
00148     // the accumulated path of all passed-back objects.
00149     Path* m_pResultPath;
00150 
00151 private:
00152     Path* ExtractOutlineAsPath(NodePath* pSrcNodePath, CCAttrMap* pAttrMap);
00153 
00154     // whether to strip off, add on, or just not worry about object outlines.
00155     enum OutlineRules m_OutlineRule;
00156 
00157     // this rule is set in our constructor, depending on m_OutlineRules;
00158     // the value within tells ClipPathToPath what to do with our outlines - strip or add.
00159     UINT32 m_ClipPathRule;
00160 };
00161 
00162 
00163 
00164 //-------------------------------------------------------------------------------------------
00165 //-------------------------------------------------------------------------------------------
00166 //-------------------------------------------------------------------------------------------
00167 //-------------------------------------------------------------------------------------------
00168 
00169 
00170 
00171 /********************************************************************************************
00172 
00173 >   class ContourBecomeA2 : public PathBecomeA
00174 
00175     Author:     Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>
00176     Created:    21/11/2000
00177     Inputs:     
00178     Outputs:    
00179     Returns:    
00180     Purpose:    ContourBecomeA2 class provides a greener alternative to ContourBecomeA.
00181 
00182                 Reasons to use us:
00183                 It deals with all lines correctly, because it doesn't simulate line width by
00184                 contouring out from lines (like ContourBecomeA), but actually strokes them,
00185                 and contours outwards from the result.
00186 
00187                 Reasons not to use us:
00188                 1.  We don't currently deal with brush strokes correctly.
00189                 2.  We currently only do rounded contours - no bevelled or mitred contours.
00190 
00191                 Example usage:
00192                     Path ContourPath;
00193                     ContourPath.Initialise();
00194                     ContourBecomeA2 baContour(NULL, MillipointWidth, &ContourPath)
00195                     BOOL Success = pSourceNode->DoBecomeA(&baContour);
00196 
00197                     ( source node not included :o] )
00198 
00199 ********************************************************************************************/
00200 class ContourBecomeA2 : public PathBecomeA
00201 {
00202 CC_DECLARE_MEMDUMP(ContourBecomeA2);
00203 
00204 public:
00205     // constructor/destructor.
00206     ContourBecomeA2(    UndoableOperation* pUndoOp,
00207                         MILLIPOINT Width, Path* pResultPath );
00208 
00209     // the passback method to be called by Node::DoBecomeA when Reason == BECOMEA_PASSBACK.
00210     virtual BOOL PassBack(  NodeRenderableInk* pNewNode,
00211                             NodeRenderableInk* pCreatedByNode,
00212                             CCAttrMap* pAttrMap = NULL );
00213 
00214 protected:
00215     MILLIPOINT m_Width;
00216 };
00217 
00218 
00219 
00220 #endif  // INC_PBECOMEA

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