1 // Copyright (C) 2014-2021 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef FeaturesAPI_RemoveSubShapes_H_
21 #define FeaturesAPI_RemoveSubShapes_H_
23 #include "FeaturesAPI.h"
25 #include <FeaturesPlugin_RemoveSubShapes.h>
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
30 class ModelHighAPI_Dumper;
31 class ModelHighAPI_Selection;
33 /// \class FeaturesAPI_RemoveSubShapes
34 /// \ingroup CPPHighAPI
35 /// \brief Interface for RemoveSubShapes feature.
36 class FeaturesAPI_RemoveSubShapes: public ModelHighAPI_Interface
39 /// Constructor without values.
41 explicit FeaturesAPI_RemoveSubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 /// Constructor with values.
45 explicit FeaturesAPI_RemoveSubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46 const ModelHighAPI_Selection& theBase);
50 virtual ~FeaturesAPI_RemoveSubShapes();
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*/)
62 /// Modify objects attribute of the feature.
64 void setBase(const ModelHighAPI_Selection& theBase);
66 /// Modify tools attribute of the feature.
68 void setSubShapesToKeep(const std::list<ModelHighAPI_Selection>& theSubShapes);
70 /// Modify tools attribute of the feature.
72 void setSubShapesToRemove(const std::list<ModelHighAPI_Selection>& theSubShapes);
74 /// Dump wrapped feature
76 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
79 /// Pointer on RemoveSubShapes object.
80 typedef std::shared_ptr<FeaturesAPI_RemoveSubShapes> RemoveSubShapesPtr;
82 /// \ingroup CPPHighAPI
83 /// \brief Create RemoveSubShapes feature.
85 RemoveSubShapesPtr addRemoveSubShapes(const std::shared_ptr<ModelAPI_Document>& thePart,
86 const ModelHighAPI_Selection& theBase);
88 #endif // FeaturesAPI_RemoveSubShapes_H_