1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: GeomDataAPI_Point2D.h
4 // Created: 24 Apr 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef GeomDataAPI_Point2D_H_
8 #define GeomDataAPI_Point2D_H_
10 #include <GeomDataAPI.h>
11 #include <ModelAPI_Attribute.h>
17 /**\class GeomDataAPI_Point2D
19 * \brief Attribute that contains 2D point coordinates.
22 class GeomDataAPI_Point2D : public ModelAPI_Attribute
25 /// Defines the double value
26 GEOMDATAAPI_EXPORT virtual void setValue(const double theX, const double theY) = 0;
28 GEOMDATAAPI_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
30 /// Returns the X double value
31 GEOMDATAAPI_EXPORT virtual double x() const = 0;
32 /// Returns the Y double value
33 GEOMDATAAPI_EXPORT virtual double y() const = 0;
34 /// Returns the 2D point
35 GEOMDATAAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt2d> pnt() = 0;
37 /// Defines the calculated double value
38 GEOMDATAAPI_EXPORT virtual void setCalculatedValue(const double theX, const double theY) = 0;
40 /// Defines the text values
41 GEOMDATAAPI_EXPORT virtual void setText(const std::string& theX,
42 const std::string& theY) = 0;
44 /// Returns the text value for X
45 GEOMDATAAPI_EXPORT virtual std::string textX() = 0;
46 /// Returns the text value for Y
47 GEOMDATAAPI_EXPORT virtual std::string textY() = 0;
49 /// Point component (x,y)
50 enum PointComponent { C_X = 0,
54 /// Allows to set expression (text) as invalid (by the parameters listener)
55 GEOMDATAAPI_EXPORT virtual void setExpressionInvalid(int theComponent, const bool theFlag) = 0;
57 /// Returns true if text is invalid
58 GEOMDATAAPI_EXPORT virtual bool expressionInvalid(int theComponent) = 0;
60 /// Allows to set expression (text) error (by the parameters listener)
61 GEOMDATAAPI_EXPORT virtual void setExpressionError(int theComponent, const std::string& theError) = 0;
63 /// Returns an expression error
64 GEOMDATAAPI_EXPORT virtual std::string expressionError(int theComponent) = 0;
66 /// Defines the used parameters
67 GEOMDATAAPI_EXPORT virtual void setUsedParameters(int theComponent,
68 const std::set<std::string>& theUsedParameters) = 0;
70 /// Returns the used parameters
71 GEOMDATAAPI_EXPORT virtual std::set<std::string> usedParameters(int theComponent) const = 0;
73 /// Appends the delta values to point
74 GEOMDATAAPI_EXPORT void move(const double theDeltaX, const double theDeltaY);
76 /// Returns the type of this class of attributes
77 static std::string typeId()
79 return std::string("Point2D");
82 /// Returns the type of this class of attributes, not static method
83 GEOMDATAAPI_EXPORT virtual std::string attributeType();
86 /// Objects are created for features automatically
87 GEOMDATAAPI_EXPORT GeomDataAPI_Point2D();
88 GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point2D();
91 //! Pointer on attribute object
92 typedef std::shared_ptr<GeomDataAPI_Point2D> AttributePoint2DPtr;