SHAPER  9.12.0
CollectionPlugin_Group.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 COLLECTIONPLUGIN_GROUP_H_
21 #define COLLECTIONPLUGIN_GROUP_H_
22 
23 #include "CollectionPlugin.h"
24 #include <ModelAPI_Feature.h>
25 #include <GeomAPI_Shape.h>
26 
35 {
36  public:
38  inline static const std::string& ID()
39  {
40  static const std::string MY_GROUP_ID("Group");
41  return MY_GROUP_ID;
42  }
44  inline static const std::string& LIST_ID()
45  {
46  static const std::string MY_GROUP_LIST_ID("group_list");
47  return MY_GROUP_LIST_ID;
48  }
49 
51  COLLECTIONPLUGIN_EXPORT virtual const std::string& getKind()
52  {
53  static std::string MY_KIND = CollectionPlugin_Group::ID();
54  return MY_KIND;
55  }
56 
58  COLLECTIONPLUGIN_EXPORT virtual void execute();
59 
61  COLLECTIONPLUGIN_EXPORT virtual void initAttributes();
62 
64  COLLECTIONPLUGIN_EXPORT virtual bool isPersistentResult() {return true;}
65 
68 
70  COLLECTIONPLUGIN_EXPORT virtual bool customAction(const std::string& theActionId);
71 };
72 
73 #endif
Feature for selection of sub-shapes of some shapes.
Definition: CollectionPlugin_Group.h:35
virtual bool isPersistentResult()
Result of groups is created on the fly and don't stored to the document.
Definition: CollectionPlugin_Group.h:64
virtual bool customAction(const std::string &theActionId)
Used for the split action of the group (Move to the end and split)
Definition: CollectionPlugin_Group.cpp:80
CollectionPlugin_Group()
Use plugin manager for features creation.
Definition: CollectionPlugin_Group.cpp:32
virtual const std::string & getKind()
Returns the kind of a feature.
Definition: CollectionPlugin_Group.h:51
static const std::string & ID()
Extrusion kind.
Definition: CollectionPlugin_Group.h:38
static const std::string & LIST_ID()
attribute name of selected entities list
Definition: CollectionPlugin_Group.h:44
virtual void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: CollectionPlugin_Group.cpp:36
virtual void execute()
Creates a new group result if needed.
Definition: CollectionPlugin_Group.cpp:43
Feature function that represents the particular functionality of this operation.
Definition: ModelAPI_Feature.h:39