nodeclip.h

Go to the documentation of this file.
00001 // $Id: nodeclip.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 NodeClipView.
00100 //
00101 
00102 #ifndef INC_NODECLIP
00103 #define INC_NODECLIP
00104 
00105 //#include "node.h"         // derivation from NodeRenderableInk. - in camtypes.h [AUTOMATICALLY REMOVED]
00106 #include "clipattr.h"       // for our ClipRegionAttribute member.
00107 
00108 /********************************************************************************************
00109 
00110 >   class NodeClipView : public NodeRenderableInk
00111 
00112     Author:     Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>
00113     Created:    10 February 2000
00114     Purpose:    ClipView node.
00115                 This node works in tandem with NodeClipViewController to provide clipview 
00116                 functionality. It sits underneath a NodeClipViewController, between the 
00117                 keyhole node and the clipped nodes, so that it is rendered after the keyhole 
00118                 node. Its Render() method saves GDraw's current clipping region and applies a 
00119                 new region, derived from the keyhole node's outline.
00120     See also:   
00121 
00122 ********************************************************************************************/
00123 class NodeClipView : public NodeRenderableInk
00124 {
00125 // Give my name out in memory dumps.
00126 CC_DECLARE_DYNCREATE(NodeClipView);
00127 
00128 // we don't mind NodeClipViewController accessing our protected methods.
00129 friend class NodeClipViewController;
00130 //friend class ClipRegionAttribute;
00131 
00132 public:
00133     // construction/destruction and initialisation.
00134     NodeClipView();
00135     NodeClipView(   Node* pContextNode,  
00136                     AttachNodeDirection Direction,
00137                     BOOL Locked     = FALSE,
00138                     BOOL Mangled    = FALSE,
00139                     BOOL Marked     = FALSE,
00140                     BOOL Selected   = FALSE );
00141     ~NodeClipView();
00142 
00143     // virtual ID function.
00144     virtual BOOL IsANodeClipView() const { return TRUE; }
00145 
00146     // bounding information.
00147     virtual DocRect GetBoundingRect(BOOL DontUseAttrs = FALSE, BOOL HitTest = FALSE);
00148     virtual DocRect GetBlobBoundingRect();
00149 
00150     // render this node.
00151     virtual SubtreeRenderState RenderSubtree(RenderRegion* pRender, Node** ppNextNode = NULL, BOOL bClip = TRUE);
00152     virtual void Render(RenderRegion* pRender);
00153     void RenderClipAttr(RenderRegion* pRender);
00154     virtual void RenderEorDrag( RenderRegion* pRender );
00155 
00156     // we don't want to ever have any children, so we reject all attributes out of hand.
00157     virtual BOOL RequiresAttrib(CCRuntimeClass * , BOOL )       { return FALSE; }
00158     virtual BOOL RequiresAttrib(NodeAttribute * , BOOL )        { return FALSE; }
00159     virtual BOOL CanAttrBeAppliedToMe(CCRuntimeClass* AttrType) { return FALSE; }
00160 
00161     // return a description, for use in menus, infobar etc.
00162     virtual String Describe(BOOL Plural, BOOL Verbose);
00163 
00164     // get the size of this node.
00165     virtual UINT32 GetNodeSize() const;
00166 
00167     // transform this node.
00168     void Transform(TransformBase &Trans);
00169 
00170     // Version 2 file format functions
00171     virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
00172     virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);
00173 
00174     // called on nodes after a document is imported.
00175     virtual BOOL PostImport();
00176 
00177     virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);
00178 
00179 protected:
00181     //
00182     // ClipView-specific methods.
00183     //
00184 
00185     // set GDraw'c clipping region to, and restore it back over, the path of our keyhole node.
00186     void SetGDrawClippingRegion(RenderRegion* pRender);
00187     BOOL RestoreGDrawClippingRegion(BOOL fFirstInRenderLoop = FALSE);
00188 
00189     // this allows our NCVC to give us a path to clip to.
00190     void SetClipPath(Path* pClipPath) { m_ClipRegionAttribute.SetClipPath(pClipPath); }
00191 
00192     // copy methods. (Q: is there a reason why CopyNodeContents() is not virtual?)
00193     // Phil 19/12/2003 A: Yes. Because it takes a typed input parameter
00194     //                      However, I have just added PolyCopyNodeContents which takes a NodeRenderable*
00195     virtual Node* SimpleCopy();
00196     void CopyNodeContents(NodeClipView* pNodeCopy);
00197 
00199 //
00200 // Member variables
00201 //
00202 
00203 private:
00204     BOOL                m_bRenderingForward;
00205     BYTE *              m_pRegion;
00206     GCONTEXT *          m_pContext;
00207     CONST REGION *      m_pSavedRegion;
00208     BOOL                m_bGDrawClipRegionSet;
00209     RECT                m_SavedClipRect;
00210 
00211 private:
00212     ClipRegionAttribute     m_ClipRegionAttribute;
00213 
00214 };
00215 
00216 
00217 
00218 #endif  // INC_NODECLIP

Generated on Sat Nov 10 03:45:59 2007 for Camelot by  doxygen 1.4.4