nodeshap.h

Go to the documentation of this file.
00001 // $Id: nodeshap.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 // NodeSimpleShape class. This provides a base class for all simple primitve shapes
00099 // eg, Rectangles and Ellipses.
00100 
00101 #ifndef INC_NODESHAP
00102 #define INC_NODESHAP
00103 
00104 //#include "ink.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00105 //#include "tranform.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00106 //#include "paths.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00107 //#include "doccoord.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00108 //#include "docrect.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00109 
00110 class RenderRegion;
00111 class Spread;
00112 class BecomeA;
00113 
00114 
00115 /***********************************************************************************************
00116 
00117 >   class NodeSimpleShape : public NodeRenderableInk
00118 
00119     Author:     Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
00120     Created:    22/9/93
00121     Purpose:    A NodeSimpleShape is the base class for several primitive shapes that are
00122                 bounded by a Parallelogram. This class contains 2 Pure Virtual functions that
00123                 need to be re-written in base classes. These should be the only functions that
00124                 need re-writting in most cases. They build a path for the shape given a
00125                 bounding parallelogram.
00126 
00127 ***********************************************************************************************/
00128 
00129 class NodeSimpleShape : public NodeRenderableInk
00130 {
00131 // Give my name out in memory dumps
00132 CC_DECLARE_DYNCREATE(NodeSimpleShape);
00133 
00134 public:
00135     NodeSimpleShape(); 
00136     
00137     NodeSimpleShape(Node* ContextNode,  
00138                 AttachNodeDirection Direction,  
00139                 BOOL Locked = FALSE, 
00140                 BOOL Mangled = FALSE,  
00141                 BOOL Marked = FALSE, 
00142                 BOOL Selected = FALSE    
00143               );
00144 
00145     // Initialise the path
00146     BOOL SetUpPath(INT32 RequiredSize=12, INT32 BlockSize=12);
00147     virtual Node* SimpleCopy();
00148     void CopyNodeContents(NodeSimpleShape* NodeCopy);
00149     virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);
00150 
00151     // Functions to re-build the path from the parallelogram
00152     virtual void CreateShape(DocRect NewRect);
00153     virtual void UpdateShape();
00154 
00155     // virtual Functions to deal with bounding boxes
00156     virtual DocRect GetBoundingRect(BOOL DontUseAttrs=FALSE, BOOL HitTest=FALSE);
00157     virtual DocRect GetBlobBoundingRect();
00158 
00159     // Rendering Functions
00160     virtual void Render( RenderRegion* pRender );
00161     virtual void RenderEorDrag( RenderRegion* );
00162 
00163     // Selection functions.
00164     virtual void RenderObjectBlobs(RenderRegion* pRender);
00165     virtual void RenderTinyBlobs(RenderRegion* pRender);
00166 
00167     // Functions to transform the shape
00168     virtual void Transform( TransformBase& );
00169 
00170     // Information functions
00171     virtual UINT32 GetNodeSize() const;             // Returns size of node in bytes
00172  
00173     // Make Shapes functions
00174     virtual BOOL CanBecomeA(BecomeA* pBecomeA);
00175     virtual BOOL DoBecomeA(BecomeA* pBecomeA);
00176 
00177     // Debugging function
00178     #ifdef _DEBUG
00179         void    ShowDebugTreeDetails() const;
00180     #endif
00181     void GetDebugDetails( StringBase* Str );
00182 
00183     // Functions to deal with messages
00184     virtual BOOL OnClick( DocCoord, ClickType, ClickModifiers, Spread* );
00185 
00186     // Function to decide if a coord is close to any of the control points
00187     BOOL IsNearControlHandle(DocCoord Coord, INT32* CoordNum);
00188  
00189     // Decides what to do about a drag on a blob
00190     virtual void HandleBlobDrag( DocCoord&, Spread*, INT32 );
00191 
00192     // The natty Snap functions
00193     virtual BOOL Snap(DocCoord* pDocCoord);
00194     virtual BOOL Snap(DocRect* pDocRect,const DocCoord& PrevCoord,const DocCoord& CurCoord);
00195     virtual BOOL SnapToCoords(DocCoord* pDocCoord);
00196 
00197     virtual double GetRotationAngle();
00198 
00199     // Karim MacDonald 25/11/1999
00200     // Extend functions.
00201     // Note that if a sub-class returns TRUE from IsTypeExtendible, it must
00202     // also provide complete implementations of ValidateExtend and Extend,
00203     // which should usually check/extend its children.
00204 public:
00205     virtual BOOL IsTypeExtendible() const { return TRUE; }
00206     virtual DocRect ValidateExtend(const ExtendParams& ExtParams);
00207     virtual void Extend(const ExtendParams& ExtParams);
00208 
00209     // Data vars
00210 public:
00211     Path     InkPath;           // The path that contains the shape
00212     DocCoord Parallel[4];       // 4 coords to represent the parallelogram that the shape fits in
00213 }; 
00214 
00215 
00216 
00217 
00218 #endif  // INC_NODESHAP
00219 
00220 
00221 
00222 

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