src/BuildAPI/BuildAPI_Vertex.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        BuildAPI_Vertex.h
   4 // Created:     09 June 2016
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef BuildAPI_Vertex_H_
   8 #define BuildAPI_Vertex_H_
   9
  10 #include "BuildAPI.h"
  11
  12 #include <BuildPlugin_Vertex.h>
  13
  14 #include <ModelHighAPI_Interface.h>
  15 #include <ModelHighAPI_Macro.h>
  16
  17 class ModelHighAPI_Selection;
  18
  19 /// \class BuildAPI_Vertex
  20 /// \ingroup CPPHighAPI
  21 /// \brief Interface for Vertex feature.
  22 class BuildAPI_Vertex: public ModelHighAPI_Interface
  23 {
  24 public:
  25   /// Constructor without values.
  26   BUILDAPI_EXPORT
  27   explicit BuildAPI_Vertex(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  28
  29   /// Constructor with values.
  30   BUILDAPI_EXPORT
  31   explicit BuildAPI_Vertex(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  32                            const std::list<ModelHighAPI_Selection>& theBaseObjects);
  33
  34   /// Destructor.
  35   BUILDAPI_EXPORT
  36   virtual ~BuildAPI_Vertex();
  37
  38   INTERFACE_1(BuildPlugin_Vertex::ID(),
  39               baseObjects, BuildPlugin_Vertex::BASE_OBJECTS_ID(), ModelAPI_AttributeSelectionList, /** Base objects */)
  40
  41   /// Modify base attribute of the feature.
  42   BUILDAPI_EXPORT
  43   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
  44
  45   /// Dump wrapped feature
  46   BUILDAPI_EXPORT
  47   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  48 };
  49
  50 /// Pointer on Vertex object.
  51 typedef std::shared_ptr<BuildAPI_Vertex> VertexPtr;
  52
  53 /// \ingroup CPPHighAPI
  54 /// \brief Create Vertex feature.
  55 BUILDAPI_EXPORT
  56 VertexPtr addVertex(const std::shared_ptr<ModelAPI_Document>& thePart,
  57                     const std::list<ModelHighAPI_Selection>& theBaseObjects);
  58
  59 #endif // BuildAPI_Vertex_H_