SHAPER 9.16.0
GeomDataAPI_Point.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_Point_H_
21#define GeomDataAPI_Point_H_
22
23#include "GeomDataAPI.h"
24#include <ModelAPI_Attribute.h>
25
26#include <set>
27
28class GeomAPI_Pnt;
29
36{
37 public:
39 GEOMDATAAPI_EXPORT virtual
40 void setValue(const double theX, const double theY, const double theZ) = 0;
42 GEOMDATAAPI_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Pnt>& thePoint) = 0;
43
45 GEOMDATAAPI_EXPORT virtual double x() const = 0;
47 GEOMDATAAPI_EXPORT virtual double y() const = 0;
49 GEOMDATAAPI_EXPORT virtual double z() const = 0;
51 GEOMDATAAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> pnt() = 0;
52
54 GEOMDATAAPI_EXPORT virtual
55 void setCalculatedValue(const double theX, const double theY, const double theZ) = 0;
56
58 GEOMDATAAPI_EXPORT virtual void setX(const double theX) = 0;
60 GEOMDATAAPI_EXPORT virtual void setY(const double theY) = 0;
62 GEOMDATAAPI_EXPORT virtual void setZ(const double theZ) = 0;
63
65 GEOMDATAAPI_EXPORT virtual void setText(const std::wstring& theX,
66 const std::wstring& theY,
67 const std::wstring& theZ) = 0;
68
70 GEOMDATAAPI_EXPORT virtual void setTextX(const std::wstring& theX) = 0;
72 GEOMDATAAPI_EXPORT virtual void setTextY(const std::wstring& theY) = 0;
74 GEOMDATAAPI_EXPORT virtual void setTextZ(const std::wstring& theZ) = 0;
75
77 GEOMDATAAPI_EXPORT virtual std::wstring textX() = 0;
79 GEOMDATAAPI_EXPORT virtual std::wstring textY() = 0;
81 GEOMDATAAPI_EXPORT virtual std::wstring textZ() = 0;
82
84 enum PointComponent { C_X = 0,
85 C_Y = 1,
86 C_Z = 2,
87 };
88
90 GEOMDATAAPI_EXPORT virtual void setExpressionInvalid(int theComponent, const bool theFlag) = 0;
91
93 GEOMDATAAPI_EXPORT virtual bool expressionInvalid(int theComponent) = 0;
94
96 GEOMDATAAPI_EXPORT virtual
97 void setExpressionError(int theComponent, const std::string& theError) = 0;
98
100 GEOMDATAAPI_EXPORT virtual std::string expressionError(int theComponent) = 0;
101
103 GEOMDATAAPI_EXPORT virtual void setUsedParameters(int theComponent,
104 const std::set<std::wstring>& theUsedParameters) = 0;
105
107 GEOMDATAAPI_EXPORT virtual std::set<std::wstring> usedParameters(int theComponent) const = 0;
108
110 static std::string typeId()
111 {
112 return std::string("Point");
113 }
114
116 GEOMDATAAPI_EXPORT virtual std::string attributeType();
117
118 protected:
120 GEOMDATAAPI_EXPORT GeomDataAPI_Point();
121 GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point();
122};
123
125typedef std::shared_ptr<GeomDataAPI_Point> AttributePointPtr;
126
127#endif
3D point defined by three coordinates
Definition: GeomAPI_Pnt.h:38
Attribute that contains 3D point coordinates.
Definition: GeomDataAPI_Point.h:36
virtual std::string attributeType()
Returns the type of this class of attributes, not static method.
Definition: GeomDataAPI_Point.cpp:22
virtual void setY(const double theY)=0
Defines the Y coordinate value.
virtual std::wstring textZ()=0
Returns the text value for Z.
GeomDataAPI_Point()
Objects are created for features automatically.
Definition: GeomDataAPI_Point.cpp:27
virtual void setTextX(const std::wstring &theX)=0
Defines the X text value.
virtual std::string expressionError(int theComponent)=0
Returns an expression error.
virtual std::wstring textX()=0
Returns the text value for X.
virtual void setCalculatedValue(const double theX, const double theY, const double theZ)=0
Defines the calculated double value.
virtual std::shared_ptr< GeomAPI_Pnt > pnt()=0
Returns the 3D point.
virtual void setValue(const std::shared_ptr< GeomAPI_Pnt > &thePoint)=0
Defines the point.
virtual std::wstring textY()=0
Returns the text value for Y.
virtual double x() const =0
Returns the X double value.
virtual void setTextZ(const std::wstring &theZ)=0
Defines the Z text value.
virtual void setX(const double theX)=0
Defines the X coordinate value.
virtual void setExpressionInvalid(int theComponent, const bool theFlag)=0
Allows to set expression (text) as invalid (by the parameters listener)
virtual void setValue(const double theX, const double theY, const double theZ)=0
Defines the double value.
virtual double y() const =0
Returns the Y double value.
virtual double z() const =0
Returns the Z double value.
virtual void setExpressionError(int theComponent, const std::string &theError)=0
Allows to set expression (text) error (by the parameters listener)
virtual void setUsedParameters(int theComponent, const std::set< std::wstring > &theUsedParameters)=0
Defines the used parameters.
PointComponent
Point component (x,y,z)
Definition: GeomDataAPI_Point.h:84
virtual void setText(const std::wstring &theX, const std::wstring &theY, const std::wstring &theZ)=0
Defines the text values.
virtual void setZ(const double theZ)=0
Defines the Z coordinate value.
virtual 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_Point.h:110
virtual bool expressionInvalid(int theComponent)=0
Returns true if text is invalid.
virtual void setTextY(const std::wstring &theY)=0
Defines the Y text value.
Generic attribute of the Object.
Definition: ModelAPI_Attribute.h:34