src/BuildAPI/BuildAPI_Polyline.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 BuildAPI_Polyline_H_
  21 #define BuildAPI_Polyline_H_
  22
  23 #include "BuildAPI.h"
  24
  25 #include <BuildPlugin_Polyline.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Selection;
  31
  32 /// \class BuildAPI_Polyline
  33 /// \ingroup CPPHighAPI
  34 /// \brief Interface for Polyline feature.
  35 class BuildAPI_Polyline: public ModelHighAPI_Interface
  36 {
  37 public:
  38   /// Constructor without values.
  39   BUILDAPI_EXPORT
  40     explicit BuildAPI_Polyline(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  41
  42   /// Constructor with values.
  43   BUILDAPI_EXPORT
  44   explicit BuildAPI_Polyline(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  45                              const std::list<ModelHighAPI_Selection>& theBaseObjects,
  46                              const bool theIsClosed);
  47
  48   /// Destructor.
  49   BUILDAPI_EXPORT
  50   virtual ~BuildAPI_Polyline();
  51
  52   INTERFACE_2(BuildPlugin_Polyline::ID(),
  53               baseObjects, BuildPlugin_Polyline::BASE_OBJECTS_ID(),
  54               ModelAPI_AttributeSelectionList, /** Base objects */,
  55               closed, BuildPlugin_Polyline::CLOSED_ID(),
  56               ModelAPI_AttributeBoolean, /** Closed flag */)
  57
  58   /// Modify base attribute of the feature.
  59   BUILDAPI_EXPORT
  60   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
  61
  62   /// Set closed flag
  63   BUILDAPI_EXPORT void setClosed(const bool theIsClosed);
  64
  65   /// Dump wrapped feature
  66   BUILDAPI_EXPORT
  67   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  68 };
  69
  70 /// Pointer on Polyline object.
  71 typedef std::shared_ptr<BuildAPI_Polyline> PolylinePtr;
  72
  73 /// \ingroup CPPHighAPI
  74 /// \brief Create Polyline feature.
  75 BUILDAPI_EXPORT
  76 PolylinePtr addPolyline3D(const std::shared_ptr<ModelAPI_Document>& thePart,
  77                           const std::list<ModelHighAPI_Selection>& theBaseObjects,
  78                           const bool theIsClosed = false);
  79
  80 #endif // BuildAPI_Polyline_H_