Salome HOME
updated copyright message
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_PointCoordinates.h
1 // Copyright (C) 2018-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_PointCoordinates_H_
21 #define FeaturesPlugin_PointCoordinates_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_PointCoordinates
30 /// \ingroup Plugins
31 /// \brief Feature to view point coordinates.
32
33 class FeaturesPlugin_PointCoordinates : public ModelAPI_Feature
34 {
35 public:
36   inline static const std::string& ID()
37   {
38     static const std::string MY_ID("PointCoordinates");
39     return MY_ID;
40   }
41
42   /// Attribute name for point selected.
43   inline static const std::string& POINT_SELECTED_ID()
44   {
45     static const std::string MY_POINT_SELECTED_ID("point_selected");
46     return MY_POINT_SELECTED_ID;
47   }
48
49   /// Attribute name for x coordinate.
50   inline static const std::string& X_COORD_ID()
51   {
52     static const std::string MY_X_COORD_ID("xcoordinate");
53     return MY_X_COORD_ID;
54   }
55
56   /// Attribute name for y coordinate.
57   inline static const std::string& Y_COORD_ID()
58   {
59     static const std::string MY_Y_COORD_ID("ycoordinate");
60     return MY_Y_COORD_ID;
61   }
62
63   /// Attribute name for z coordinate.
64   inline static const std::string& Z_COORD_ID()
65   {
66     static const std::string MY_Z_COORD_ID("zcoordinate");
67     return MY_Z_COORD_ID;
68   }
69
70   /// Attribute name for values of result.
71   inline static const std::string& RESULT_VALUES_ID()
72   {
73     static const std::string MY_RESULT_VALUES_ID("result_values");
74     return MY_RESULT_VALUES_ID;
75   }
76
77   /// \return the kind of a feature.
78   virtual const std::string& getKind()
79   {
80     return ID();
81   }
82
83   /// Performs the algorithm and stores results it in the data structure.
84   FEATURESPLUGIN_EXPORT virtual void execute();
85
86   /// Request for initialization of data model of the feature: adding all attributes
87   FEATURESPLUGIN_EXPORT virtual void initAttributes();
88
89   /// Called on change of any argument-attribute of this object
90   /// \param theID identifier of changed attribute
91   FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
92
93   /// Reimplemented from ModelAPI_Feature::isMacro(). Returns true.
94   FEATURESPLUGIN_EXPORT virtual bool isMacro() const { return true; }
95
96   /// Use plugin manager for features creation
97   FeaturesPlugin_PointCoordinates();
98
99 };
100
101 #endif