1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef GeomDataAPI_Point_H_
22 #define GeomDataAPI_Point_H_
24 #include "GeomDataAPI.h"
25 #include <ModelAPI_Attribute.h>
31 /**\class GeomDataAPI_Point
33 * \brief Attribute that contains 3D point coordinates.
36 class GeomDataAPI_Point : public ModelAPI_Attribute
39 /// Defines the double value
40 GEOMDATAAPI_EXPORT virtual
41 void setValue(const double theX, const double theY, const double theZ) = 0;
43 GEOMDATAAPI_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Pnt>& thePoint) = 0;
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;
54 /// Defines the calculated double value
55 GEOMDATAAPI_EXPORT virtual
56 void setCalculatedValue(const double theX, const double theY, const double theZ) = 0;
58 /// Defines the text values
59 GEOMDATAAPI_EXPORT virtual void setText(const std::string& theX,
60 const std::string& theY,
61 const std::string& theZ) = 0;
63 /// Returns the text value for X
64 GEOMDATAAPI_EXPORT virtual std::string textX() = 0;
65 /// Returns the text value for Y
66 GEOMDATAAPI_EXPORT virtual std::string textY() = 0;
67 /// Returns the text value for Z
68 GEOMDATAAPI_EXPORT virtual std::string textZ() = 0;
70 /// Point component (x,y,z)
71 enum PointComponent { C_X = 0,
76 /// Allows to set expression (text) as invalid (by the parameters listener)
77 GEOMDATAAPI_EXPORT virtual void setExpressionInvalid(int theComponent, const bool theFlag) = 0;
79 /// Returns true if text is invalid
80 GEOMDATAAPI_EXPORT virtual bool expressionInvalid(int theComponent) = 0;
82 /// Allows to set expression (text) error (by the parameters listener)
83 GEOMDATAAPI_EXPORT virtual
84 void setExpressionError(int theComponent, const std::string& theError) = 0;
86 /// Returns an expression error
87 GEOMDATAAPI_EXPORT virtual std::string expressionError(int theComponent) = 0;
89 /// Defines the used parameters
90 GEOMDATAAPI_EXPORT virtual void setUsedParameters(int theComponent,
91 const std::set<std::string>& theUsedParameters) = 0;
93 /// Returns the used parameters
94 GEOMDATAAPI_EXPORT virtual std::set<std::string> usedParameters(int theComponent) const = 0;
96 /// Returns the type of this class of attributes
97 static std::string typeId()
99 return std::string("Point");
102 /// Returns the type of this class of attributes, not static method
103 GEOMDATAAPI_EXPORT virtual std::string attributeType();
106 /// Objects are created for features automatically
107 GEOMDATAAPI_EXPORT GeomDataAPI_Point();
108 GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point();
111 //! Pointer on attribute object
112 typedef std::shared_ptr<GeomDataAPI_Point> AttributePointPtr;