Ax2.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/Ax1.h>
 
namespace Geom
{
class Pnt;
class Trsf;
class Vec;
 
}  // namespace Geom
 
namespace Geom
{
 
class LX_GEOM_EXPORT Ax2
{
public:
    //                                                       //
    // --------------------- BEGIN API --------------------- //
    //                                                       //
    // ATTENTION: DO NOT CHANGE ANY SIGNATURES IN THE API !  //
    //                                                       //
 
    // Methods PUBLIC
    //
    Ax2() = default;
 
    Ax2(const Geom::Pnt& P, const Geom::Dir& N, const Geom::Dir& Vx);
 
 
    Ax2(const Geom::Pnt& P, const Geom::Dir& V);
 
    Ax2(const Geom::Pnt& aP, const Geom::Dir& aZDir, const Geom::Dir& aYDir, const Geom::Dir& aXDir);
 
    void setAxis(const Geom::Ax1& A1);
 
 
    void setDirection(const Geom::Dir& V);
 
 
    void setLocation(const Geom::Pnt& P);
 
 
    void setXDirection(const Geom::Dir& Vx);
 
 
    void setYDirection(const Geom::Dir& Vy);
 
 
    double angle(const Ax2& Other) const;
 
    const Geom::Ax1& axis() const;
 
    const Geom::Dir& direction() const;
 
    const Geom::Pnt& location() const;
 
    const Geom::Dir& xDirection() const;
 
    const Geom::Dir& yDirection() const;
 
 
    bool isCoplanar(const Ax2& Other, const double LinearTolerance, const double AngularTolerance) const;
 
    bool isCoplanar(const Geom::Ax1& A1, const double LinearTolerance, const double AngularTolerance) const;
 
 
    void mirror(const Geom::Pnt& P);
 
 
    Ax2 mirrored(const Geom::Pnt& P) const;
 
 
    void mirror(const Geom::Ax1& A1);
 
 
    Ax2 mirrored(const Geom::Ax1& A1) const;
 
 
    void mirror(const Ax2& A2);
 
 
    Ax2 mirrored(const Ax2& A2) const;
 
    void rotate(const Geom::Ax1& A1, const double Ang);
 
    Ax2 rotated(const Geom::Ax1& A1, const double Ang) const;
 
    void scale(const Geom::Pnt& P, const double S);
 
    Ax2 scaled(const Geom::Pnt& P, const double S) const;
 
    void transform(const Geom::Trsf& T);
 
    Ax2 transformed(const Geom::Trsf& T) const;
 
    void translate(const Geom::Vec& V);
 
    Ax2 translated(const Geom::Vec& V) const;
 
    void translate(const Geom::Pnt& P1, const Geom::Pnt& P2);
 
    Ax2 translated(const Geom::Pnt& P1, const Geom::Pnt& P2) const;
 
    //                                                       //
    // ---------------------- END API ---------------------- //
    //                                                       //
 
 
    bool isEqual(const Ax2& Other, const double tolerance) const;
 
 
private:
    Ax1 myaxis = Ax1({0, 0, 0}, {0, 0, 1});
    Dir vydir = Dir(XYZ{0, 1, 0});
    Dir vxdir = Dir(XYZ{1, 0, 0});
};
 
}  // namespace Geom