src/BuildAPI/BuildAPI_SubShapes.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_SubShapes_H_
  22 #define BuildAPI_SubShapes_H_
  23
  24 #include "BuildAPI.h"
  25
  26 #include <BuildPlugin_SubShapes.h>
  27
  28 #include <ModelHighAPI_Interface.h>
  29 #include <ModelHighAPI_Macro.h>
  30
  31 class ModelHighAPI_Selection;
  32
  33 /// \class BuildAPI_SubShapes
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for SubShapes feature.
  36 class BuildAPI_SubShapes: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   BUILDAPI_EXPORT
  41   explicit BuildAPI_SubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43   /// Constructor with values.
  44   BUILDAPI_EXPORT
  45   explicit BuildAPI_SubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                               const ModelHighAPI_Selection& theBaseShape,
  47                               const std::list<ModelHighAPI_Selection>& theSubShapes);
  48
  49   /// Destructor.
  50   BUILDAPI_EXPORT
  51   virtual ~BuildAPI_SubShapes();
  52
  53   INTERFACE_2(BuildPlugin_SubShapes::ID(),
  54               baseShape, BuildPlugin_SubShapes::BASE_SHAPE_ID(),
  55               ModelAPI_AttributeSelection, /** Base shape */,
  56               subShapes, BuildPlugin_SubShapes::SUBSHAPES_ID(),
  57               ModelAPI_AttributeSelectionList, /** Sub-shapes */)
  58
  59   /// Modify base attribute of the feature.
  60   BUILDAPI_EXPORT
  61   void setBaseShape(const ModelHighAPI_Selection& theBaseShape);
  62
  63   /// Modify sub-shapes attribute of the feature.
  64   BUILDAPI_EXPORT
  65   void setSubShapes(const std::list<ModelHighAPI_Selection>& theSubShapes);
  66
  67   /// Dump wrapped feature
  68   BUILDAPI_EXPORT
  69   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  70 };
  71
  72 /// Pointer on SubShapes object.
  73 typedef std::shared_ptr<BuildAPI_SubShapes> SubShapesPtr;
  74
  75 /// \ingroup CPPHighAPI
  76 /// \brief Create SubShapes feature.
  77 BUILDAPI_EXPORT
  78 SubShapesPtr addSubShapes(const std::shared_ptr<ModelAPI_Document>& thePart,
  79                           const ModelHighAPI_Selection& theBaseShape,
  80                           const std::list<ModelHighAPI_Selection>& theSubShapes);
  81
  82 #endif // BuildAPI_SubShapes_H_