]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomDataAPI/GeomDataAPI_Point2D.h
Salome HOME
c693456a99f66b4636d43ff7665d9fcd758a7da4
[modules/shaper.git] / src / GeomDataAPI / GeomDataAPI_Point2D.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        GeomDataAPI_Point2D.h
4 // Created:     24 Apr 2014
5 // Author:      Mikhail PONIKAROV
6
7 #ifndef GeomDataAPI_Point2D_H_
8 #define GeomDataAPI_Point2D_H_
9
10 #include <GeomDataAPI.h>
11 #include <ModelAPI_Attribute.h>
12
13 class GeomAPI_Pnt2d;
14
15 /**\class GeomDataAPI_Point2D
16  * \ingroup DataModel
17  * \brief Attribute that contains 2D point coordinates.
18  */
19
20 class GeomDataAPI_Point2D : public ModelAPI_Attribute
21 {
22  public:
23   /// Defines the double value
24   GEOMDATAAPI_EXPORT virtual void setValue(const double theX, const double theY) = 0;
25   /// Defines the point
26   GEOMDATAAPI_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
27
28   /// Returns the X double value
29   GEOMDATAAPI_EXPORT virtual double x() const = 0;
30   /// Returns the Y double value
31   GEOMDATAAPI_EXPORT virtual double y() const = 0;
32   /// Returns the 2D point
33   GEOMDATAAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt2d> pnt() = 0;
34
35   /// Defines the double values
36   GEOMDATAAPI_EXPORT virtual void setText(const std::string& theX,
37                                           const std::string& theY) = 0;
38
39   /// Returns the double values
40   GEOMDATAAPI_EXPORT virtual std::string textX() = 0;
41   GEOMDATAAPI_EXPORT virtual std::string textY() = 0;
42
43   enum PointComponent { C_X = 0,
44                         C_Y = 1,
45   };
46
47   /// Allows to set expression (text) as invalid (by the parameters listener)
48   GEOMDATAAPI_EXPORT virtual void setExpressionInvalid(int theComponent, const bool theFlag) = 0;
49
50   /// Returns true if text is invalid
51   GEOMDATAAPI_EXPORT virtual bool expressionInvalid(int theComponent) = 0;
52
53   /// Appends the delta values to point
54   GEOMDATAAPI_EXPORT void move(const double theDeltaX, const double theDeltaY);
55
56   /// Returns the type of this class of attributes
57   static std::string typeId()
58   {
59     return std::string("Point2D");
60   }
61
62   /// Returns the type of this class of attributes, not static method
63   GEOMDATAAPI_EXPORT virtual std::string attributeType();
64
65  protected:
66   /// Objects are created for features automatically
67   GEOMDATAAPI_EXPORT GeomDataAPI_Point2D();
68   GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point2D();
69 };
70
71 //! Pointer on attribute object
72 typedef std::shared_ptr<GeomDataAPI_Point2D> AttributePoint2DPtr;
73
74 #endif