blobs.h

Go to the documentation of this file.
00001 // $Id: blobs.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 // Provides a class for dealing with Camelots various Blob types
00099 
00100 #ifndef INC_BLOBS
00101 #define INC_BLOBS
00102 
00103 //#include "doccoord.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00104 //#include "pump.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00105 
00106 class NodeRenderable;
00107 class RenderRegion;
00108 class DocRect;
00109 class Spread;
00110 class Tool_v1;
00111 
00112 
00113 //static BOOL bToolBlobsAreOff;
00114 
00115 /********************************************************************************************
00116 
00117 >   class BlobStyle
00118 
00119     Author:     Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
00120     Created:    23/6/94
00121     Purpose:    Class for holding which blobs are required and which are not. Objects of
00122                 this class are passed into the Blob Manager to tell it which of the blobs
00123                 a tool wants to display and should be used something like this :-
00124                 MonoOn
00125                 BlobStyle ThisToolsBlobs;
00126                 ThisToolsBlobs.Object = TRUE;       // Display Object blobs in this tool
00127                 ThisToolsBlobs.Fill = TRUE;         // Display Fill blobs in this tool
00128                 BlobManager->ToolInterest(ThisToolsBlobs);
00129                 MonoOff
00130     SeeAlso:    BlobManager
00131 
00132 ********************************************************************************************/
00133 
00134 class BlobStyle
00135 {
00136 public:
00137     // Constructors
00138     BlobStyle();
00139     BlobStyle(  BOOL BObject, BOOL BArtistic = FALSE, BOOL BFill = FALSE,
00140                 BOOL BTiny = FALSE, BOOL BPen = FALSE, BOOL BToolObject = FALSE, BOOL BEffect = FALSE );
00141     ~BlobStyle() {}
00142 
00143 
00144 /********************************************************************************************
00145 
00146 >   BlobStyle::SetAll()
00147 
00148     Author:     Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
00149     Created:    23/6/94
00150     Purpose:    Sets all the blobs type flags to TRUE
00151 
00152 ********************************************************************************************/
00153     void SetAll()  { Object = Artistic = Fill = Tiny = Pen = ToolObject = Effect = TRUE; }
00154 
00155 
00156 /********************************************************************************************
00157 
00158 >   void BlobStyle::SetNone()
00159 
00160     Author:     Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
00161     Created:    23/6/94
00162     Purpose:    Sets all the blobs styles to false
00163 
00164 ********************************************************************************************/
00165     void SetNone() { Object = Artistic = Fill = Tiny = Pen = ToolObject = Effect = FALSE; }
00166 
00167     // Vars
00168     UINT32 Fill     : 1;
00169     UINT32 Object   : 1;
00170     UINT32 Artistic : 1;
00171     UINT32 Tiny     : 1;
00172     UINT32 Pen      : 1;
00173     UINT32 ToolObject: 1;
00174     UINT32 Effect   : 1;
00175 };
00176 
00177 
00178 
00179 /********************************************************************************************
00180 
00181 >   class BlobManager : public MessageHandler
00182 
00183     Author:     Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
00184     Created:    15/6/94
00185     Purpose:    Class to Manage the various types of selection blobs in Camelot. Currently
00186                 Camelot knows about the following forms of selection blob :-
00187 
00188                 Fill Blobs - The blobs rendered by things like Graduated fills to show
00189                 where the fill starts and ends, it direction etc.
00190 
00191                 Object Blobs - The blobs that appear to edit the shape of an object. ie
00192                 the control point blobs on a path
00193 
00194                 Artistic Blobs - Used to edit information such as pressure details along
00195                 shapes.
00196 
00197                 Tiny Blobs - the Blob that is displayed by an object when it is the
00198                 Boundary selection mode of the selector tool to indicate that it is one
00199                 of the selected objects.
00200 
00201                 ToolObject Blobs -  These blobs are displayed and used by an object only
00202                                     when a specific tool is selected. They are similar to
00203                                     object blobs except that the _object_ has the final say
00204                                     in whether they are rendered/used or not.
00205 
00206 ********************************************************************************************/
00207 
00208 class BlobManager : public MessageHandler
00209 {
00210     // Give my name in memory dumps
00211     CC_DECLARE_MEMDUMP(BlobManager);
00212 
00213 public:
00214     // Constructors etc
00215     BlobManager();
00216     ~BlobManager() {}
00217 
00218     // Functions to allow the tools to register their interest in various groups of blobs
00219     void ToolInterest(BlobStyle);
00220     void AddInterest(BlobStyle);
00221     void RemoveInterest(BlobStyle);
00222 
00223     // Find out what the current blob interest is
00224     BlobStyle GetCurrentInterest(BOOL bIgnoreOffState = FALSE);
00225 
00226     // Functions to stop and start the rendering of blobs during periods of uncertainy
00227     void BlobRenderingOff(BOOL Redraw);
00228     void BlobRenderingOn(BOOL Redraw);
00229 
00230     // Functions to find out about the size of a blob (not a cow)
00231     INT32 GetBlobSize();
00232     void GetBlobRect( const DocCoord &Centre, DocRect* Rect, BOOL MFill = FALSE,
00233                                 BlobType eBlobType = BT_SELECTEDLARGEST);
00234 
00235     // Functions to render blobs
00236     void Render(DocRect* Rect, Spread *pSpread);
00237     void RenderOn(DocRect* Rect, Spread *pSpread);
00238     void RenderOff(DocRect* Rect, Spread *pSpread);
00239 
00240     void RenderMyBlobs(DocRect* Rect, Spread *pSpread, NodeRenderable* pNode);
00241     void RenderMyBlobsOn(DocRect* Rect, Spread *pSpread, NodeRenderable* pNode);
00242     void RenderMyBlobsOff(DocRect* Rect, Spread *pSpread, NodeRenderable* pNode);
00243 
00244     void RenderObjectBlobs(DocRect* Rect, Spread *pSpread, NodeRenderable* pNode);
00245     void RenderObjectBlobsOn(DocRect* Rect, Spread *pSpread, NodeRenderable* pNode);
00246     void RenderObjectBlobsOff(DocRect* Rect, Spread *pSpread, NodeRenderable* pNode);
00247 
00248     void RenderToolBlobsOn(Tool_v1* pTool, Spread* pSpread, DocRect* pClipRect);
00249     void RenderToolBlobsOff(Tool_v1* pTool, Spread* pSpread, DocRect* pClipRect);
00250 
00251     BOOL IsRemovingBlobs() { return RemovingBlobs; }
00252 
00253 protected:
00254     // Functions to help the blob manager with the rendering of the blobs
00255     void RenderRequiredBlobs(NodeRenderable*, RenderRegion*);
00256     void RenderSpecificBlobs(NodeRenderable*, RenderRegion*, BOOL, BOOL, BOOL, BOOL, BOOL, BOOL, BOOL);
00257 
00258     void RenderRequiredBlobsOnSelection(DocRect* Rect);
00259     void RenderSpecificBlobsOnSelection(DocRect* Rect, BOOL, BOOL, BOOL, BOOL, BOOL, BOOL, BOOL);
00260 
00261     BOOL NeedToRenderSelectionBlobs(DocRect* Rect);
00262     BOOL NeedToRenderNodeBlobs(DocRect* Rect, Spread *pSpread, NodeRenderable* pNode);
00263 
00264 protected:
00265     // message handler
00266     MsgResult Message(Msg* Msg);
00267 
00268 // vars
00269 protected:
00270     // Which blobs are we displaying?
00271     BOOL IsFillBlob;
00272     BOOL IsObjectBlob;
00273     BOOL IsArtisticBlob;
00274     BOOL IsTinyBlob;
00275     BOOL IsPenBlob;
00276     BOOL IsToolObjectBlob;
00277     BOOL IsEffectBlob;
00278 
00279     // should we be drawing blobs at all
00280     BOOL DrawBlobsAtAll;
00281 
00282     // Flag to tell whether blobs are being removed or not
00283     BOOL RemovingBlobs;
00284     BOOL bToolBlobsAreOff;
00285 };
00286 
00287 #endif  // INC_BLOBS
00288 
00289 

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