brushref.h

Go to the documentation of this file.
00001 // $Id: brushref.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 // The brushref class
00100 
00101 #ifndef BRUSHREF
00102 #define BRUSHREF
00103 
00104 #include "nodebldr.h"
00105 
00106 //#include "ink.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00107 
00108 class BitmapFillAttribute;
00109 
00110 /***********************************************************************************************
00111 
00112 >   class BlendPathOffset
00113 
00114     Author:     Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com>
00115     Created:    18/10/99
00116     Purpose:    Stores the translation of the blendpath to the centre of its parent object.
00117 ***********************************************************************************************/
00118 
00119 class BlendPathOffset
00120 {
00121 public:
00122     BlendPathOffset() {m_XOffset = 0; m_YOffset = 0; m_Angle = 0; m_Magnitude = 0;}
00123     BlendPathOffset(MILLIPOINT X, MILLIPOINT Y) {m_XOffset = X; m_YOffset = Y; 
00124                                                 CalculateAngleAndMagnitude();}
00125 
00126     void CalculateAngleAndMagnitude();
00127 
00128     // get the polar version
00129     void GetAngleAndMagnitude(double* pAngle, MILLIPOINT* pMagnitude);
00130     
00131     // work out what the offsets would be if it were rotated
00132     void RotateByAngle(double Angle, MILLIPOINT* pXoffset, MILLIPOINT* pYOffset);
00133 
00134 public:  //data
00135     MILLIPOINT m_XOffset;
00136     MILLIPOINT m_YOffset;
00137 
00138 protected: 
00139     // the polar representation
00140     double m_Angle;
00141     MILLIPOINT m_Magnitude;
00142 };
00143 
00144 /***********************************************************************************************
00145 
00146 >   class BrushRef : public BlendRef
00147 
00148     Author:     Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com>
00149     Created:    7/12/99
00150     Purpose:    'wrapper' for the blendref class for use with the brush.  Contains the information
00151                 that the nodebrushmaker needs to draw the brush objects
00152 
00153 ***********************************************************************************************/
00154 
00155 class BrushRef : public BlendRef
00156 {
00157     CC_DECLARE_MEMDUMP(BrushRef);
00158 
00159 public:
00160     typedef std::list<BlendPathOffset>  list;
00161     typedef list::iterator              iterator;
00162 
00163 public:
00164     BrushRef();
00165     ~BrushRef();
00166 
00167     BOOL Initialise(NodeRenderableInk* pInitNode);
00168     BlendPathOffset* GetFirstOffset( iterator *pHeadPosition );
00169     BlendPathOffset* GetNextOffset( iterator *pPosition );
00170     iterator GetEndPosition() { return m_OffsetList.end(); }
00171     
00172     DocRect GetBoundingRect();
00173     void DeleteBitmapFills();  // deletes bitmap fills, use only when camelot is closing
00174     void DeleteAttributesAndPath(); 
00175     void FreeAttributes();
00176     void TranslateTo(DocCoord Target);
00177 
00178     void TransformAttributes(TransformBase& Trans);
00179 
00180     // get the blendpaths to copy their data for rendering
00181     BOOL MakeCopiesForRendering();
00182     BOOL UpdateCopies();
00183     void DeleteRenderCopies();
00184 
00185     // returns the first and subsequent copies of the blendpaths
00186     Path* GetFirstCopyPath();
00187     Path* GetNextCopyPath();
00188 
00189     // returns the attribute map pertaining to the current blendpath
00190     CCAttrMap* GetCurrentAttributeCopy();
00191 
00192 protected: //helper functions   
00193     BOOL SetBitmapFillFlags(); // tells any bitmap fills not to delete themselves normally as we will do it
00194     
00195 protected:
00196     NodeRenderableInk*  m_pNode;
00197     List                m_BlendPathList;
00198     UINT32              m_NumBlendPaths;
00199     CMapPtrToPtr*       m_pBlendPathAttrMap;
00200     DocRect             m_CachedRect;
00201     // the list of transformations from the centre of the blendpath to the centre of 
00202     // the inknode.  Only really used when making brushes from groups.
00203     list                m_OffsetList;
00204 
00205     // our current blendpath for rendering
00206     BlendPath*          m_pCurrentBlendPath;
00207 };
00208 
00209 
00210 /***********************************************************************************************
00211 
00212 >   class BrushRefBlender : public CC_CLASS_MEMDUMP
00213 
00214     Author:     Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com>
00215     Created:    7/12/99
00216     Purpose:    An instance of this class is designed to take two BrushRef objects and blend together
00217                 their paths and attributes, churning out a BlendedBrushRef object at the end.
00218                 It essentially rips off a lot of what the NodeBlender does, except that instead of
00219                 rendering anything or existing in the tree it just produces a blended object.
00220 
00221 ***********************************************************************************************/
00222 
00223 class BrushRefBlender : public CC_CLASS_MEMDUMP
00224 {
00225     CC_DECLARE_MEMDUMP(BrushRefBlender);
00226 public:
00227     BrushRefBlender();
00228     ~BrushRefBlender();
00229 
00230     void SetBrushRef(BrushRef* pBrushRef, BOOL First);
00231     BrushRef* Blend(BrushRef* pStartBrushRef, BrushRef* pOther, double Ratio);
00232 
00233 protected: //helper functions
00234 
00235     BOOL BlendPaths(BlendPath* pBlendPathStart,BlendPath* pBlendPathEnd,double BlendRatio);
00236     BOOL BlendAttributes(BlendPath* pBlendPathStart, BlendPath* pBlendPathEnd,
00237                         CCAttrMap* pBlendedAttribMap,double BlendRatio);
00238 
00239     BOOL        ReallocTempBuffers(UINT32 Size);
00240     void        DeallocTempBuffers();
00241 
00242     // Access funcs for the path arrays
00243     DocCoord*   GetCoordArray(UINT32 MinSize);
00244     PathVerb*   GetVerbArray(UINT32 MinSize);
00245     PathFlags*  GetFlagArray(UINT32 MinSize);
00246     UINT32*         GetGBlendBuff(UINT32 MinSize);
00247 
00248 
00249 protected: //data
00250         // the two brushrefs to be blended
00251     BrushRef* m_pStartBrushRef;  
00252     BrushRef* m_pEndBrushRef;
00253 
00254     // The following set of vars deal with arrays that are set up by the PreBlend() routine
00255     // Also, these arrays can also change by calls to the access funcs GetCoordArray(), GetVerbArray() and GetFlagArray()
00256     UINT32      m_TempArraySize;
00257     DocCoord*   m_pTempCoords;
00258     PathVerb*   m_pTempVerbs;
00259     PathFlags*  m_pTempFlags;
00260     UINT32      m_GBlendBuffSize;
00261     UINT32*     m_pGBlendBuff;
00262     UINT32      m_ArrayLength;
00263     
00264 };  
00265 #endif

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