src/FeaturesAPI/FeaturesAPI_RemoveSubShapes.h

   1 // Copyright (C) 2014-2019  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 FeaturesAPI_RemoveSubShapes_H_
  21 #define FeaturesAPI_RemoveSubShapes_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_RemoveSubShapes.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Dumper;
  31 class ModelHighAPI_Selection;
  32
  33 /// \class FeaturesAPI_RemoveSubShapes
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for RemoveSubShapes feature.
  36 class FeaturesAPI_RemoveSubShapes: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   FEATURESAPI_EXPORT
  41   explicit FeaturesAPI_RemoveSubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43   /// Constructor with values.
  44   FEATURESAPI_EXPORT
  45   explicit FeaturesAPI_RemoveSubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                                        const ModelHighAPI_Selection& theBase);
  47
  48   /// Destructor.
  49   FEATURESAPI_EXPORT
  50   virtual ~FeaturesAPI_RemoveSubShapes();
  51
  52   INTERFACE_4(FeaturesPlugin_RemoveSubShapes::ID(),
  53               base, FeaturesPlugin_RemoveSubShapes::BASE_SHAPE_ID(),
  54               ModelAPI_AttributeSelection, /** Base */,
  55               creationMethod, FeaturesPlugin_RemoveSubShapes::CREATION_METHOD(),
  56               ModelAPI_AttributeString, /** Creation method */,
  57               subshapesToKeep, FeaturesPlugin_RemoveSubShapes::SUBSHAPES_TO_KEEP_ID(),
  58               ModelAPI_AttributeSelectionList, /** Subshapes to keep*/,
  59               subshapesToRemove, FeaturesPlugin_RemoveSubShapes::SUBSHAPES_TO_REMOVE_ID(),
  60               ModelAPI_AttributeSelectionList, /** Subshapes to remove*/)
  61
  62   /// Modify objects attribute of the feature.
  63   FEATURESAPI_EXPORT
  64   void setBase(const ModelHighAPI_Selection& theBase);
  65
  66   /// Modify tools attribute of the feature.
  67   FEATURESAPI_EXPORT
  68   void setSubShapesToKeep(const std::list<ModelHighAPI_Selection>& theSubShapes);
  69
  70   /// Modify tools attribute of the feature.
  71   FEATURESAPI_EXPORT
  72   void setSubShapesToRemove(const std::list<ModelHighAPI_Selection>& theSubShapes);
  73
  74   /// Dump wrapped feature
  75   FEATURESAPI_EXPORT
  76   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  77 };
  78
  79 /// Pointer on RemoveSubShapes object.
  80 typedef std::shared_ptr<FeaturesAPI_RemoveSubShapes> RemoveSubShapesPtr;
  81
  82 /// \ingroup CPPHighAPI
  83 /// \brief Create RemoveSubShapes feature.
  84 FEATURESAPI_EXPORT
  85 RemoveSubShapesPtr addRemoveSubShapes(const std::shared_ptr<ModelAPI_Document>& thePart,
  86                                       const ModelHighAPI_Selection& theBase);
  87
  88 #endif // FeaturesAPI_RemoveSubShapes_H_