effects_stack.h

Go to the documentation of this file.
00001 // $Id: effects_stack.h 751 2006-03-31 15:43: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 Bitmap Effects handling classes.
00100 //
00101 
00102 #ifndef INC_EFFECTS_STACK
00103 #define INC_EFFECTS_STACK
00104 
00105 class Range;
00106 class ListRange;
00107 class NodeEffect;
00108 class EffectsStack;
00109 class NodeLiveEffect;
00110 class NodeFeatherEffect;
00111 class NodeBitmapEffect;
00112 
00113 // Define this if you want to pick up the development of the Feather Effect
00114 #define FEATHER_EFFECT
00115 
00116 /********************************************************************************************
00117 
00118 >   class PPStackLevel : public ListItem
00119 
00120     Author:     Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
00121     Created:    18/10/2004
00122     Purpose:    
00123     SeeAlso:    
00124 
00125 ********************************************************************************************/
00126 
00127 class PPStackLevel : public ListItem
00128 {
00129 public:
00130     CC_DECLARE_DYNAMIC( PPStackLevel )
00131     PPStackLevel() {pPPNode=NULL; strPostProID=""; bConsistent=TRUE;}
00132     ~PPStackLevel() {}                  // Nothing to destruct
00133 
00134 // Properties
00135     NodeEffect* pPPNode;        // pointer to sample LE node for this stack level
00136 //  _bstr_t             bstrEditDoc;    // sample edit document text for this stack level
00137     String_256          strPostProID;   // Display name of this LiveEffect level
00138     ListRange           listSelNodes;   // List of nodes in this stack level
00139     BOOL                bConsistent;    // TRUE if this level is consistent
00140                                         // (all nodes have similar params according to CompareState)
00141 };
00142 
00143 
00144 
00145 
00146 /********************************************************************************************
00147 
00148 >   class EffectsStack : public List
00149 
00150     Author:     Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
00151     Created:    18/10/2004
00152     Purpose:    Find and represent a consistent arrangement of LiveEffects above a
00153                 specified range (usually the SelRange)
00154                 This is complicated because the SelRange can have an arbitary collection of
00155                 LiveEffects applied to it which may or may not be wholly or partially
00156                 consisent.
00157                 This class currently holds info about LiveEffects that are applied to all
00158                 nodes in the SelRange, contiguously, in the same order.
00159 
00160 ********************************************************************************************/
00161 
00162 #define STACKPOS_BOTTOM 0
00163 #define STACKPOS_TOP 5000
00164 #define STACKPOS_INSERT_TOP 6000
00165 #define STACKPOS_INVALID -1
00166 
00167 class EffectsStack: public List
00168 {
00169     CC_DECLARE_DYNAMIC(EffectsStack)
00170 
00171 public:
00172     static ListRange*           GetEffectsStackFromNode(Node* pNode, BOOL bNodeMaybeMidStack = FALSE, BOOL bEscapeDerived = TRUE, BOOL bIncludeLocked = FALSE);
00173     static EffectsStack*        GetEffectsStackFromSelection(Range* pRange = NULL, BOOL bEscapeDerived = TRUE, BOOL bIncludeLocked = FALSE);
00174     static BOOL                 NodesSharePPStack(Node* pNode, Node* pLastNode, BOOL bNodeMaybeMidStack = FALSE, BOOL bIncludeLocked = FALSE);
00175     static Node*                FindStackBaseFrom(Node* pNode, BOOL bIncludeLocked);
00176     static Node*                EscapeOldControllers(Node* pUserNode);
00177     static ListRange*           GetNewLevelRange(Range* pRange = NULL, BOOL bEscapeOldControllers = TRUE);
00178     static ListRange*           GetTopClassRange(CCRuntimeClass* pClass,
00179                                                  BOOL bClassOnly = TRUE,
00180                                                  BOOL bIgnorePassThroughEffects = FALSE,
00181                                                  Node** ppMasterNode = NULL,
00182                                                  INT32* piStackPos = NULL,
00183                                                  Range* pRange = NULL,
00184                                                  BOOL bEscapeOldControllers = TRUE);
00185 
00186 public:
00187     EffectsStack();
00188     ~EffectsStack();
00189 
00190     BOOL                    FindBestProcessor(String_256* pstrEffectID, INT32* piStackPos);
00191     BOOL                    GetLevelInfo(String_256* pstrEffectID, INT32* piStackPos);
00192     BOOL                    LockableNonEmpty();
00193     void                    Clear();
00194     ListRange*              GetLevelRange(INT32* piStackPos, BOOL bEscapeOldControllers = TRUE);
00195     ListRange*              GetBaseLevelRange();
00196     PPStackLevel*           GetLevel(INT32 iStackPos) {return (PPStackLevel*)FindItem(iStackPos);}
00197     ListRange*              FindLevelContaining(NodeEffect* pNode, INT32* piStackPos);
00198     BOOL                    NodeInTopLevel(NodeEffect* pNode);
00199     INT32                       FindSelectionPos();
00200     BOOL                    BuildEffectMenu(ContextMenu* pMenu);
00201     void                    AttrsHaveChanged();
00202 
00203 protected:
00204     BOOL                    Initialise(ListRange* pRange);
00205     BOOL                    Intersect(ListRange* pRange);
00206     PPStackLevel*           FindMatch(PPStackLevel* pFirstItem, ListRange* pRange, NodeEffect* pPP);
00207 
00208 // Properties
00209 public:
00210     BOOL                    bConsistent;
00211 
00212 private:
00213     ListRange*              m_pNewLevelRange;           // This is a ListRange we made to cover the top of the selection
00214                                                         // but which is not yet in the stack
00215 };
00216 
00217 
00218 
00219 
00220 #endif  // INC_EFFECTS_STACK

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