SHAPER 9.16.0
CollectionAPI_Group.h
1// Copyright (C) 2014-2026 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_Group_H_
21#define CollectionAPI_Group_H_
22
23#include "CollectionAPI.h"
24
25#include <CollectionPlugin_Group.h>
26
27#include <ModelHighAPI_Interface.h>
28#include <ModelHighAPI_Macro.h>
29
32
37{
38public:
40 COLLECTIONAPI_EXPORT
41 explicit CollectionAPI_Group(const std::shared_ptr<ModelAPI_Feature>& theFeature);
42
44 COLLECTIONAPI_EXPORT
45 CollectionAPI_Group(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46 const std::list<ModelHighAPI_Selection>& theGroupList);
47
49 COLLECTIONAPI_EXPORT
50 virtual ~CollectionAPI_Group();
51
52 INTERFACE_1(CollectionPlugin_Group::ID(),
55
56
57 COLLECTIONAPI_EXPORT
58 void setGroupList(const std::list<ModelHighAPI_Selection>& theGroupList);
59
61 COLLECTIONAPI_EXPORT
62 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
63
64 private:
65 // Check the content of the selection attributes inside the filters
66 bool isFiltersSelectionEmpty() const;
67};
68
70typedef std::shared_ptr<CollectionAPI_Group> GroupPtr;
71
74COLLECTIONAPI_EXPORT
75GroupPtr addGroup(const std::shared_ptr<ModelAPI_Document>& thePart,
76 const std::list<ModelHighAPI_Selection>& theGroupList,
77 const bool theShareSameTopology = false);
78
81COLLECTIONAPI_EXPORT
82GroupPtr addGroup(const std::shared_ptr<ModelAPI_Document>& thePart,
83 const std::string& theSelectionType,
84 const std::list<ModelHighAPI_Selection>& theGroupList,
85 const bool theShareSameTopology = false);
86
87#endif // CollectionAPI_Group_H_
Interface for Group feature.
Definition: CollectionAPI_Group.h:37
void setGroupList(const std::list< ModelHighAPI_Selection > &theGroupList)
Set main objects.
Definition: CollectionAPI_Group.cpp:55
virtual ~CollectionAPI_Group()
Destructor.
Definition: CollectionAPI_Group.cpp:49
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: CollectionAPI_Group.cpp:103
CollectionAPI_Group(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: CollectionAPI_Group.cpp:32
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > groupList() const
Group list.
Definition: CollectionAPI_Group.h:54
static const std::string & LIST_ID()
attribute name of selected entities list
Definition: CollectionPlugin_Group.h:44
static const std::string & ID()
Extrusion kind.
Definition: CollectionPlugin_Group.h:38
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:53
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:46
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
GroupPtr addGroup(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theGroupList, const bool theShareSameTopology=false)
Create Group feature.
Definition: CollectionAPI_Group.cpp:120