XY.h

Go to the documentation of this file.

//
// Copyright(C) 2013-2016  OpenCascade [www.opencascade.org]
//
// This library is free software; you can redistribute it and / or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// 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., 51 Franklin Street,
// Fifth Floor, Boston, MA  02110 - 1301  USA
//

#pragma once
#include <Geom/geom_defines.h>

namespace Geom
{
class Mat2d;

class GEOM_EXPORT XY
{
public:
    XY();
    XY(const double X, const double Y);

    void add(const XY& Other);
    XY added(const XY& Other) const;
    double coord(const int Index) const;
    void coord(double& X, double& Y) const;
    double crossed(const XY& Right) const;
    double crossMagnitude(const XY& Right) const;

    double crossSquareMagnitude(const XY& Right) const;
    void divide(const double Scalar);
    XY divided(const double Scalar) const;
    double dot(const XY& Other) const;
    bool isEqual(const XY& Other, const double Tolerance) const;
    double modulus() const;
    XY multiplied(const double Scalar) const;
    XY multiplied(const XY& Other) const;
    XY multiplied(const Mat2d& Matrix) const;
    void multiply(const double Scalar);
    void multiply(const XY& Other);
    void multiply(const Mat2d& Matrix);
    void normalize();

    XY normalized() const;

    void operator+=(const XY& Other) { add(Other); }
    XY operator+(const XY& Other) const { return added(Other); }

    XY operator-() const { return reversed(); }

    void operator-=(const XY& Right) { subtract(Right); }

    XY operator-(const XY& Right) const { return subtracted(Right); }

    XY operator*(const Mat2d& Matrix) const { return multiplied(Matrix); }

    double operator*(const XY& Other) const { return dot(Other); }

    void operator*=(const double Scalar) { multiply(Scalar); }

    void operator*=(const XY& Other) { multiply(Other); }
    void operator*=(const Mat2d& Matrix) { multiply(Matrix); }

    XY operator*(const double Scalar) const { return multiplied(Scalar); }

    void operator/=(const double Scalar) { divide(Scalar); }
    XY operator/(const double Scalar) const { return divided(Scalar); }
    double operator^(const XY& Right) const { return crossed(Right); }

    void reverse();

    XY reversed() const;
    void setCoord(const int Index, const double Xi);
    void setCoord(const double X, const double Y);
    void setLinearForm(const double A1, const XY& XY1, const double A2, const XY& XY2);

    void setLinearForm(const double A1, const XY& XY1, const double A2, const XY& XY2, const XY& XY3);

    void setLinearForm(const double A1, const XY& XY1, const XY& XY2);

    void setLinearForm(const XY& XY1, const XY& XY2);

    void setX(const double X);
    void setY(const double Y);

    double squareModulus() const;

    void subtract(const XY& Right);
    XY subtracted(const XY& Right) const;
    double x() const;
    double y() const;

protected:
private:
    double _x;
    double _y;
};

}  // namespace Geom