summaryrefslogtreecommitdiff
path: root/include/basegfx/tuple/Tuple2D.hxx
blob: e38dd15422074b62689903d25fb66cb5c18a4176 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 */

#pragma once

#include <sal/types.h>
#include <basegfx/basegfxdllapi.h>
#include <basegfx/utils/common.hxx>
#include <basegfx/numeric/ftools.hxx>

namespace basegfx
{
template <typename TYPE> class Tuple2D
{
protected:
    union {
        // temporary alias mnX with mfX and mnY with mfY
        struct
        {
            TYPE mnX;
            TYPE mnY;
        };
        struct
        {
            TYPE mfX;
            TYPE mfY;
        };
    };

public:
    /** Create a 2D Tuple

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

            @param nY
            This parameter is used to initialize the Y-coordinate
            of the 2D Tuple.
    */
    Tuple2D(TYPE x, TYPE y)
        : mnX(x)
        , mnY(y)
    {
    }

    double get(Axis2D eAxis) { return eAxis == Axis2D::X ? getX() : getY(); }

    void set(Axis2D eAxis, TYPE fValue)
    {
        if (eAxis == Axis2D::X)
            setX(fValue);
        else
            setY(fValue);
    }

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

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

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

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

    // comparators with tolerance

    template <typename T = TYPE,
              typename std::enable_if<std::is_integral<T>::value, bool>::type = false>
    bool equal(const Tuple2D<TYPE>& rTup) const
    {
        return mfX == rTup.mfX && mfY == rTup.mfY;
    }

    template <typename T = TYPE,
              typename std::enable_if<std::is_floating_point<T>::value, bool>::type = false>
    bool equal(const Tuple2D<TYPE>& rTup) const
    {
        return this == &rTup || (fTools::equal(mfX, rTup.mfX) && fTools::equal(mfY, rTup.mfY));
    }

    template <typename T = TYPE,
              typename std::enable_if<std::is_integral<T>::value, bool>::type = false>
    bool equalZero() const
    {
        return mnX == 0 && mnY == 0;
    }

    template <typename T = TYPE,
              typename std::enable_if<std::is_floating_point<T>::value, bool>::type = false>
    bool equalZero() const
    {
        return fTools::equalZero(mfX) && fTools::equalZero(mfY);
    }

    // operator overrides

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

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

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

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

    Tuple2D& operator*=(TYPE t)
    {
        mfX *= t;
        mfY *= t;
        return *this;
    }

    Tuple2D& operator/=(TYPE t)
    {
        mfX /= t;
        mfY /= t;
        return *this;
    }

    bool operator==(const Tuple2D& rTup) const { return mfX == rTup.mfX && mfY == rTup.mfY; }

    bool operator!=(const Tuple2D& rTup) const { return !(*this == rTup); }
};

} // end of namespace basegfx

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */