clipattr.h

Go to the documentation of this file.
00001 // $Id: clipattr.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 ClipRegionAttribute.
00100 //
00101 
00102 #ifndef INC_CLIPATTR
00103 #define INC_CLIPATTR
00104 
00105 //#include "attrval.h"  // derivation from AttributeValue. - in camtypes.h [AUTOMATICALLY REMOVED]
00106 //#include "paths.h"        // for Path member variable. - in camtypes.h [AUTOMATICALLY REMOVED]
00107 //#include "clipres.h"
00108 
00109 /********************************************************************************************
00110 
00111 >   class ClipRegionAttribute : public AttributeValue
00112 
00113     Author:     Karim_MacDonald (Xara Group Ltd) <camelotdev@xara.com>
00114     Created:    20 March 2000
00115     Purpose:    
00116 
00117     See also:   
00118 
00119 ********************************************************************************************/
00120 class ClipRegionAttribute : public AttributeValue
00121 {
00122 // Runtime class information.
00123 CC_DECLARE_DYNCREATE(ClipRegionAttribute)
00124 
00125 public:
00126     // construction/destruction
00127     ClipRegionAttribute();
00128     ~ClipRegionAttribute();
00129 
00130     // methods required for AttributeValue implementation
00131     virtual void Render(RenderRegion* pRender, BOOL Temp = FALSE);
00132     virtual void Restore(RenderRegion* pRender, BOOL Temp);
00133     virtual void GoingOutOfScope(RenderRegion* pRender);
00134     virtual void SimpleCopy(AttributeValue* pSource);
00135     virtual NodeAttribute* MakeNode();
00136     virtual BOOL IsDifferent(AttributeValue* pOther);
00137 
00138     // static initialisation function, to register this attribute with Camelot.
00139     static BOOL Init();
00140 
00141     // member access functions.
00142     Path*   GetClipPath() const { return m_pClipPath; }
00143     void    SetClipPath(Path* pClipPath) { m_pClipPath = pClipPath; }
00144 
00145 //  not really sure what this is for...
00146 //  virtual INT32 operator=(AttributeValue& Attrib) { return TRUE; }
00147 
00148     void    SetResponsibleForGrouping  (BOOL starts) { m_bResponsibleForGrouping = starts; }
00149     BOOL    IsResponsibleForGrouping () { return m_bResponsibleForGrouping; }
00150 
00151 // member variables.
00152 private:
00153     // the path which this attribute should cause output to be clipped to.
00154     Path*   m_pClipPath;
00155     BOOL    m_bResponsibleForGrouping;
00156 };
00157 
00158 class AttrClipView : public NodeAttribute
00159 {
00160 CC_DECLARE_DYNAMIC(AttrClipView)
00161 
00162 public:
00163     AttrClipView();
00164     ~AttrClipView();
00165     AttrClipView(Node* ContextNode,  
00166                  AttachNodeDirection Direction,    
00167                  BOOL Locked=FALSE, 
00168                  BOOL Mangled=FALSE,  
00169                  BOOL Marked=FALSE, 
00170                  BOOL Selected=FALSE);
00171 
00172     // Traditional Node functionality
00173     virtual void Render( RenderRegion* pRender );
00174 
00175 #ifdef _DEBUG
00176     void GetDebugDetails(StringBase* Str);
00177 #endif
00178 
00179     // Traditional NodeAttribute functionality
00180     virtual AttributeValue* GetAttributeValue() { return &Value; }
00181     Node* SimpleCopy();
00182     virtual UINT32 GetAttrNameID() { return _R(IDS_CLIPVIEW_ATTR_ID); }
00183     virtual AttrIndex GetAttributeIndex () { return ATTR_CLIPVIEW; }
00184     virtual UINT32 GetNodeSize() { return sizeof(AttrClipView); }
00185     virtual INT32 operator==(const NodeAttribute& NodeAttrib);
00186 
00187     // Node charateristics tests
00188     virtual BOOL NeedsTransparency() const { return FALSE; }
00189 
00190     // prevent feathering in incompatible circumstances
00191     virtual SubtreeRenderState RenderSubtree(RenderRegion *pRender, Node** ppNextNode = NULL, BOOL bClip = TRUE) {return SUBTREE_ROOTONLY; }
00192     virtual BOOL IsAClipViewAttr() const { return TRUE; }
00193 
00194     // support layering and remove redundant attrs
00195     virtual BOOL CanBeMultiplyApplied() { return TRUE; }
00196     virtual BOOL ShouldBeOptimized() { return FALSE; }
00197 
00198     // dynamic attribute functions and flags
00199     virtual void Transform(TransformBase& Trans);
00200     virtual BOOL Blend(BlendAttrParam* pBlendParam);
00201     virtual BOOL ContainsAttributeValue(AttributeValue* pVal);
00202 
00203     // Version 2 file format functions
00204     virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
00205     virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);
00206 
00207     // New Function local to this attribute only!
00208     // It`s mainly used for turning the attribute off when exporting AI EPS
00209     void EnableRendering(BOOL DoEnableRendering = TRUE) { m_DoRender = DoEnableRendering; }
00210     
00211     // Small function which lets the caller find out if the attribute is disabled or not.
00212     BOOL GetRenderStatus() { return m_DoRender; }
00213 
00214     virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);
00215 
00216 private:
00217     void CopyNodeContents(NodeAttribute *pCopy);
00218     BOOL m_DoRender;
00219 
00220 public:
00221     ClipRegionAttribute Value;
00222 };
00223 
00224 
00225 //-------------------------------------------------------------------------------------------
00226 //-------------------------------------------------------------------------------------------
00227 //-------------------------------------------------------------------------------------------
00228 //-------------------------------------------------------------------------------------------
00229 
00230 
00231 
00232 #endif  // INC_CLIPATTR

Generated on Sat Nov 10 03:44:42 2007 for Camelot by  doxygen 1.4.4