src/CollectionPlugin/CollectionPlugin_Group.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef COLLECTIONPLUGIN_GROUP_H_
  22 #define COLLECTIONPLUGIN_GROUP_H_
  23
  24 #include "CollectionPlugin.h"
  25 #include <ModelAPI_Feature.h>
  26 #include <GeomAPI_Shape.h>
  27
  28 /**\class CollectionPlugin_Group
  29  * \ingroup Plugins
  30  * \brief Feature for selection of sub-shapes of some shapes.
  31  *
  32  * All selected sub-shapes must be of equal type (vertex, edge, face, etc) but may
  33  * be selected on different objects.
  34  */
  35 class CollectionPlugin_Group : public ModelAPI_Feature
  36 {
  37  public:
  38   /// Extrusion kind
  39   inline static const std::string& ID()
  40   {
  41     static const std::string MY_GROUP_ID("Group");
  42     return MY_GROUP_ID;
  43   }
  44   /// attribute name of selected entities list
  45   inline static const std::string& LIST_ID()
  46   {
  47     static const std::string MY_GROUP_LIST_ID("group_list");
  48     return MY_GROUP_LIST_ID;
  49   }
  50
  51   /// Returns the kind of a feature
  52   COLLECTIONPLUGIN_EXPORT virtual const std::string& getKind()
  53   {
  54     static std::string MY_KIND = CollectionPlugin_Group::ID();
  55     return MY_KIND;
  56   }
  57
  58   /// Creates a new group result if needed
  59   COLLECTIONPLUGIN_EXPORT virtual void execute();
  60
  61   /// Request for initialization of data model of the feature: adding all attributes
  62   COLLECTIONPLUGIN_EXPORT virtual void initAttributes();
  63
  64   /// Result of groups is created on the fly and don't stored to the document
  65   COLLECTIONPLUGIN_EXPORT virtual bool isPersistentResult() {return true;}
  66
  67   /// Use plugin manager for features creation
  68   CollectionPlugin_Group();
  69
  70 };
  71
  72 #endif