src/CollectionPlugin/CollectionPlugin_Group.h

   1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   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
  27 /**\class CollectionPlugin_Group
  28  * \ingroup Plugins
  29  * \brief Feature for selection of sub-shapes of some shapes.
  30  *
  31  * All selected sub-shapes must be of equal type (vertex, edge, face, etc) but may
  32  * be selected on different objects.
  33  */
  34 class CollectionPlugin_Group : public ModelAPI_Feature
  35 {
  36  public:
  37   /// Extrusion kind
  38   inline static const std::string& ID()
  39   {
  40     static const std::string MY_GROUP_ID("Group");
  41     return MY_GROUP_ID;
  42   }
  43   /// attribute name of selected entities list
  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
  50   /// Returns the kind of a feature
  51   COLLECTIONPLUGIN_EXPORT virtual const std::string& getKind()
  52   {
  53     static std::string MY_KIND = CollectionPlugin_Group::ID();
  54     return MY_KIND;
  55   }
  56
  57   /// Creates a new group result if needed
  58   COLLECTIONPLUGIN_EXPORT virtual void execute();
  59
  60   /// Request for initialization of data model of the feature: adding all attributes
  61   COLLECTIONPLUGIN_EXPORT virtual void initAttributes();
  62
  63   /// Result of groups is created on the fly and don't stored to the document
  64   COLLECTIONPLUGIN_EXPORT virtual bool isPersistentResult() {return true;}
  65
  66   /// Use plugin manager for features creation
  67   CollectionPlugin_Group();
  68
  69   /// Used for the split action of the group (Move to the end and split)
  70   COLLECTIONPLUGIN_EXPORT virtual bool customAction(const std::string& theActionId);
  71 };
  72
  73 #endif