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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/*************************************************************************
*
* $RCSfile: b2ivector.hxx,v $
*
* $Revision: 1.1 $
*
* last change: $Author: thb $ $Date: 2004-01-15 20:02:10 $
*
* 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_VECTOR_B2IVECTOR_HXX
#define _BGFX_VECTOR_B2IVECTOR_HXX
#ifndef _BGFX_TUPLE_B2ITUPLE_HXX
#include <basegfx/tuple/b2ituple.hxx>
#endif
#ifndef _BGFX_VECTOR_B2DVECTOR_HXX
#include <basegfx/vector/b2dvector.hxx>
#endif
namespace basegfx
{
// predeclaration
class B2DHomMatrix;
/** Base Point class with two sal_Int32 values
This class derives all operators and common handling for
a 2D data class from B2ITuple. All necessary extensions
which are special for 2D Vectors are added here.
@see B2ITuple
*/
class B2IVector : public ::basegfx::B2ITuple
{
public:
/** Create a 2D Vector
The vector is initialized to (0, 0)
*/
B2IVector()
: B2ITuple()
{}
/** Create a 2D Vector
@param nX
This parameter is used to initialize the X-coordinate
of the 2D Vector.
@param nY
This parameter is used to initialize the Y-coordinate
of the 2D Vector.
*/
B2IVector(sal_Int32 nX, sal_Int32 nY)
: B2ITuple(nX, nY)
{}
/** Create a copy of a 2D Vector
@param rVec
The 2D Vector which will be copied.
*/
B2IVector(const B2IVector& rVec)
: B2ITuple(rVec)
{}
/** constructor with tuple to allow copy-constructing
from B2ITuple-based classes
*/
explicit B2IVector(const ::basegfx::B2ITuple& rTuple)
: B2ITuple(rTuple)
{}
~B2IVector()
{}
/** *=operator to allow usage from B2IVector, too
*/
B2IVector& operator*=( const B2IVector& rPnt )
{
mnX *= rPnt.mnX;
mnY *= rPnt.mnY;
return *this;
}
/** *=operator to allow usage from B2IVector, too
*/
B2IVector& operator*=(sal_Int32 t)
{
mnX *= t;
mnY *= t;
return *this;
}
/** assignment operator to allow assigning the results
of B2ITuple calculations
*/
B2IVector& operator=( const ::basegfx::B2ITuple& rVec );
/** Calculate the length of this 2D Vector
@return The Length of the 2D Vector
*/
double getLength() const;
/** Set the length of this 2D Vector
@param fLen
The to be achieved length of the 2D Vector
*/
B2IVector& setLength(double fLen);
/** Calculate the Scalar with another 2D Vector
@param rVec
The second 2D Vector
@return
The Scalar value of the two involved 2D Vectors
*/
double scalar( const B2IVector& rVec ) const;
/** Calculate the length of the cross product with another 2D Vector
In 2D, returning an actual vector does not make much
sense here. The magnitude, although, can be readily
used for tasks such as angle calculations, since for
the returned value, the following equation holds:
retVal = getLength(this)*getLength(rVec)*sin(theta),
with theta being the angle between the two vectors.
@param rVec
The second 2D Vector
@return
The length of the cross product of the two involved 2D Vectors
*/
double cross( const B2IVector& rVec ) const;
/** Calculate the Angle with another 2D Vector
@param rVec
The second 2D Vector
@return
The Angle value of the two involved 2D Vectors in -pi/2 < return < pi/2
*/
double angle( const B2IVector& rVec ) const;
/** Transform vector by given transformation matrix.
Since this is a vector, translational components of the
matrix are disregarded.
*/
B2IVector& operator*=( const B2DHomMatrix& rMat );
static const B2IVector& getEmptyVector();
};
// external operators
//////////////////////////////////////////////////////////////////////////
/** Calculate the orientation to another 2D Vector
@param rVecA
The first 2D Vector
@param rVecB
The second 2D Vector
@return
The mathematical Orientation of the two involved 2D Vectors
*/
B2VectorOrientation getOrientation( const B2IVector& rVecA, const B2IVector& rVecB );
/** Calculate a perpendicular 2D Vector to the given one
@param rVec
The source 2D Vector
@return
A 2D Vector perpendicular to the one given in parameter rVec
*/
B2IVector getPerpendicular( const B2IVector& rVec );
/** Test two vectors which need not to be normalized for parallelism
@param rVecA
The first 2D Vector
@param rVecB
The second 2D Vector
@return
bool if the two values are parallel. Also true if
one of the vectors is empty.
*/
bool areParallel( const B2IVector& rVecA, const B2IVector& rVecB );
/** Transform vector by given transformation matrix.
Since this is a vector, translational components of the
matrix are disregarded.
*/
B2IVector operator*( const B2DHomMatrix& rMat, const B2IVector& rVec );
/** Test continuity between given vectors.
The two given vectors are assumed to describe control points on a
common point. Calculate if there is a continuity between them.
*/
B2VectorContinuity getContinuity( const B2IVector& rBackVector, const B2IVector& rForwardVector );
} // end of namespace basegfx
#endif // _BGFX_VECTOR_B2IVECTOR_HXX
|
