Vec2d.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/Pnt2d.h>
#include <Geom/XY.h>

namespace Geom
{
class Ax2d;
class Dir2d;
class Trsf2d;

class GEOM_EXPORT Vec2d
{
public:
    Vec2d();
    Vec2d(const Dir2d& V);
    Vec2d(const XY& Coord);
    Vec2d(const double Xv, const double Yv);

    Vec2d(const Pnt2d& P1, const Pnt2d& P2);
    void add(const Vec2d& Other);
    Vec2d added(const Vec2d& Other) const;
    double angle(const Vec2d& Other) const;
    double coord(const int Index) const;
    void coord(double& Xv, double& Yv) const;
    double crossed(const Vec2d& Right) const;
    double crossMagnitude(const Vec2d& Right) const;

    double crossSquareMagnitude(const Vec2d& Right) const;

    void divide(const double Scalar);
    Vec2d divided(const double Scalar) const;
    double dot(const Vec2d& Other) const;
    bool isEqual(const Vec2d& Other, const double LinearTolerance, const double AngularTolerance) const;

    bool isNormal(const Vec2d& Other, const double AngularTolerance) const;

    bool isOpposite(const Vec2d& Other, const double AngularTolerance) const;

    bool isParallel(const Vec2d& Other, const double AngularTolerance) const;

    double magnitude() const;
    double squareMagnitude() const;

    void operator+=(const Vec2d& Other) { add(Other); }
    Vec2d operator+(const Vec2d& Other) const { return added(Other); }
    void operator-=(const Vec2d& Right) { subtract(Right); }
    Vec2d operator-() const { return reversed(); }

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

    void operator*=(const double Scalar) { multiply(Scalar); }
    double operator*(const Vec2d& Other) const { return dot(Other); }

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

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

    void multiply(const double Scalar);
    Vec2d multiplied(const double Scalar) const;
    void mirror(const Vec2d& V);

    void mirror(const Ax2d& A1);

    Vec2d mirrored(const Ax2d& A1) const;

    Vec2d mirrored(const Vec2d& V) const;

    void normalize();
    Vec2d normalized() const;

    void reverse();
    Vec2d reversed() const;
    void rotate(const double Ang);

    Vec2d rotated(const double Ang) const;

    void scale(const double S);
    Vec2d scaled(const double S) const;

    void setCoord(const int Index, const double Xi);
    void setCoord(const double Xv, const double Yv);
    void setLinearForm(const double A1, const Vec2d& V1, const double A2, const Vec2d& V2, const Vec2d& V3);

    void setLinearForm(const double A1, const Vec2d& V1, const double A2, const Vec2d& V2);

    void setLinearForm(const double A1, const Vec2d& V1, const Vec2d& V2);

    void setLinearForm(const Vec2d& Left, const Vec2d& Right);

    void setX(const double X);
    void setXY(const XY& Coord);

    void setY(const double Y);
    void subtract(const Vec2d& Right);
    Vec2d subtracted(const Vec2d& Right) const;
    void transform(const Trsf2d& T);
    Vec2d transformed(const Trsf2d& T) const;

    double x() const;
    const XY& xy() const;

    double y() const;

protected:
private:
    XY _coord;
};
}  // namespace Geom