src/FeaturesPlugin/FeaturesPlugin_GroupSharedFaces.h

   1 // Copyright (C) 2018-2021  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 FeaturesPlugin_GroupSharedFaces_H_
  21 #define FeaturesPlugin_GroupSharedFaces_H_
  22
  23 #include <FeaturesPlugin_CommonSharedFaces.h>
  24
  25 /// \class FeaturesPlugin_GroupSharedFaces
  26 /// \ingroup Plugins
  27 /// \brief Feature to check the shared faces of solid
  28
  29 class FeaturesPlugin_GroupSharedFaces : public FeaturesPlugin_CommonSharedFaces
  30 {
  31 public:
  32   /// Group shared faces kind.
  33   inline static const std::string& ID()
  34   {
  35     static const std::string MY_ID("Shared_faces");
  36     return MY_ID;
  37   }
  38
  39   /// Attribute name for object selected.
  40   inline static const std::string& OBJECT_ID()
  41   {
  42     static const std::string MY_OBJECT_ID("main_object");
  43     return MY_OBJECT_ID;
  44   }
  45
  46   /// Attribute name for number of faces.
  47   inline static const std::string& NUMBER_FACES_ID()
  48   {
  49     static const std::string MY_NUMBER_FACES_ID("number_shared_faces");
  50     return MY_NUMBER_FACES_ID;
  51   }
  52
  53   /// Attribute name for z coodinate.
  54   inline static const std::string& LIST_FACES_ID()
  55   {
  56     static const std::string MY_LIST_FACES_ID("group_list");
  57     return MY_LIST_FACES_ID;
  58   }
  59
  60   /// Attribute name for transparency.
  61   inline static const std::string& TRANSPARENCY_ID()
  62   {
  63     static const std::string MY_TRANSPARENCY_ID("transparency");
  64     return MY_TRANSPARENCY_ID;
  65   }
  66
  67   /// Attribute name for group name.
  68   inline static const std::string& GROUP_NAME_ID()
  69   {
  70     static const std::string MY_GROUP_NAME_ID("group_name");
  71     return MY_GROUP_NAME_ID;
  72   }
  73
  74   /// Attribute name for indicate to launch the algo.
  75   inline static const std::string& COMPUTE_ID()
  76   {
  77     static const std::string MY_COMPUTE_ID("compute");
  78     return MY_COMPUTE_ID;
  79   }
  80
  81   /// \return the kind of a feature.
  82   virtual const std::string& getKind()
  83   {
  84     return ID();
  85   }
  86
  87   /// Performs the algorithm and stores results it in the data structure.
  88   FEATURESPLUGIN_EXPORT virtual void execute();
  89
  90   /// Request for initialization of data model of the feature: adding all attributes
  91   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  92
  93   /// Called on change of any argument-attribute of this object
  94   /// \param theID identifier of changed attribute
  95   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  96
  97   /// Use plugin manager for features creation
  98   FeaturesPlugin_GroupSharedFaces();
  99
 100 private:
 101   /// Return Attribut values of object.
 102   virtual AttributePtr attributObject();
 103
 104   /// Return Attribut values of list of faces.
 105   virtual AttributePtr attributListFaces();
 106
 107   /// Return Attribut values of number of faces.
 108   virtual AttributePtr attributNumberFaces();
 109
 110   /// Return Attribut values of IsCompute.
 111   virtual AttributePtr attributIsCompute();
 112 };
 113
 114 #endif