SHAPER  9.12.0
FeaturesAPI_RemoveSubShapes.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 
32 
37 {
38 public:
40  FEATURESAPI_EXPORT
41  explicit FeaturesAPI_RemoveSubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature);
42 
44  FEATURESAPI_EXPORT
45  explicit FeaturesAPI_RemoveSubShapes(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46  const ModelHighAPI_Selection& theBase);
47 
49  FEATURESAPI_EXPORT
51 
61 
62 
63  FEATURESAPI_EXPORT
64  void setBase(const ModelHighAPI_Selection& theBase);
65 
67  FEATURESAPI_EXPORT
68  void setSubShapesToKeep(const std::list<ModelHighAPI_Selection>& theSubShapes);
69 
71  FEATURESAPI_EXPORT
72  void setSubShapesToRemove(const std::list<ModelHighAPI_Selection>& theSubShapes);
73 
75  FEATURESAPI_EXPORT
76  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
77 };
78 
80 typedef std::shared_ptr<FeaturesAPI_RemoveSubShapes> RemoveSubShapesPtr;
81 
84 FEATURESAPI_EXPORT
85 RemoveSubShapesPtr addRemoveSubShapes(const std::shared_ptr<ModelAPI_Document>& thePart,
86  const ModelHighAPI_Selection& theBase);
87 
88 #endif // FeaturesAPI_RemoveSubShapes_H_
Interface for RemoveSubShapes feature.
Definition: FeaturesAPI_RemoveSubShapes.h:37
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > subshapesToRemove() const
Subshapes to remove.
Definition: FeaturesAPI_RemoveSubShapes.h:60
virtual std::shared_ptr< ModelAPI_AttributeString > creationMethod() const
Creation method.
Definition: FeaturesAPI_RemoveSubShapes.h:60
virtual ~FeaturesAPI_RemoveSubShapes()
Destructor.
Definition: FeaturesAPI_RemoveSubShapes.cpp:47
void setSubShapesToKeep(const std::list< ModelHighAPI_Selection > &theSubShapes)
Modify tools attribute of the feature.
Definition: FeaturesAPI_RemoveSubShapes.cpp:61
virtual std::shared_ptr< ModelAPI_AttributeSelection > base() const
Base.
Definition: FeaturesAPI_RemoveSubShapes.h:60
FeaturesAPI_RemoveSubShapes(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_RemoveSubShapes.cpp:26
void setSubShapesToRemove(const std::list< ModelHighAPI_Selection > &theSubShapes)
Modify tools attribute of the feature.
Definition: FeaturesAPI_RemoveSubShapes.cpp:72
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > subshapesToKeep() const
Subshapes to keep.
Definition: FeaturesAPI_RemoveSubShapes.h:60
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_RemoveSubShapes.cpp:83
void setBase(const ModelHighAPI_Selection &theBase)
Modify objects attribute of the feature.
Definition: FeaturesAPI_RemoveSubShapes.cpp:53
static const std::string & SUBSHAPES_TO_REMOVE_ID()
Attribute name of sub-shapes to remove.
Definition: FeaturesPlugin_RemoveSubShapes.h:79
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_RemoveSubShapes.h:37
static const std::string & BASE_SHAPE_ID()
Attribute name of base shape.
Definition: FeaturesPlugin_RemoveSubShapes.h:44
static const std::string & SUBSHAPES_TO_KEEP_ID()
Attribute name of sub-shapes to keep.
Definition: FeaturesPlugin_RemoveSubShapes.h:72
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: FeaturesPlugin_RemoveSubShapes.h:51
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37
Attribute that contains reference to the sub-shape of some result, the selected shape.
Definition: ModelAPI_AttributeSelection.h:35
API for the attribute that contains std (null terminated) string.
Definition: ModelAPI_AttributeString.h:33
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
RemoveSubShapesPtr addRemoveSubShapes(const std::shared_ptr< ModelAPI_Document > &thePart, const ModelHighAPI_Selection &theBase)
Create RemoveSubShapes feature.
Definition: FeaturesAPI_RemoveSubShapes.cpp:116