summaryrefslogtreecommitdiff
path: root/basegfx/inc/basegfx/polygon/b2dpolygontools.hxx
blob: ae69b40782805b1e29148abd3eae317f51f27608 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/*************************************************************************
 *
 *  $RCSfile: b2dpolygontools.hxx,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: aw $ $Date: 2003-11-10 11:45:47 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef _BGFX_POLYGON_B2DPOLYGONTOOLS_HXX
#define _BGFX_POLYGON_B2DPOLYGONTOOLS_HXX

#ifndef _BGFX_POINT_B2DPOINT_HXX
#include <basegfx/point/b2dpoint.hxx>
#endif

#ifndef _BGFX_VECTOR_B2DVECTOR_HXX
#include <basegfx/vector/b2dvector.hxx>
#endif

#ifndef _TOOLS_DEBUG_HXX
#include <tools/debug.hxx>
#endif

//////////////////////////////////////////////////////////////////////////////

namespace basegfx
{
    namespace polygon
    {
        // predefinitions
        class B2DPolygon;
    } // end of namespace polygon

    namespace range
    {
        class B2DRange;
    } // end of namespace range

    namespace polygon
    {
        namespace tools
        {
            // B2DPolygon tools

            /** Check if given polygon is closed. This is kind of a
                'classic' method to support old polygon definitions.
                Those old polygon definitions define the closed state
                of the polygon using identical start and endpoints. This
                method corrects this (removes double start/end points)
                and sets the Closed()-state of the polygon correctly.
            */
            void checkClosed(polygon::B2DPolygon& rCandidate);

            // Get index of outmost point (e.g. biggest X and biggest Y)
            sal_uInt32 getIndexOfOutmostPoint(const ::basegfx::polygon::B2DPolygon& rCandidate);

            // Get successor and predecessor indices. Returning the same index means there
            // is none. Same for successor.
            sal_uInt32 getIndexOfPredecessor(sal_uInt32 nIndex, const ::basegfx::polygon::B2DPolygon& rCandidate);
            sal_uInt32 getIndexOfSuccessor(sal_uInt32 nIndex, const ::basegfx::polygon::B2DPolygon& rCandidate);

            // Get index of first different predecessor. Returning the same index means there
            // is none. Same for successor.
            sal_uInt32 getIndexOfDifferentPredecessor(sal_uInt32 nIndex, const ::basegfx::polygon::B2DPolygon& rCandidate);
            sal_uInt32 getIndexOfDifferentSuccessor(sal_uInt32 nIndex, const ::basegfx::polygon::B2DPolygon& rCandidate);

            // Get orientation of Polygon
            ::basegfx::vector::B2DVectorOrientation getOrientation(const ::basegfx::polygon::B2DPolygon& rCandidate);

            // isInside tests for B2dPoint and other B2dPolygon. On border is not inside as long as
            // not sal_True is given in bWithBorder flag.
            sal_Bool isInside(const ::basegfx::polygon::B2DPolygon& rCandidate, const ::basegfx::point::B2DPoint& rPoint, sal_Bool bWithBorder = sal_False);
            sal_Bool isInside(const ::basegfx::polygon::B2DPolygon& rCandidate, const ::basegfx::polygon::B2DPolygon& rPolygon, sal_Bool bWithBorder = sal_False);

            // get size of polygon
            ::basegfx::range::B2DRange getRange(const ::basegfx::polygon::B2DPolygon& rCandidate);

            // get area of polygon
            double getArea(const ::basegfx::polygon::B2DPolygon& rCandidate);

            // get length of polygon edge from point nIndex to nIndex + 1
            double getEdgeLength(const ::basegfx::polygon::B2DPolygon& rCandidate, sal_uInt32 nIndex);

            // get length of polygon
            double getLength(const ::basegfx::polygon::B2DPolygon& rCandidate);

            // get position on polygon for absolute given distance. If
            // length is given, it is assumed the correct polygon length, if 0.0 it is calculated
            // using getLength(...)
            ::basegfx::point::B2DPoint getPositionAbsolute(const ::basegfx::polygon::B2DPolygon& rCandidate, double fDistance, double fLength = 0.0);

            // get position on polygon for relative given distance in range [0.0 .. 1.0]. If
            // length is given, it is assumed the correct polygon length, if 0.0 it is calculated
            // using getLength(...)
            ::basegfx::point::B2DPoint getPositionRelative(const ::basegfx::polygon::B2DPolygon& rCandidate, double fDistance, double fLength = 0.0);

            // get orientation at given polygon point
            ::basegfx::vector::B2DVectorOrientation getPointOrientation(const ::basegfx::polygon::B2DPolygon& rCandidate, sal_uInt32 nIndex);

            // Continuity check for point with given index
            ::basegfx::vector::B2DVectorContinuity getContinuityInPoint(const ::basegfx::polygon::B2DPolygon& rCandidate, sal_uInt32 nIndex);

            // Definitions for the cut flags used from the findCut methods
            typedef sal_uInt16 CutFlagValue;

            #define CUTFLAG_NONE            (0x0000)
            #define CUTFLAG_LINE            (0x0001)
            #define CUTFLAG_START1          (0x0002)
            #define CUTFLAG_START2          (0x0004)
            #define CUTFLAG_END1            (0x0008)
            #define CUTFLAG_END2            (0x0010)
            #define CUTFLAG_ALL         (CUTFLAG_LINE|CUTFLAG_START1|CUTFLAG_START2|CUTFLAG_END1|CUTFLAG_END2)
            #define CUTFLAG_DEFAULT     (CUTFLAG_LINE|CUTFLAG_START2|CUTFLAG_END2)

            // Calculate cut between the points given by the two indices. pCut1
            // and pCut2 will contain the cut coordinate on each edge in ]0.0, 1.0]
            // (if given) and the return value will contain a cut description.
            CutFlagValue findCut(
                const ::basegfx::polygon::B2DPolygon& rCandidate,
                sal_uInt32 nIndex1, sal_uInt32 nIndex2,
                CutFlagValue aCutFlags = CUTFLAG_DEFAULT,
                double* pCut1 = 0L, double* pCut2 = 0L);

            // This version is working with two indexed edges from different
            // polygons.
            CutFlagValue findCut(
                const ::basegfx::polygon::B2DPolygon& rCandidate1, sal_uInt32 nIndex1,
                const ::basegfx::polygon::B2DPolygon& rCandidate2, sal_uInt32 nIndex2,
                CutFlagValue aCutFlags = CUTFLAG_DEFAULT,
                double* pCut1 = 0L, double* pCut2 = 0L);

            // This version works with two points and vectors to define the
            // edges for the cut test.
            CutFlagValue findCut(
                const ::basegfx::point::B2DPoint& rEdge1Start, const ::basegfx::vector::B2DVector& rEdge1Delta,
                const ::basegfx::point::B2DPoint& rEdge2Start, const ::basegfx::vector::B2DVector& rEdge2Delta,
                CutFlagValue aCutFlags = CUTFLAG_DEFAULT,
                double* pCut1 = 0L, double* pCut2 = 0L);

            // test if point is on the given edge in range ]0.0..1.0[ without
            // the start/end points. If so, return sal_True and put the parameter
            // value in pCut (if provided)
            sal_Bool isPointOnEdge(
                const ::basegfx::point::B2DPoint& rPoint,
                const ::basegfx::point::B2DPoint& rEdgeStart,
                const ::basegfx::vector::B2DVector& rEdgeDelta,
                double* pCut = 0L);



            /* Still missing:
            void transform(const Matrix4D& rTfMatrix);
            Polygon3D getExpandedPolygon(sal_uInt32 nNum);
            */


        } // end of namespace tools
    } // end of namespace polygon
} // end of namespace basegfx

#endif //   _BGFX_POLYGON_B2DPOLYGONTOOLS_HXX