src/BuildAPI/BuildAPI_Vertex.h

   1 // Copyright (C) 2014-2023  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 BuildAPI_Vertex_H_
  21 #define BuildAPI_Vertex_H_
  22
  23 #include "BuildAPI.h"
  24
  25 #include <BuildPlugin_Vertex.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Selection;
  31
  32 /// \class BuildAPI_Vertex
  33 /// \ingroup CPPHighAPI
  34 /// \brief Interface for Vertex feature.
  35 class BuildAPI_Vertex: public ModelHighAPI_Interface
  36 {
  37 public:
  38   /// Constructor without values.
  39   BUILDAPI_EXPORT
  40   explicit BuildAPI_Vertex(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  41
  42   /// Constructor with values.
  43   BUILDAPI_EXPORT
  44   explicit BuildAPI_Vertex(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  45                            const std::list<ModelHighAPI_Selection>& theBaseObjects);
  46
  47   /// Constructor with values.
  48   BUILDAPI_EXPORT
  49   explicit BuildAPI_Vertex(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  50                            const std::list<ModelHighAPI_Selection>& theBaseObjects,
  51                            const bool theDoIntersect);
  52
  53   /// Destructor.
  54   BUILDAPI_EXPORT
  55   virtual ~BuildAPI_Vertex();
  56
  57   INTERFACE_2(BuildPlugin_Vertex::ID(),
  58               baseObjects, BuildPlugin_Vertex::BASE_OBJECTS_ID(),
  59               ModelAPI_AttributeSelectionList, /** Base objects */,
  60               doIntersect, BuildPlugin_Vertex::INTERSECT_ID(),
  61               ModelAPI_AttributeBoolean, /** Compute intersections */)
  62
  63   /// Modify base attribute of the feature.
  64   BUILDAPI_EXPORT
  65   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
  66
  67   /// Dump wrapped feature
  68   BUILDAPI_EXPORT
  69   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  70 };
  71
  72 /// Pointer on Vertex object.
  73 typedef std::shared_ptr<BuildAPI_Vertex> VertexPtr;
  74
  75 /// \ingroup CPPHighAPI
  76 /// \brief Create Vertex feature.
  77 BUILDAPI_EXPORT
  78 VertexPtr addVertex(const std::shared_ptr<ModelAPI_Document>& thePart,
  79                     const std::list<ModelHighAPI_Selection>& theBaseObjects);
  80
  81 /// \ingroup CPPHighAPI
  82 /// \brief Create Vertex feature.
  83 BUILDAPI_EXPORT
  84 VertexPtr addVertex(const std::shared_ptr<ModelAPI_Document>& thePart,
  85                     const std::list<ModelHighAPI_Selection>& theBaseObjects,
  86                     const bool theDoIntersect);
  87
  88 #endif // BuildAPI_Vertex_H_