Tuple2D.hxx

Go to the documentation of this file.

/* -*- 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 <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:
    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);
    }
 
    TYPE getX() const { return mnX; }
 
    TYPE getY() const { return mnY; }
 
    void setX(TYPE fX) { mnX = fX; }
 
    void setY(TYPE fY) { mnY = fY; }
 
    void adjustX(TYPE fX) { mnX += fX; }
 
    void adjustY(TYPE fY) { mnY += fY; }
 
    // comparators with tolerance
 
    template <typename T = TYPE, std::enable_if_t<std::is_integral_v<T>, int> = 0>
    bool equal(const Tuple2D<TYPE>& rTup) const
    {
        return mfX == rTup.mfX && mfY == rTup.mfY;
    }
 
    template <typename T = TYPE, std::enable_if_t<std::is_floating_point_v<T>, int> = 0>
    bool equal(const Tuple2D<TYPE>& rTup) const
    {
        return this == &rTup || (fTools::equal(mfX, rTup.mfX) && fTools::equal(mfY, rTup.mfY));
    }
 
    template <typename T = TYPE, std::enable_if_t<std::is_integral_v<T>, int> = 0>
    bool equalZero() const
    {
        return mnX == 0 && mnY == 0;
    }
 
    template <typename T = TYPE, std::enable_if_t<std::is_floating_point_v<T>, int> = 0>
    bool equalZero() const
    {
        return fTools::equalZero(mfX) && fTools::equalZero(mfY);
    }
 
    // operator overrides
 
    Tuple2D<TYPE>& operator+=(const Tuple2D<TYPE>& rTup)
    {
        mfX += rTup.mfX;
        mfY += rTup.mfY;
        return *this;
    }
 
    Tuple2D<TYPE>& operator-=(const Tuple2D<TYPE>& rTup)
    {
        mfX -= rTup.mfX;
        mfY -= rTup.mfY;
        return *this;
    }
 
    Tuple2D<TYPE>& operator/=(const Tuple2D<TYPE>& rTup)
    {
        mfX /= rTup.mfX;
        mfY /= rTup.mfY;
        return *this;
    }
 
    Tuple2D<TYPE>& operator*=(const Tuple2D<TYPE>& rTup)
    {
        mfX *= rTup.mfX;
        mfY *= rTup.mfY;
        return *this;
    }
 
    Tuple2D<TYPE>& operator*=(TYPE t)
    {
        mfX *= t;
        mfY *= t;
        return *this;
    }
 
    Tuple2D<TYPE>& operator/=(TYPE t)
    {
        mfX /= t;
        mfY /= t;
        return *this;
    }
 
    Tuple2D<TYPE> operator-(void) const { return Tuple2D<TYPE>(-mfX, -mfY); }
 
    bool operator==(const Tuple2D<TYPE>& rTup) const { return mfX == rTup.mfX && mfY == rTup.mfY; }
 
    bool operator!=(const Tuple2D<TYPE>& rTup) const { return !(*this == rTup); }
};
 
template <typename TYPE>
inline Tuple2D<TYPE> operator-(const Tuple2D<TYPE>& rTupA, const Tuple2D<TYPE>& rTupB)
{
    Tuple2D<TYPE> aNew(rTupA);
    aNew -= rTupB;
    return aNew;
}
 
template <typename TYPE>
inline Tuple2D<TYPE> operator+(const Tuple2D<TYPE>& rTupA, const Tuple2D<TYPE>& rTupB)
{
    Tuple2D<TYPE> aNew(rTupA);
    aNew += rTupB;
    return aNew;
}
 
template <typename TYPE>
inline Tuple2D<TYPE> operator*(const Tuple2D<TYPE>& rTupA, const Tuple2D<TYPE>& rTupB)
{
    Tuple2D<TYPE> aNew(rTupA);
    aNew *= rTupB;
    return aNew;
}
 
template <typename TYPE>
inline Tuple2D<TYPE> operator/(const Tuple2D<TYPE>& rTupA, const Tuple2D<TYPE>& rTupB)
{
    Tuple2D<TYPE> aNew(rTupA);
    aNew /= rTupB;
    return aNew;
}
 
} // end of namespace basegfx
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */