]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomDataAPI/GeomDataAPI_Point.h
Salome HOME
Reverted some changes in salome build/run scripts.
[modules/shaper.git] / src / GeomDataAPI / GeomDataAPI_Point.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 GeomDataAPI_Point_H_
22 #define GeomDataAPI_Point_H_
23
24 #include "GeomDataAPI.h"
25 #include <ModelAPI_Attribute.h>
26
27 #include <set>
28
29 class GeomAPI_Pnt;
30
31 /**\class GeomDataAPI_Point
32  * \ingroup DataModel
33  * \brief Attribute that contains 3D point coordinates. 
34  */
35
36 class GeomDataAPI_Point : public ModelAPI_Attribute
37 {
38  public:
39   /// Defines the double value
40   GEOMDATAAPI_EXPORT virtual
41     void setValue(const double theX, const double theY, const double theZ) = 0;
42   /// Defines the point
43   GEOMDATAAPI_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Pnt>& thePoint) = 0;
44
45   /// Returns the X double value
46   GEOMDATAAPI_EXPORT virtual double x() const = 0;
47   /// Returns the Y double value
48   GEOMDATAAPI_EXPORT virtual double y() const = 0;
49   /// Returns the Z double value
50   GEOMDATAAPI_EXPORT virtual double z() const = 0;
51   /// Returns the 3D point
52   GEOMDATAAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> pnt() = 0;
53
54   /// Defines the calculated double value
55   GEOMDATAAPI_EXPORT virtual
56     void setCalculatedValue(const double theX, const double theY, const double theZ) = 0;
57
58   /// Defines the X coordinate value
59   GEOMDATAAPI_EXPORT virtual void setX(const double theX) = 0;
60   /// Defines the Y coordinate value
61   GEOMDATAAPI_EXPORT virtual void setY(const double theY) = 0;
62   /// Defines the Z coordinate value
63   GEOMDATAAPI_EXPORT virtual void setZ(const double theZ) = 0;
64
65   /// Defines the text values
66   GEOMDATAAPI_EXPORT virtual void setText(const std::string& theX,
67                                           const std::string& theY,
68                                           const std::string& theZ) = 0;
69
70   /// Defines the X text value
71   GEOMDATAAPI_EXPORT virtual void setTextX(const std::string& theX) = 0;
72   /// Defines the Y text value
73   GEOMDATAAPI_EXPORT virtual void setTextY(const std::string& theY) = 0;
74   /// Defines the Z text value
75   GEOMDATAAPI_EXPORT virtual void setTextZ(const std::string& theZ) = 0;
76
77   /// Returns the text value for X
78   GEOMDATAAPI_EXPORT virtual std::string textX() = 0;
79   /// Returns the text value for Y
80   GEOMDATAAPI_EXPORT virtual std::string textY() = 0;
81   /// Returns the text value for Z
82   GEOMDATAAPI_EXPORT virtual std::string textZ() = 0;
83
84   /// Point component (x,y,z)
85   enum PointComponent { C_X = 0,
86                         C_Y = 1,
87                         C_Z = 2,
88   };
89
90   /// Allows to set expression (text) as invalid (by the parameters listener)
91   GEOMDATAAPI_EXPORT virtual void setExpressionInvalid(int theComponent, const bool theFlag) = 0;
92
93   /// Returns true if text is invalid
94   GEOMDATAAPI_EXPORT virtual bool expressionInvalid(int theComponent) = 0;
95
96   /// Allows to set expression (text) error (by the parameters listener)
97   GEOMDATAAPI_EXPORT virtual
98     void setExpressionError(int theComponent, const std::string& theError) = 0;
99
100   /// Returns an expression error
101   GEOMDATAAPI_EXPORT virtual std::string expressionError(int theComponent) = 0;
102
103   /// Defines the used parameters
104   GEOMDATAAPI_EXPORT virtual void setUsedParameters(int theComponent,
105     const std::set<std::string>& theUsedParameters) = 0;
106
107   /// Returns the used parameters
108   GEOMDATAAPI_EXPORT virtual std::set<std::string> usedParameters(int theComponent) const = 0;
109
110   /// Returns the type of this class of attributes
111   static std::string typeId()
112   {
113     return std::string("Point");
114   }
115
116   /// Returns the type of this class of attributes, not static method
117   GEOMDATAAPI_EXPORT virtual std::string attributeType();
118
119  protected:
120   /// Objects are created for features automatically
121   GEOMDATAAPI_EXPORT GeomDataAPI_Point();
122   GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point();
123 };
124
125 //! Pointer on attribute object
126 typedef std::shared_ptr<GeomDataAPI_Point> AttributePointPtr;
127
128 #endif