Pnt2d.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/XY.h>

namespace Geom
{
class Ax2d;
class Trsf2d;
class Vec2d;

class GEOM_EXPORT Pnt2d
{
public:
    Pnt2d();
    Pnt2d(const XY& Coord);

    Pnt2d(const double Xp, const double Yp);

    XY& changeCoord();
    const XY& coord() const;

    double coord(const int Index) const;
    void coord(double& Xp, double& Yp) const;
    double distance(const Pnt2d& Other) const;
    bool isEqual(const Pnt2d& Other, const double LinearTolerance) const;
    void mirror(const Pnt2d& P);

    Pnt2d mirrored(const Pnt2d& P) const;

    void mirror(const Ax2d& A);

    Pnt2d mirrored(const Ax2d& A) const;

    void rotate(const Pnt2d& P, const double Ang);
    Pnt2d rotated(const Pnt2d& P, const double Ang) const;

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

    void setCoord(const int Index, const double Xi);
    void setCoord(const double Xp, const double Yp);
    void setX(const double X);
    void setXY(const XY& Coord);

    void setY(const double Y);
    double squareDistance(const Pnt2d& Other) const;

    void transform(const Trsf2d& T);
    //
    Pnt2d transformed(const Trsf2d& T) const;

    void translate(const Vec2d& V);
    //
    Pnt2d translated(const Vec2d& V) const;

    void translate(const Pnt2d& P1, const Pnt2d& P2);

    Pnt2d translated(const Pnt2d& P1, const Pnt2d& P2) const;

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

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

protected:
private:
    XY _coord;
};

}  // namespace Geom