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

namespace Geom
{
class Ax1;
class Ax2;
class Trsf;
class Vec;
class Pnt;
}  // namespace Geom

typedef std::vector<Geom::Pnt> PNTS;


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

    Pnt();
    Pnt(const Geom::XYZ& Coord);

    Pnt(const double Xp, const double Yp, const double Zp = .0);

    Pnt(const Pnt& rhs);

    static Pnt ZeroPnt() { return Pnt(0, 0, 0); };

    void setCoord(const int Index, const double Xi);
    void setCoord(const double Xp, const double Yp, const double Zp = .0);
    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& Xp, double& Yp, double& Zp) const;
    double x() const;
    double y() const;
    double z() const;
    const Geom::XYZ& xyz() const;
    const Geom::XYZ& coord() const;

    Geom::XYZ& changeCoord();
    void baryCenter(const double Alpha, const Pnt& P, const double Beta);
    bool isEqual(const Pnt& Other, const double LinearTolerance) const;
    double distance(const Pnt& Other) const;
    double squareDistance(const Pnt& Other) const;


    void mirror(const Pnt& P);


    Pnt mirrored(const Pnt& P) const;


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


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


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


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

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

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


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

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

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

    bool operator==(const Geom::Pnt& other) const;
    bool operator!=(const Geom::Pnt& other) const;

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

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

    Pnt operator-(const Geom::Pnt& other) const;
    Pnt operator+(const Geom::Pnt& other) const;
    Pnt operator*(const Geom::Pnt& other) const;
    Pnt operator*(double scalar) const;

    bool operator<(const Geom::Pnt& rhs) const;

private:
    Geom::XYZ _coord;
};

}  // namespace Geom