]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_NormalToFace.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_NormalToFace.h
1 // Copyright (C) 2014-2022  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_NormalToFace_H_
21 #define FeaturesPlugin_NormalToFace_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_NormalToFace
30 /// \ingroup Plugins
31 /// \brief Persistence feature to construct normal to face
32 class FeaturesPlugin_NormalToFace : public ModelAPI_Feature
33 {
34 public:
35   /// Normal to face kind.
36   inline static const std::string& ID()
37   {
38     static const std::string MY_ID("Normal");
39     return MY_ID;
40   }
41
42   /// Attribute name for face selected.
43   inline static const std::string& FACE_SELECTED_ID()
44   {
45     static const std::string MY_FACE_ID("face");
46     return MY_FACE_ID;
47   }
48
49   /// Attribute name for vertex selected.
50   inline static const std::string& VERTEX_SELECTED_ID()
51   {
52     static const std::string MY_VERTEX_SELECTED_ID("vertex");
53     return MY_VERTEX_SELECTED_ID;
54   }
55
56   /// Attribute name of vertex option.
57   inline static const std::string& VERTEX_OPTION_ID()
58   {
59     static const std::string MY_VERTEX_OPTION_ID("vertex_option");
60     return MY_VERTEX_OPTION_ID;
61   }
62
63   /// \return the kind of a feature.
64   virtual const std::string& getKind()
65   {
66     return ID();
67   }
68
69   /// Performs the algorithm and stores results it in the data structure.
70   FEATURESPLUGIN_EXPORT virtual void execute();
71
72   /// Request for initialization of data model of the feature: adding all attributes
73   FEATURESPLUGIN_EXPORT virtual void initAttributes();
74
75   /// Called on change of any argument-attribute of this object
76   /// \param theID identifier of changed attribute
77   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
78
79   /// Use plugin manager for features creation
80   FeaturesPlugin_NormalToFace();
81
82 };
83
84 #endif