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