doccoord.h

Go to the documentation of this file.
00001 // $Id: doccoord.h 1285 2006-06-09 11:10:27Z 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 /*
00100  *  */
00101 
00102 /*********************************************************************************************
00103 
00104 >   class DocCoord
00105 
00106     Author:     Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com>
00107     Created:    10/5/1993          
00108     Base Class: Coord
00109     Purpose:    Structure holding a 32-bit cartesian coordinate.
00110                 Its main use is to hold the physical coordinates of objects in document space.
00111     Errors:     None.
00112 
00113 *********************************************************************************************/
00114 
00115 #ifndef INC_DOCCOORD
00116 #define INC_DOCCOORD
00117 
00118 #include "coord.h"
00119 
00120 #if !defined(EXCLUDE_FROM_XARLIB)
00121 #include "wrkcoord.h"
00122 #endif
00123 
00124 #include "matrix.h"
00125 
00126 // Declare various classes to prevent bogus stuff...
00127 class Chapter;
00128 class CCAPI WorkCoord;
00129 class CCAPI OSCoord;
00130 class Matrix;
00131 class XMatrix;
00132 class Spread;
00133 class Document;
00134 class View;
00135 class UserCoord;
00136 
00137 class CCAPI DocCoord : public Coord
00138 {
00139 public:
00140 
00141     DocCoord( INT32 x, INT32 y ) : Coord(x,y) {};
00142     DocCoord() : Coord() {};
00143 
00144 #if !defined(EXCLUDE_FROM_XARLIB)
00145     // Build the matrix which transforms DocCoords into OilCoords...
00146     friend Matrix ComposeDocToOilMat( const DocCoord& ChapterPos,   // Top left coord of chapter
00147                           const XLONG& ChapterDepth,            // Accumulated height of previous chaps
00148                           const FIXED16& ViewScale,         // User viewing scale
00149                           const WorkCoord& ScrollOffset );  // Scroll offsets
00150 
00151     // Build the matrix which transforms DocCoords into WorkCoords...
00152     friend XMatrix ComposeDocToWorkXMat( const DocCoord ChapterPos, // Top left coord of chapter
00153                           const XLONG ChapterDepth,     // Accumulated height of previous chaps
00154                           const FIXED16 ViewScale);     // User viewing scale
00155 
00156     // Convert between coords
00157     WorkCoord ToWork( Document *pDocument, View *pView);
00158     WorkCoord ToWork( Spread *pSpread, View *pView);
00159     DocCoord  ToDoc(Spread* pSpread, View* pView);      // ie from SpreadCoords to    DocCoords
00160     DocCoord  ToSpread(Spread* pSpread, View* pView);   // ie from    DocCoords to SpreadCoords
00161     UserCoord ToUser(Spread* pSpread);                  // ie from SpreadCoords to   UserCoords
00162     OilCoord  ToOil(Spread* pSpread, View* pView);      // ie from SpreadCoords to   OilCoords
00163 
00164     // Convert a DocCoord into a Logical coord (ie in millipoints, but 64 bits high)
00165     // The result will be returned in a WorkCoord (normally used for coords measured
00166     // in pixels)
00167     WorkCoord ToLogical(Spread* pSpread, View *pView);
00168 
00169     // Given a DocCoords, find the chapter its in and return other details...
00170     Chapter* FindEnclosingChapter(Document *pDocument, 
00171                                   DocCoord* ChapterPos, 
00172                                   XLONG* ChapterDepth,
00173                                   View *pView);  
00174 
00175     // Functions dealing with pixel size taking scaling into account...
00176     // (See View class for actual scaled pixel size values/access functions)
00177     BOOL Pixelise();
00178     BOOL Pixelise(View* pView);
00179     BOOL IsPixelised(View* pView);
00180 #endif
00181 
00182     // Some operator functions
00183     friend DocCoord operator + (const DocCoord& , const DocCoord& );
00184     friend DocCoord operator - (const DocCoord& , const DocCoord& );
00185 
00186     // Graeme (29-3-00) - Added the += and -= operators.
00187     const DocCoord& operator += ( const DocCoord &Other );
00188     const DocCoord& operator -= ( const DocCoord &Other );
00189 
00190     //A scaling function
00191     void Scale(const DocCoord dcOrigin, const double dDPI=96.0);
00192 
00193     // Karim 13/06/2000
00194     // Imagining a vector from the origin, return our angle clockwise from the vertical.
00195     // The angle returned is in radians, for ease-of-use with trig fns,
00196     // and is zero at the origin.
00197     // To convert to degrees, use (result * 180.0 / PI) :o)
00198     double AngleFromVertical() const { return atan2( (double)x, (double)y ); }
00199 
00200     // Jolly useful functions for working out coordinate positions
00201     static BOOL IsJoinAcute(const DocCoord* pJoin, const DocCoord* pOtherEndOfJoin, const DocCoord* pOtherPoint);
00202     static DocCoord PositionPointFromRatio(const DocCoord& StartPoint, const DocCoord& EndPoint, const double Ratio);
00203     static double DistanceFromLine(const DocCoord& Line1, const DocCoord& Line2, const DocCoord& Point);
00204     static DocCoord OneThird(const DocCoord& Start, const DocCoord& End);
00205     static DocCoord OneHalf(const DocCoord& Start, const DocCoord& End);
00206     static DocCoord TwoThirds(const DocCoord& Start, const DocCoord& End);
00207 };
00208 
00209 #endif
00210 

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