]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_Pnt2d.h
Salome HOME
Improve code coverage for elliptic arcs.
[modules/shaper.git] / src / GeomAPI / GeomAPI_Pnt2d.h
1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef GeomAPI_Pnt2d_H_
21 #define GeomAPI_Pnt2d_H_
22
23 #include <GeomAPI_Interface.h>
24 #include <memory>
25
26 class GeomAPI_XY;
27 class GeomAPI_Pnt;
28 class GeomAPI_Dir;
29
30 /**\class GeomAPI_Pnt2d
31  * \ingroup DataModel
32  * \brief 2D point defined by two coordinates
33  */
34
35 class GeomAPI_Pnt2d : public GeomAPI_Interface
36 {
37  public:
38   /// Creation of point by coordinates
39   GEOMAPI_EXPORT
40   GeomAPI_Pnt2d(const double theX, const double theY);
41   /// Creation of point by coordinates
42   GEOMAPI_EXPORT
43   GeomAPI_Pnt2d(const std::shared_ptr<GeomAPI_XY>& theCoords);
44
45   /// returns X coordinate
46   GEOMAPI_EXPORT
47   double x() const;
48   /// returns Y coordinate
49   GEOMAPI_EXPORT
50   double y() const;
51
52   /// sets X coordinate
53   GEOMAPI_EXPORT
54   void setX(const double theX);
55   /// sets Y coordinate
56   GEOMAPI_EXPORT
57   void setY(const double theY);
58
59   /// Returns the 3D point
60   GEOMAPI_EXPORT
61   std::shared_ptr<GeomAPI_Pnt> to3D(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
62                                       const std::shared_ptr<GeomAPI_Dir>& theDirX,
63                                       const std::shared_ptr<GeomAPI_Dir>& theDirY);
64
65   /// returns coordinates of the point
66   GEOMAPI_EXPORT
67   const std::shared_ptr<GeomAPI_XY> xy();
68
69   /// Distance between two points
70   GEOMAPI_EXPORT
71   double distance(const std::shared_ptr<GeomAPI_Pnt2d>& theOther) const;
72
73   /// Returns whether the distance between two points is less then precision confusion
74   GEOMAPI_EXPORT
75   bool isEqual(const std::shared_ptr<GeomAPI_Pnt2d>& theOther) const;
76 };
77
78 //! Pointer on the object
79 typedef std::shared_ptr<GeomAPI_Pnt2d> GeomPnt2dPtr;
80
81 #endif
82