]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_Vertex.h
Salome HOME
Fix for the issue #2401
[modules/shaper.git] / src / GeomAPI / GeomAPI_Vertex.h
1 // Copyright (C) 2014-2017  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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef GeomAPI_Vertex_H_
22 #define GeomAPI_Vertex_H_
23
24 #include <GeomAPI_Shape.h>
25
26 class GeomAPI_Pnt;
27
28 /// \class GeomAPI_Vertex
29 /// \ingroup DataModel
30 /// \brief Interface to the vertex object.
31 class GeomAPI_Vertex: public GeomAPI_Shape
32 {
33 public:
34   /// Creation of empty (null) shape.
35   GEOMAPI_EXPORT
36   GeomAPI_Vertex();
37
38    /// Creation of vertex by the vertex-shape.
39   GEOMAPI_EXPORT
40   GeomAPI_Vertex(const std::shared_ptr<GeomAPI_Shape>& theShape);
41
42    /// Creation of vertex by 3d coordinates.
43   GEOMAPI_EXPORT
44   GeomAPI_Vertex(double theX, double theY, double theZ);
45
46   /// Returns the first vertex coordinates of the edge.
47   GEOMAPI_EXPORT
48   std::shared_ptr<GeomAPI_Pnt> point();
49
50   /// Returns true if the current edge is geometrically equal to the given edge.
51   GEOMAPI_EXPORT
52   bool isEqual(const std::shared_ptr<GeomAPI_Shape> theVert) const;
53 };
54
55 //! Pointer on the object
56 typedef std::shared_ptr<GeomAPI_Vertex> GeomVertexPtr;
57
58 #endif
59