1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef FeaturesAPI_RemoveSubShapes_H_
22 #define FeaturesAPI_RemoveSubShapes_H_
24 #include "FeaturesAPI.h"
26 #include <FeaturesPlugin_RemoveSubShapes.h>
28 #include <ModelHighAPI_Interface.h>
29 #include <ModelHighAPI_Macro.h>
31 class ModelHighAPI_Dumper;
32 class ModelHighAPI_Selection;
34 /// \class FeaturesAPI_RemoveSubShapes
35 /// \ingroup CPPHighAPI
36 /// \brief Interface for RemoveSubShapes feature.
37 class FeaturesAPI_RemoveSubShapes: public ModelHighAPI_Interface
40 /// Constructor without values.
42 explicit FeaturesAPI_RemoveSubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature);
44 /// Constructor with values.
46 explicit FeaturesAPI_RemoveSubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature,
47 const ModelHighAPI_Selection& theBase);
51 virtual ~FeaturesAPI_RemoveSubShapes();
53 INTERFACE_4(FeaturesPlugin_RemoveSubShapes::ID(),
54 base, FeaturesPlugin_RemoveSubShapes::BASE_SHAPE_ID(),
55 ModelAPI_AttributeSelection, /** Base */,
56 creationMethod, FeaturesPlugin_RemoveSubShapes::CREATION_METHOD(),
57 ModelAPI_AttributeString, /** Creation method */,
58 subshapesToKeep, FeaturesPlugin_RemoveSubShapes::SUBSHAPES_TO_KEEP_ID(),
59 ModelAPI_AttributeSelectionList, /** Subshapes to keep*/,
60 subshapesToRemove, FeaturesPlugin_RemoveSubShapes::SUBSHAPES_TO_REMOVE_ID(),
61 ModelAPI_AttributeSelectionList, /** Subshapes to remove*/)
63 /// Modify objects attribute of the feature.
65 void setBase(const ModelHighAPI_Selection& theBase);
67 /// Modify tools attribute of the feature.
69 void setSubShapesToKeep(const std::list<ModelHighAPI_Selection>& theSubShapes);
71 /// Modify tools attribute of the feature.
73 void setSubShapesToRemove(const std::list<ModelHighAPI_Selection>& theSubShapes);
75 /// Dump wrapped feature
77 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
80 /// Pointer on RemoveSubShapes object.
81 typedef std::shared_ptr<FeaturesAPI_RemoveSubShapes> RemoveSubShapesPtr;
83 /// \ingroup CPPHighAPI
84 /// \brief Create RemoveSubShapes feature.
86 RemoveSubShapesPtr addRemoveSubShapes(const std::shared_ptr<ModelAPI_Document>& thePart,
87 const ModelHighAPI_Selection& theBase);
89 #endif // FeaturesAPI_RemoveSubShapes_H_