SHAPER 9.16.0
GeomDataAPI_Point2D.h
1// Copyright (C) 2014-2026 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 GeomDataAPI_Point2D_H_
21#define GeomDataAPI_Point2D_H_
22
23#include <GeomDataAPI.h>
24#include <ModelAPI_Attribute.h>
25#include <ModelAPI_Data.h>
26
27#include <set>
28
29class GeomAPI_Pnt2d;
30
37{
38 public:
40 GEOMDATAAPI_EXPORT virtual void setValue(const double theX, const double theY) = 0;
42 GEOMDATAAPI_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
43
45 GEOMDATAAPI_EXPORT virtual double x() const = 0;
47 GEOMDATAAPI_EXPORT virtual double y() const = 0;
49 GEOMDATAAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt2d> pnt() = 0;
50
52 GEOMDATAAPI_EXPORT virtual void setCalculatedValue(const double theX, const double theY) = 0;
53
55 GEOMDATAAPI_EXPORT virtual void setText(const std::wstring& theX,
56 const std::wstring& theY) = 0;
57
59 GEOMDATAAPI_EXPORT virtual std::wstring textX() = 0;
61 GEOMDATAAPI_EXPORT virtual std::wstring textY() = 0;
62
64 enum PointComponent { C_X = 0,
65 C_Y = 1,
66 };
67
69 GEOMDATAAPI_EXPORT virtual void setExpressionInvalid(int theComponent, const bool theFlag) = 0;
70
72 GEOMDATAAPI_EXPORT virtual bool expressionInvalid(int theComponent) = 0;
73
75 GEOMDATAAPI_EXPORT virtual
76 void setExpressionError(int theComponent, const std::string& theError) = 0;
77
79 GEOMDATAAPI_EXPORT virtual std::string expressionError(int theComponent) = 0;
80
82 GEOMDATAAPI_EXPORT virtual void setUsedParameters(int theComponent,
83 const std::set<std::wstring>& theUsedParameters) = 0;
84
86 GEOMDATAAPI_EXPORT virtual std::set<std::wstring> usedParameters(int theComponent) const = 0;
87
89 GEOMDATAAPI_EXPORT void move(const double theDeltaX, const double theDeltaY);
90
92 static std::string typeId()
93 {
94 return std::string("Point2D");
95 }
96
98 GEOMDATAAPI_EXPORT virtual std::string attributeType();
99
103 static GEOMDATAAPI_EXPORT std::shared_ptr<GeomDataAPI_Point2D> getPoint2D(const DataPtr& theData,
104 const std::string& theAttribute);
105
106 protected:
108 GEOMDATAAPI_EXPORT GeomDataAPI_Point2D();
109 GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point2D();
110};
111
113typedef std::shared_ptr<GeomDataAPI_Point2D> AttributePoint2DPtr;
114
115#endif
2D point defined by two coordinates
Definition: GeomAPI_Pnt2d.h:36
Attribute that contains 2D point coordinates.
Definition: GeomDataAPI_Point2D.h:37
virtual GEOMDATAAPI_EXPORT std::string expressionError(int theComponent)=0
Returns an expression error.
virtual GEOMDATAAPI_EXPORT bool expressionInvalid(int theComponent)=0
Returns true if text is invalid.
virtual GEOMDATAAPI_EXPORT void setCalculatedValue(const double theX, const double theY)=0
Defines the calculated double value.
static GEOMDATAAPI_EXPORT std::shared_ptr< GeomDataAPI_Point2D > getPoint2D(const DataPtr &theData, const std::string &theAttribute)
Returns this attribute from the data if it is possible.
Definition: GeomDataAPI_Point2D.cpp:33
virtual GEOMDATAAPI_EXPORT std::set< std::wstring > usedParameters(int theComponent) const =0
Returns the used parameters.
static std::string typeId()
Returns the type of this class of attributes.
Definition: GeomDataAPI_Point2D.h:92
virtual GEOMDATAAPI_EXPORT void setExpressionError(int theComponent, const std::string &theError)=0
Allows to set expression (text) error (by the parameters listener)
virtual GEOMDATAAPI_EXPORT std::wstring textY()=0
Returns the text value for Y.
virtual GEOMDATAAPI_EXPORT double x() const =0
Returns the X double value.
virtual GEOMDATAAPI_EXPORT double y() const =0
Returns the Y double value.
virtual GEOMDATAAPI_EXPORT void setExpressionInvalid(int theComponent, const bool theFlag)=0
Allows to set expression (text) as invalid (by the parameters listener)
virtual GEOMDATAAPI_EXPORT std::shared_ptr< GeomAPI_Pnt2d > pnt()=0
Returns the 2D point.
virtual GEOMDATAAPI_EXPORT std::string attributeType()
Returns the type of this class of attributes, not static method.
Definition: GeomDataAPI_Point2D.cpp:28
GEOMDATAAPI_EXPORT GeomDataAPI_Point2D()
Objects are created for features automatically.
Definition: GeomDataAPI_Point2D.cpp:49
virtual GEOMDATAAPI_EXPORT void setUsedParameters(int theComponent, const std::set< std::wstring > &theUsedParameters)=0
Defines the used parameters.
virtual GEOMDATAAPI_EXPORT void setText(const std::wstring &theX, const std::wstring &theY)=0
Defines the text values.
GEOMDATAAPI_EXPORT void move(const double theDeltaX, const double theDeltaY)
Appends the delta values to point.
Definition: GeomDataAPI_Point2D.cpp:23
virtual GEOMDATAAPI_EXPORT void setValue(const double theX, const double theY)=0
Defines the double value.
virtual GEOMDATAAPI_EXPORT void setValue(const std::shared_ptr< GeomAPI_Pnt2d > &thePoint)=0
Defines the point.
virtual GEOMDATAAPI_EXPORT std::wstring textX()=0
Returns the text value for X.
PointComponent
Point component (x,y)
Definition: GeomDataAPI_Point2D.h:64
Generic attribute of the Object.
Definition: ModelAPI_Attribute.h:34