Dir.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/GeomEnums.h>
#include <Geom/XYZ.h>
#include <Geom/geom_defines.h>

namespace Geom
{
class Ax1;
class Ax2;
class Trsf;
class Vec;
class Dir;


class GEOM_EXPORT Dir
{
public:
    //                                                       //
    // --------------------- BEGIN API --------------------- //
    //                                                       //
    // ATTENTION: DO NOT CHANGE ANY SIGNATURES IN THE API !  //
    //                                                       //

    // Methods PUBLIC
    //
    Dir();
    Dir(const Geom::Vec& V);
    Dir(const Geom::XYZ& Coord);
    Dir(const double Xv, const double Yv, const double Zv);
    Dir(const Dir& rhs);

    // named constr.
    static Dir XDir() { return Dir(1, 0, 0); };
    static Dir YDir() { return Dir(0, 1, 0); };
    static Dir ZDir() { return Dir(0, 0, 1); };

    void setCoord(const int Index, const double Xi);
    void setCoord(const double Xv, const double Yv, const double Zv);
    void setX(const double X);
    void setY(const double Y);
    void setZ(const double Z);
    void setXYZ(const Geom::XYZ& Coord);

    double coord(const int Index) const;
    void coord(double& Xv, double& Yv, double& Zv) const;
    double x() const;
    double y() const;
    double z() const;
    const Geom::XYZ& xyz() const;

    bool isEqual(const Dir& Other, const double AngularTolerance) const;

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

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

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


    double angle(const Dir& Other) const;


    double angleWithRef(const Dir& Other, const Dir& VRef) const;
    void cross(const Dir& Right);
    void operator^=(const Dir& Right) { cross(Right); }

    Dir crossed(const Dir& Right) const;
    Dir operator^(const Dir& Right) const { return crossed(Right); }


    void crossCross(const Dir& V1, const Dir& V2);
    Dir crossCrossed(const Dir& V1, const Dir& V2) const;
    double dot(const Dir& Other) const;
    double operator*(const Dir& Other) const { return dot(Other); }


    double dotCross(const Dir& V1, const Dir& V2) const;

    void reverse();
    Dir reversed() const;
    Dir operator-() const { return reversed(); }



    void mirror(const Dir& V);


    Dir mirrored(const Dir& V) const;


    void mirror(const Geom::Ax1& A1);


    Dir mirrored(const Geom::Ax1& A1) const;


    void mirror(const Geom::Ax2& A2);


    Dir mirrored(const Geom::Ax2& A2) const;

    void rotate(const Geom::Ax1& A1, const double Ang);

    Dir rotated(const Geom::Ax1& A1, const double Ang) const;


    void transform(const Geom::Trsf& T);

    Dir transformed(const Geom::Trsf& T) const;

    //                                                       //
    // ---------------------- END API ---------------------- //
    //                                                       //

    bool operator==(const Geom::Dir& other) const;


    double& operator[](int i);
    const double& operator[](int i) const;


private:
    Geom::XYZ _coord;
};

}  // namespace Geom