nodepath.h

Go to the documentation of this file.
00001 // $Id: nodepath.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 // The Node Renderable Path Class
00099 
00100 #ifndef INC_NODEPATH
00101 #define INC_NODEPATH
00102 
00103 
00104 //#include "paths.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00105 //#include "ink.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00106 //#include "rndrgn.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00107 
00108 #define OPTOKEN_NODEPATH    _T("PathObject")
00109 
00110 class BecomeA;
00111 class CamelotFileRecord;
00112 class RenderRegion;
00113 class Matrix;
00114 class CCAttrMap;
00115 class BlendPath;
00116 
00117 /***********************************************************************************************
00118 
00119 >   class NodePath : public NodeRenderableInk
00120 
00121     Author:     Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
00122     Created:    26/5/93
00123     Purpose:    Puts path objects into the tree
00124     SeeAlso:    Path
00125 
00126 ***********************************************************************************************/
00127 
00128 class NodePath : public NodeRenderableInk
00129 {
00130 // Give my name out in memory dumps
00131 CC_DECLARE_DYNCREATE( NodePath )
00132 
00133 public:
00134     Path    InkPath;                                    // Public path
00135     
00136 public:
00137     NodePath(); 
00138     NodePath(Node* ContextNode,  
00139                     AttachNodeDirection Direction,  
00140                     BOOL Locked = FALSE, 
00141                     BOOL Mangled = FALSE,  
00142                     BOOL Marked = FALSE, 
00143                     BOOL Selected = FALSE    
00144               );      
00145                   
00146     BOOL SetUpPath(INT32 RequiredSize = 12, INT32 BlockSize = 12); 
00147     virtual Node* SimpleCopy();                     // Copies a node
00148 
00149     // virtual Functions to deal with bounding boxes
00150     virtual DocRect GetBoundingRect(BOOL DontUseAttrs=FALSE, BOOL HitTest=FALSE);
00151     virtual DocRect GetBlobBoundingRect();
00152 
00153     // Rendering Functions
00154     virtual void Render( RenderRegion* pRender );
00155     virtual void RenderEorDrag( RenderRegion* );
00156 
00157     // Selection functions.
00158     virtual void RenderObjectBlobs(RenderRegion* pRender);
00159     virtual void RenderTinyBlobs(RenderRegion* pRender);
00160     virtual void RenderPenBlobs(RenderRegion* pRender);
00161 
00162     // Version 2 file format functions
00163     virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
00164     virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);
00165     virtual BOOL WriteBeginChildRecordsNative(BaseCamelotFilter* pFilter);
00166     virtual BOOL WriteEndChildRecordsNative(BaseCamelotFilter* pFilter);
00167 
00168     virtual UINT32 ChooseTagValue();
00169     virtual BOOL  WritePathRecord(BaseCamelotFilter* pFilter);
00170     virtual BOOL  WritePathRefRecord(BaseCamelotFilter* pFilter,UINT32 SrcPathRecNum,Matrix* pTransform);
00171     virtual INT32  CalcPathRecordSize();
00172     virtual BOOL  WritePathToRecord(CamelotFileRecord* pRecord);
00173 
00174     // 'Make shapes' functions
00175     virtual BOOL CanBecomeA(BecomeA* pBecomeA); 
00176     virtual BOOL DoBecomeA(BecomeA* pBecomeA); 
00177 
00178     void ClearSubSelection(Spread* pSpread);
00179 
00180     // Responce to clicks from tools
00181     virtual BOOL OnClick( DocCoord, ClickType, ClickModifiers, Spread * );
00182     virtual BOOL OnBlobPopUp(Spread*, DocCoord, ContextMenu*);
00183     virtual BOOL OnNodePopUp(Spread*, DocCoord, ContextMenu*);
00184 
00185     // Other virtual functions
00186     virtual void Transform( TransformBase& );               // Transforms this object
00187     
00188     virtual String Describe(BOOL Plural, BOOL Verbose); 
00189 
00190     #ifdef _DEBUG
00191         void    ShowDebugTreeDetails() const;       // Debugging function
00192     #endif
00193     void GetDebugDetails( StringBase* Str );
00194     
00195     virtual UINT32 GetNodeSize() const;             // Returns size of node in bytes
00196     virtual BOOL IsNodePath() const;
00197     virtual BOOL IsPathAllowable();
00198 
00199     // The natty Snap functions
00200     virtual BOOL Snap(DocCoord* pDocCoord);
00201     virtual BOOL Snap(DocRect* pDocRect,const DocCoord& PrevCoord,const DocCoord& CurCoord);
00202     virtual BOOL SnapToCoords(DocCoord* pDocCoord);
00203 
00204     virtual double GetRotationAngle();
00205     virtual void DeSelect(BOOL ReDraw, BOOL bDeselectChildren = FALSE);
00206     virtual BOOL NeedsToExport(RenderRegion* pRender, BOOL VisibleLayersOnly = FALSE,
00207                                BOOL CheckSelected = FALSE);
00208     virtual BOOL AllowOp(ObjChangeParam* pParam, BOOL SetOpPermissionState = TRUE,
00209                                                  BOOL DoPreTriggerEdit = TRUE);
00210                                                 
00211     virtual BOOL IsANodeBlendPath();
00212 
00213     virtual ChangeCode  OnChildChange(ObjChangeParam* pParam);
00214 
00215     // Converts this path & all its attributes to a closed path and returns it.
00216     NodePath * MakeNodePathFromAttributes(  double Flatness = 750.0,
00217                                             CCAttrMap* pAttrMap = NULL,
00218                                             BOOL bIncludeClosedPaths = FALSE,
00219                                             BOOL IncludeWidth = TRUE);
00220     
00221     virtual NodePath* GetVariableWidthStrokePath();
00222     virtual NodePath* GetSmoothVariableWidthStrokePath();
00223 
00224     virtual INT32 EstimateNodeComplexity (OpParam* details);
00225 
00226     BOOL RetroSmoothMe(double Smoothness);
00227 
00228     virtual BOOL GetAreaDetails(XLONG* pxlArea, XLONG* pXLPerimeter);
00229 
00230 public:
00231     virtual BOOL IsDifferent(Node *pOther);
00232         // Determine if 2 nodes are considered to be equal.
00233         // NOTE: This may not be implemented fully for all derived classes, so for certain
00234         // types of node, the comparison will only be to see if they are of the same class!
00235         // (This was originally added for the StrokeComponent to be able to compare 2
00236         // subtrees to see if they are equal - a simple base-class implementation plus
00237         // overrides in NodeRenderable & NopdePath suffices to distinguish most Stroke clipart)
00238 
00239     // Karim MacDonald 25/11/1999
00240     // Extend functions.
00241     // Note that if a sub-class returns TRUE from IsTypeExtendible, it must
00242     // also provide complete implementations of ValidateExtend and Extend,
00243     // which should usually check/extend its children.
00244 public:
00245     virtual BOOL IsTypeExtendible() const { return TRUE; }
00246     virtual DocRect ValidateExtend(const ExtendParams& ExtParams);
00247     virtual void Extend(const ExtendParams& ExtParams);
00248 
00249     // virtual override of NodeRenderable::TransformTranslateObject.
00250     void TransformTranslateObject(const ExtendParams& ExtParams);
00251 
00252     // virtual override of NodeRenderableBounded::GetExtendTargetBounds().
00253     virtual DocRect GetExtendTargetBounds(const ExtendParams& ExtParams);
00254 
00255 public:
00256     static BOOL CreateFromPath(NodePath** ppNewPath,    Path* pSrcPath = NULL,
00257                                                     Operation* pOp = NULL);
00258     Path* GetPathCopy();
00259 
00260     virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);
00261     
00262 protected:
00263     void CopyNodeContents( NodePath* NodeCopy );        // Copies the contents of the path
00264 
00265 private:
00266     void HandleBlobClick(DocCoord*, PathFlags*, INT32, INT32, BOOL, BOOL);
00267 
00268 protected:
00269     double CurrentRotation;
00270 
00271 protected:
00272 };
00273 
00274 #endif  // INC_NODEPATH
00275 
00276 

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