summaryrefslogtreecommitdiff
path: root/basegfx/inc/basegfx/tuple/b2dtuple.hxx
blob: 69a9a438abdeb11c1c370c039ed3f45b861df16d (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
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
/*************************************************************************
 *
 *  $RCSfile: b2dtuple.hxx,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: aw $ $Date: 2003-10-31 10:06:24 $
 *
 *  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_TUPLE_B2DTUPLE_HXX
#define _BGFX_TUPLE_B2DTUPLE_HXX

#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif

#ifndef _INC_MATH
#include <math.h>
#endif

namespace basegfx
{
    namespace tuple
    {
        /** Base class for all Points/Vectors with two double values

            This class provides all methods common to Point
            avd Vector classes which are derived from here.

            @derive Use this class to implement Points or Vectors
            which are based on two double values
        */
        class B2DTuple
        {
        private:
            static B2DTuple                             maEmptyTuple;

        protected:
            double                                      mfX;
            double                                      mfY;

        public:
            /** Create a 2D Tuple

                @param fVal
                This parameter is used to initialize the coordinate
                part of the 2D Tuple.
            */
            B2DTuple(double fVal = 0.0)
            :   mfX(fVal),
                mfY(fVal)
            {}

            /** Create a 2D Tuple

                @param fX
                This parameter is used to initialize the X-coordinate
                of the 2D Tuple.

                @param fY
                This parameter is used to initialize the Y-coordinate
                of the 2D Tuple.
            */
            B2DTuple(double fX, double fY)
            :   mfX( fX ),
                mfY( fY )
            {}

            /** Create a copy of a 2D Tuple

                @param rTup
                The 2D Tuple which will be copied.
            */
            B2DTuple(const B2DTuple& rTup)
            :   mfX( rTup.mfX ),
                mfY( rTup.mfY )
            {}

            ~B2DTuple()
            {}

            /// Get X-Coordinate of 2D Tuple
            double getX() const
            {
                return mfX;
            }

            /// Get Y-Coordinate of 2D Tuple
            double getY() const
            {
                return mfY;
            }

            /// Set X-Coordinate of 2D Tuple
            void setX(double fX)
            {
                mfX = fX;
            }

            /// Set Y-Coordinate of 2D Tuple
            void setY(double fY)
            {
                mfY = fY;
            }

            /// Array-access to 2D Tuple
            const double& operator[] (int nPos) const
            {
                // Here, normally one if(...) should be used. In the assumption that
                // both double members can be accessed as an array a shortcut is used here.
                // if(0 == nPos) return mfX; return mfY;
                return *((&mfX) + nPos);
            }

            /// Array-access to 2D Tuple
            double& operator[] (int nPos)
            {
                // Here, normally one if(...) should be used. In the assumption that
                // both double members can be accessed as an array a shortcut is used here.
                // if(0 == nPos) return mfX; return mfY;
                return *((&mfX) + nPos);
            }

            // comparators with tolerance
            //////////////////////////////////////////////////////////////////////

            bool equalZero() const;

            bool equalZero(const double& rfSmallValue) const;

            bool equal(const B2DTuple& rTup) const;

            bool equal(const B2DTuple& rTup, const double& rfSmallValue) const;

            // operators
            //////////////////////////////////////////////////////////////////////

            B2DTuple& operator+=( const B2DTuple& rTup )
            {
                mfX += rTup.mfX;
                mfY += rTup.mfY;
                return *this;
            }

            B2DTuple& operator-=( const B2DTuple& rTup )
            {
                mfX -= rTup.mfX;
                mfY -= rTup.mfY;
                return *this;
            }

            B2DTuple& operator/=( const B2DTuple& rTup )
            {
                mfX /= rTup.mfX;
                mfY /= rTup.mfY;
                return *this;
            }

            B2DTuple& operator*=( const B2DTuple& rTup )
            {
                mfX *= rTup.mfX;
                mfY *= rTup.mfY;
                return *this;
            }

            B2DTuple& operator*=(double t)
            {
                mfX *= t;
                mfY *= t;
                return *this;
            }

            B2DTuple& operator/=(double t)
            {
                const double fVal(1.0 / t);
                mfX *= fVal;
                mfY *= fVal;
                return *this;
            }

            B2DTuple operator-(void) const
            {
                return B2DTuple(-mfX, -mfY);
            }

            bool operator==( const B2DTuple& rTup ) const
            {
                return equal(rTup);
            }

            bool operator!=( const B2DTuple& rTup ) const
            {
                return !equal(rTup);
            }

            B2DTuple& operator=( const B2DTuple& rTup )
            {
                mfX = rTup.mfX;
                mfY = rTup.mfY;
                return *this;
            }

            void correctValues(const double fCompareValue = 0.0);

            static const B2DTuple& getEmptyTuple()
            {
                return maEmptyTuple;
            }
        };

        // external operators
        //////////////////////////////////////////////////////////////////////////

        inline B2DTuple min(const B2DTuple& rTupA, const B2DTuple& rTupB)
        {
            B2DTuple aMin(
                (rTupB.getX() < rTupA.getX()) ? rTupB.getX() : rTupA.getX(),
                (rTupB.getY() < rTupA.getY()) ? rTupB.getY() : rTupA.getY());
            return aMin;
        }

        inline B2DTuple max(const B2DTuple& rTupA, const B2DTuple& rTupB)
        {
            B2DTuple aMax(
                (rTupB.getX() > rTupA.getX()) ? rTupB.getX() : rTupA.getX(),
                (rTupB.getY() > rTupA.getY()) ? rTupB.getY() : rTupA.getY());
            return aMax;
        }

        inline B2DTuple abs(const B2DTuple& rTup)
        {
            B2DTuple aAbs(
                (0.0 > rTup.getX()) ? -rTup.getX() : rTup.getX(),
                (0.0 > rTup.getY()) ? -rTup.getY() : rTup.getY());
            return aAbs;
        }

        inline B2DTuple interpolate(const B2DTuple& rOld1, const B2DTuple& rOld2, double t)
        {
            B2DTuple aInt(
                ((rOld2.getX() - rOld1.getX()) + t) + rOld1.getX(),
                ((rOld2.getY() - rOld1.getY()) + t) + rOld1.getY());
            return aInt;
        }

        inline B2DTuple average(const B2DTuple& rOld1, const B2DTuple& rOld2)
        {
            B2DTuple aAvg(
                (rOld1.getX() + rOld2.getX()) * 0.5,
                (rOld1.getY() + rOld2.getY()) * 0.5);
            return aAvg;
        }

        inline B2DTuple average(const B2DTuple& rOld1, const B2DTuple& rOld2, const B2DTuple& rOld3)
        {
            B2DTuple aAvg(
                (rOld1.getX() + rOld2.getX() + rOld3.getX()) * (1.0 / 3.0),
                (rOld1.getY() + rOld2.getY() + rOld3.getY()) * (1.0 / 3.0));
            return aAvg;
        }

        inline B2DTuple operator+(const B2DTuple& rTupA, const B2DTuple& rTupB)
        {
            B2DTuple aSum(rTupA);
            aSum += rTupB;
            return aSum;
        }

        inline B2DTuple operator-(const B2DTuple& rTupA, const B2DTuple& rTupB)
        {
            B2DTuple aSub(rTupA);
            aSub -= rTupB;
            return aSub;
        }

        inline B2DTuple operator/(const B2DTuple& rTupA, const B2DTuple& rTupB)
        {
            B2DTuple aDiv(rTupA);
            aDiv /= rTupB;
            return aDiv;
        }

        inline B2DTuple operator*(const B2DTuple& rTupA, const B2DTuple& rTupB)
        {
            B2DTuple aMul(rTupA);
            aMul *= rTupB;
            return aMul;
        }

        inline B2DTuple operator*(const B2DTuple& rTup, double t)
        {
            B2DTuple aNew(rTup);
            aNew *= t;
            return aNew;
        }

        inline B2DTuple operator*(double t, const B2DTuple& rTup)
        {
            B2DTuple aNew(rTup);
            aNew *= t;
            return aNew;
        }

        inline B2DTuple operator/(const B2DTuple& rTup, double t)
        {
            B2DTuple aNew(rTup);
            aNew /= t;
            return aNew;
        }

        inline B2DTuple operator/(double t, const B2DTuple& rTup)
        {
            B2DTuple aNew(rTup);
            aNew /= t;
            return aNew;
        }
    } // end of namespace tuple
} // end of namespace basegfx

#endif //  _BGFX_TUPLE_B2DTUPLE_HXX