SHAPER  9.12.0
GeomAPI_Pnt2d.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 
36 {
37  public:
39  GEOMAPI_EXPORT
40  GeomAPI_Pnt2d(const double theX, const double theY);
42  GEOMAPI_EXPORT
43  GeomAPI_Pnt2d(const std::shared_ptr<GeomAPI_XY>& theCoords);
44 
46  GEOMAPI_EXPORT
47  double x() const;
49  GEOMAPI_EXPORT
50  double y() const;
51 
53  GEOMAPI_EXPORT
54  void setX(const double theX);
56  GEOMAPI_EXPORT
57  void setY(const double theY);
58 
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 
66  GEOMAPI_EXPORT
67  const std::shared_ptr<GeomAPI_XY> xy();
68 
70  GEOMAPI_EXPORT
71  double distance(const std::shared_ptr<GeomAPI_Pnt2d>& theOther) const;
72 
74  GEOMAPI_EXPORT
75  bool isEqual(const std::shared_ptr<GeomAPI_Pnt2d>& theOther) const;
76 };
77 
79 typedef std::shared_ptr<GeomAPI_Pnt2d> GeomPnt2dPtr;
80 
81 #endif
82 
3D direction defined by three normalized coordinates
Definition: GeomAPI_Dir.h:34
General base class for all interfaces in this package.
Definition: GeomAPI_Interface.h:38
2D point defined by two coordinates
Definition: GeomAPI_Pnt2d.h:36
GEOMAPI_EXPORT void setY(const double theY)
sets Y coordinate
Definition: GeomAPI_Pnt2d.cpp:57
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_XY > xy()
returns coordinates of the point
Definition: GeomAPI_Pnt2d.cpp:72
GEOMAPI_EXPORT double x() const
returns X coordinate
Definition: GeomAPI_Pnt2d.cpp:42
GEOMAPI_EXPORT GeomAPI_Pnt2d(const double theX, const double theY)
Creation of point by coordinates.
Definition: GeomAPI_Pnt2d.cpp:32
GEOMAPI_EXPORT void setX(const double theX)
sets X coordinate
Definition: GeomAPI_Pnt2d.cpp:52
GEOMAPI_EXPORT double y() const
returns Y coordinate
Definition: GeomAPI_Pnt2d.cpp:47
GEOMAPI_EXPORT bool isEqual(const std::shared_ptr< GeomAPI_Pnt2d > &theOther) const
Returns whether the distance between two points is less then precision confusion.
Definition: GeomAPI_Pnt2d.cpp:82
GEOMAPI_EXPORT double distance(const std::shared_ptr< GeomAPI_Pnt2d > &theOther) const
Distance between two points.
Definition: GeomAPI_Pnt2d.cpp:77
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt > to3D(const std::shared_ptr< GeomAPI_Pnt > &theOrigin, const std::shared_ptr< GeomAPI_Dir > &theDirX, const std::shared_ptr< GeomAPI_Dir > &theDirY)
Returns the 3D point.
Definition: GeomAPI_Pnt2d.cpp:62
3D point defined by three coordinates
Definition: GeomAPI_Pnt.h:38
2 coordinates: they may represent vector or point or something else
Definition: GeomAPI_XY.h:32