src/FeaturesPlugin/FeaturesPlugin_InspectNormalToFace.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 FeaturesPlugin_InspectNormalToFace_H_
  21 #define FeaturesPlugin_InspectNormalToFace_H_
  22
  23 #include "FeaturesPlugin.h"
  24 #include <ModelAPI_Feature.h>
  25
  26 #include <GeomAPI_IPresentable.h>
  27 #include <GeomAPI_IScreenParams.h>
  28
  29 /// \class FeaturesPlugin_InspectNormalToFace
  30 /// \ingroup Plugins
  31 /// \brief Feature to view the normal to face
  32
  33 class FeaturesPlugin_InspectNormalToFace : public ModelAPI_Feature
  34 {
  35 public:
  36   /// Normal to face macro kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_ID("NormalMacro");
  40     return MY_ID;
  41   }
  42
  43   /// Attribute name for face selected.
  44   inline static const std::string& FACE_SELECTED_ID()
  45   {
  46     static const std::string MY_FACE_SELECTED_ID("face");
  47     return MY_FACE_SELECTED_ID;
  48   }
  49
  50   /// Attribute name for vertex selected.
  51   inline static const std::string& VERTEX_SELECTED_ID()
  52   {
  53     static const std::string MY_VERTEX_SELECTED_ID("vertex");
  54     return MY_VERTEX_SELECTED_ID;
  55   }
  56
  57    /// Attribute name for checkbox create box.
  58   inline static const std::string& CREATENORMAL_ID()
  59   {
  60     static const std::string MY_CREATENORMAL_ID("createnormal");
  61     return MY_CREATENORMAL_ID;
  62   }
  63
  64   /// Attribute name of vertex option.
  65   inline static const std::string& VERTEX_OPTION_ID()
  66   {
  67     static const std::string MY_VERTEX_OPTION_ID("vertex_option");
  68     return MY_VERTEX_OPTION_ID;
  69   }
  70
  71   /// \return the kind of a feature.
  72   virtual const std::string& getKind()
  73   {
  74     return ID();
  75   }
  76
  77   /// Performs the algorithm and stores results it in the data structure.
  78   FEATURESPLUGIN_EXPORT virtual void execute();
  79
  80   /// Request for initialization of data model of the feature: adding all attributes
  81   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  82
  83   /// Called on change of any argument-attribute of this object
  84   /// \param theID identifier of changed attribute
  85   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  86
  87   /// Reimplemented from ModelAPI_Feature::isMacro(). Returns true.
  88   FEATURESPLUGIN_EXPORT virtual bool isMacro() const { return true; }
  89
  90   /// Use plugin manager for features creation
  91   FeaturesPlugin_InspectNormalToFace();
  92
  93   private:
  94   /// Create normal in feature
  95   void createNormal();
  96   /// Update normal in feature
  97   void updateNormal();
  98   /// Feature to create normal
  99   FeaturePtr myCreateFeature;
 100
 101 };
 102
 103 #endif