SHAPER  9.12.0
CollectionAPI_GroupSubstraction.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 CollectionAPI_GroupSubstraction_H_
21 #define CollectionAPI_GroupSubstraction_H_
22 
23 #include "CollectionAPI.h"
24 
25 #include <CollectionPlugin_GroupSubstraction.h>
26 
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 
32 
37 {
38 public:
40  COLLECTIONAPI_EXPORT
41  explicit CollectionAPI_GroupSubstraction(const std::shared_ptr<ModelAPI_Feature>& theFeature);
42 
44  COLLECTIONAPI_EXPORT
45  CollectionAPI_GroupSubstraction(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46  const std::list<ModelHighAPI_Selection>& theObjectsList,
47  const std::list<ModelHighAPI_Selection>& theToolsList);
48 
50  COLLECTIONAPI_EXPORT
52 
58 
59 
60  COLLECTIONAPI_EXPORT
61  void setObjectsList(const std::list<ModelHighAPI_Selection>& theGroupList);
62 
64  COLLECTIONAPI_EXPORT
65  void setToolsList(const std::list<ModelHighAPI_Selection>& theGroupList);
66 
68  COLLECTIONAPI_EXPORT
69  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
70 };
71 
73 typedef std::shared_ptr<CollectionAPI_GroupSubstraction> GroupSubstractionPtr;
74 
77 COLLECTIONAPI_EXPORT
78 GroupSubstractionPtr addGroupSubstraction(const std::shared_ptr<ModelAPI_Document>& thePart,
79  const std::list<ModelHighAPI_Selection>& theObjectsList,
80  const std::list<ModelHighAPI_Selection>& theToolsList);
81 
82 #endif // CollectionAPI_GroupSubstraction_H_
Interface for Group Intersection feature.
Definition: CollectionAPI_GroupSubstraction.h:37
void setToolsList(const std::list< ModelHighAPI_Selection > &theGroupList)
Set tools.
Definition: CollectionAPI_GroupSubstraction.cpp:55
CollectionAPI_GroupSubstraction(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: CollectionAPI_GroupSubstraction.cpp:25
void setObjectsList(const std::list< ModelHighAPI_Selection > &theGroupList)
Set main objects.
Definition: CollectionAPI_GroupSubstraction.cpp:48
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: CollectionAPI_GroupSubstraction.cpp:62
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > objectsList() const
Objects list.
Definition: CollectionAPI_GroupSubstraction.h:57
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > toolsList() const
Tools list.
Definition: CollectionAPI_GroupSubstraction.h:57
virtual ~CollectionAPI_GroupSubstraction()
Destructor.
Definition: CollectionAPI_GroupSubstraction.cpp:44
static const std::string & TOOLS_ID()
attribute name of selected tools list
Definition: CollectionPlugin_GroupSubstraction.h:46
static const std::string & LIST_ID()
attribute name of selected objects list
Definition: CollectionPlugin_GroupSubstraction.h:40
static const std::string & ID()
Extrusion kind.
Definition: CollectionPlugin_GroupSubstraction.h:34
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37
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
GroupSubstractionPtr addGroupSubstraction(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theObjectsList, const std::list< ModelHighAPI_Selection > &theToolsList)
Create Group Substraction feature.
Definition: CollectionAPI_GroupSubstraction.cpp:76