Dir2d.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/Precision.h>
#include <Geom/Trsf2d.h>
#include <Geom/XY.h>

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

    double angle(const Dir2d& Other) const;

    double coord(const int Index) const;
    void coord(double& Xv, double& Yv) const;
    double crossed(const Dir2d& Right) const;
    double dot(const Dir2d& Other) const;
    bool isEqual(const Dir2d& Other, const double AngularTolerance) const;

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

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

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

    void mirror(const Dir2d& V);

    void mirror(const Ax2d& A);

    Dir2d mirrored(const Ax2d& A) const;

    Dir2d mirrored(const Dir2d& V) const;

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

    double operator^(const Dir2d& Right) const { return crossed(Right); }
    double operator*(const Dir2d& Other) const { return dot(Other); }

    bool operator==(const Dir2d& other) const { return _coord.isEqual(other._coord, Geom::Precision::epsilon()); }

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

    Dir2d rotated(const double Ang) const;

    void setCoord(const int Index, const double Xi);

    void setCoord(const double Xv, const double Yv);

    void setX(const double X);

    void setXY(const XY& Coord);

    void setY(const double Y);

    void transform(const Trsf2d& T);

    Dir2d transformed(const Trsf2d& T) const;

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

    double y() const;

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