1 // Copyright (C) 2014-2020 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef GeomAPI_Pnt_H_
21 #define GeomAPI_Pnt_H_
23 #include <GeomAPI_Interface.h>
34 * \brief 3D point defined by three coordinates
37 class GeomAPI_Pnt : public GeomAPI_Interface
40 /// Creation of point by coordinates
42 GeomAPI_Pnt(const double theX, const double theY, const double theZ);
43 /// Creation of point by coordinates
45 GeomAPI_Pnt(const std::shared_ptr<GeomAPI_XYZ>& theCoords);
47 /// returns X coordinate
50 /// returns Y coordinate
53 /// returns Z coordinate
59 void setX(const double theX);
62 void setY(const double theY);
65 void setZ(const double theZ);
67 /// returns coordinates of the point
69 const std::shared_ptr<GeomAPI_XYZ> xyz();
71 /// Distance between two points
73 double distance(const std::shared_ptr<GeomAPI_Pnt>& theOther) const;
75 /// Returns whether the distance between two points is less then precision confusion
77 bool isEqual(const std::shared_ptr<GeomAPI_Pnt>& theOther) const;
79 /// Returns \c true, if the current point is less than theOther.
80 /// The point is less than other, if X coordinate is less.
81 /// In case of X's are equal, if Y is less than other.
82 /// If Y's are equal too, compare Z's.
84 bool isLess(const std::shared_ptr<GeomAPI_Pnt>& theOther) const;
86 /// Projects a point to the plane defined by the origin and 2 axes vectors in this plane
88 std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
89 const std::shared_ptr<GeomAPI_Dir>& theDirX,
90 const std::shared_ptr<GeomAPI_Dir>& theDirY);
92 /// Projects a point to the plane defined by the origin and 2 axes vectors in this plane
94 std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pln>& thePln) const;
96 /// Translates the point along direction theDir on distance theDist
98 void translate(const std::shared_ptr<GeomAPI_Dir>& theDir, double theDist);
100 /// Rotates the point along axis for the given angle (in degrees)
101 GEOMAPI_EXPORT void rotate(const std::shared_ptr<GeomAPI_Ax1>& theAxis, double theAngle);
104 //! Pointer on the object
105 typedef std::shared_ptr<GeomAPI_Pnt> GeomPointPtr;