src/GeomAPI/GeomAPI_Vertex.h

   1 // Copyright (C) 2014-2024  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_Vertex_H_
  21 #define GeomAPI_Vertex_H_
  22
  23 #include <GeomAPI_Shape.h>
  24
  25 class GeomAPI_Pnt;
  26
  27 /// \class GeomAPI_Vertex
  28 /// \ingroup DataModel
  29 /// \brief Interface to the vertex object.
  30 class GeomAPI_Vertex: public GeomAPI_Shape
  31 {
  32 public:
  33   /// Creation of empty (null) shape.
  34   GEOMAPI_EXPORT
  35   GeomAPI_Vertex();
  36
  37    /// Creation of vertex by the vertex-shape.
  38   GEOMAPI_EXPORT
  39   GeomAPI_Vertex(const std::shared_ptr<GeomAPI_Shape>& theShape);
  40
  41   /// Creation of vertex by the given point.
  42   GEOMAPI_EXPORT
  43   GeomAPI_Vertex(const std::shared_ptr<GeomAPI_Pnt>& thePoint);
  44
  45    /// Creation of vertex by 3d coordinates.
  46   GEOMAPI_EXPORT
  47   GeomAPI_Vertex(double theX, double theY, double theZ);
  48
  49   /// Returns the first vertex coordinates of the edge.
  50   GEOMAPI_EXPORT
  51   std::shared_ptr<GeomAPI_Pnt> point();
  52
  53   /// Returns true if the current edge is geometrically equal to the given edge.
  54   GEOMAPI_EXPORT
  55   virtual bool isEqual(const std::shared_ptr<GeomAPI_Shape> theVert) const;
  56
  57 public:
  58   /// \brief Compare vertices geometrically
  59   class GeometricComparator
  60   {
  61   public:
  62     GEOMAPI_EXPORT
  63     GeometricComparator(const double theTolerance = 1.e-7) : myTolerance(theTolerance)
  64     {}
  65
  66     /// Return \c true if the first vertex is less than the second
  67     GEOMAPI_EXPORT
  68     bool operator ()(const std::shared_ptr<GeomAPI_Vertex>& theVertex1,
  69                      const std::shared_ptr<GeomAPI_Vertex>& theVertex2) const;
  70   private:
  71     double myTolerance;
  72   };
  73
  74 };
  75
  76 //! Pointer on the object
  77 typedef std::shared_ptr<GeomAPI_Vertex> GeomVertexPtr;
  78
  79 #endif
  80