pathtype.h

Go to the documentation of this file.
00001 // $Id: pathtype.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 #ifndef INC_PATHTYPE
00100 #define INC_PATHTYPE
00101 
00102 
00103 // This file describes the PathFlags and PathVerb types used by the path system
00104 // This enables me to reduce the number of dependencies we have.
00105 
00106 typedef BYTE PathVerb;
00107 
00108 /********************************************************************************************
00109 
00110 <   struct
00111 <   PathFlags
00112 
00113     Author:     Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>
00114     Created:    18/4/94
00115     Comment:    The various flags associated with each control point on the path. They
00116                 are as follows :-
00117                 IsSelected - TRUE if the control point is selected
00118                 IsSmooth - TRUE if the control point should be smoothed when the path is
00119                 edited
00120                 IsRotate - TRUE if this bezier control point should be kept colinear with
00121                 its partner
00122                 NeedToRender - TRUE if we need to render this control point during an edit
00123                 IsEndPoint - TRUE if this control point is an EndPoint
00124                 Spare1-3 - No specific use as yet but can be used for any localised task
00125                 you perform on a path
00126 
00127 ********************************************************************************************/
00128 
00129 struct PathFlags
00130 {
00131     PathFlags();
00132 
00133     // Is this element of the path selected
00134     BYTE IsSelected : 1;
00135 
00136     // Flags to aid with the smoothing of curves
00137     BYTE IsSmooth : 1;
00138     BYTE IsRotate : 1;
00139 
00140     // Flags that help with the EORed rendering as the path is edited
00141     BYTE NeedToRender : 1;
00142 
00143     // All Endpoints in the path have this flag set
00144     BYTE IsEndPoint : 1;
00145 
00146     // May as well use up the spare bits in this byte for the future
00147     BYTE Spare1 : 1;
00148     BYTE Spare2 : 1;
00149     BYTE Spare3 : 1;
00150     inline INT32 operator ==(const PathFlags&);
00151     inline INT32 operator !=(const PathFlags&);
00152 };
00153 
00154 INT32 PathFlags::operator==(const PathFlags& rhs)
00155 {
00156     if ((IsSelected == rhs.IsSelected) && 
00157         (IsSmooth == rhs.IsSmooth) &&
00158         (IsRotate == rhs.IsRotate) &&
00159         (NeedToRender == rhs.NeedToRender) &&
00160         (IsEndPoint == rhs.IsEndPoint) &&
00161         (Spare1 == rhs.Spare1) &&
00162         (Spare2 == rhs.Spare2) &&
00163         (Spare3 == rhs.Spare2)
00164        )
00165             return 1;
00166     else
00167             return 0;
00168 
00169 }
00170 
00171 INT32 PathFlags::operator!=(const PathFlags& rhs)
00172 {
00173     if ((IsSelected != rhs.IsSelected) || 
00174         (IsSmooth != rhs.IsSmooth) ||
00175         (IsRotate != rhs.IsRotate) ||
00176         (NeedToRender != rhs.NeedToRender) ||
00177         (IsEndPoint != rhs.IsEndPoint) ||
00178         (Spare1 != rhs.Spare1) ||
00179         (Spare2 != rhs.Spare2) ||
00180         (Spare3 != rhs.Spare2)
00181        )
00182             return 1;
00183     else
00184             return 0;
00185 
00186 }
00187 
00188 #endif      // INC_PATHTYPE

Generated on Sat Nov 10 03:46:29 2007 for Camelot by  doxygen 1.4.4