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

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

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

    // Methods PUBLIC
    //
    Pln();

    Pln(const Geom::Ax3& A3);


    Pln(const Geom::Pnt& P, const Geom::Dir& V);


    Pln(const double A, const double B, const double C, const double D);

    void coefficients(double& A, double& B, double& C, double& D) const;
    void setAxis(const Geom::Ax1& A1);
    void setLocation(const Geom::Pnt& Loc);
    void setPosition(const Geom::Ax3& A3);
    void uReverse();
    void vReverse();
    bool direct() const;
    const Geom::Ax1& axis() const;
    const Geom::Pnt& location() const;
    const Geom::Ax3& position() const;
    double distance(const Geom::Pnt& P) const;
    double signeddistance(const Geom::Pnt& P) const;
    double distance(const Geom::Lin& L) const;
    double distance(const Pln& Other) const;

    double squareDistance(const Geom::Pnt& P) const;

    double squareDistance(const Geom::Lin& L) const;

    double squareDistance(const Pln& Other) const;
    Geom::Ax1 xAxis() const;
    Geom::Ax1 yAxis() const;
    bool contains(const Geom::Pnt& P, const double LinearTolerance) const;
    bool contains(const Geom::Lin& L, const double LinearTolerance, const double AngularTolerance) const;


    void mirror(const Geom::Pnt& P);


    Pln mirrored(const Geom::Pnt& P) const;


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

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


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

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

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

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

    void scale(const Geom::Pnt& P, const double S);

    Pln scaled(const Geom::Pnt& P, const double S) const;

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

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

    void translate(const Geom::Vec& V);

    Pln translated(const Geom::Vec& V) const;

    void translate(const Geom::Pnt& P1, const Geom::Pnt& P2);

    Pln translated(const Geom::Pnt& P1, const Geom::Pnt& P2) const;

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


private:
    Geom::Ax3 pos;
};

}  // namespace Geom