SHAPER  9.12.0
GeomDataAPI_Point2D Class Referenceabstract

Attribute that contains 2D point coordinates. More...

Inheritance diagram for GeomDataAPI_Point2D:
Inheritance graph

Public Types

enum  PointComponent { C_X = 0 , C_Y = 1 }
 Point component (x,y) More...
 

Public Member Functions

virtual GEOMDATAAPI_EXPORT void setValue (const double theX, const double theY)=0
 Defines the double value. More...
 
virtual GEOMDATAAPI_EXPORT void setValue (const std::shared_ptr< GeomAPI_Pnt2d > &thePoint)=0
 Defines the point. More...
 
virtual GEOMDATAAPI_EXPORT double x () const =0
 Returns the X double value. More...
 
virtual GEOMDATAAPI_EXPORT double y () const =0
 Returns the Y double value. More...
 
virtual GEOMDATAAPI_EXPORT std::shared_ptr< GeomAPI_Pnt2dpnt ()=0
 Returns the 2D point. More...
 
virtual GEOMDATAAPI_EXPORT void setCalculatedValue (const double theX, const double theY)=0
 Defines the calculated double value. More...
 
virtual GEOMDATAAPI_EXPORT void setText (const std::wstring &theX, const std::wstring &theY)=0
 Defines the text values. More...
 
virtual GEOMDATAAPI_EXPORT std::wstring textX ()=0
 Returns the text value for X. More...
 
virtual GEOMDATAAPI_EXPORT std::wstring textY ()=0
 Returns the text value for Y. More...
 
virtual GEOMDATAAPI_EXPORT void setExpressionInvalid (int theComponent, const bool theFlag)=0
 Allows to set expression (text) as invalid (by the parameters listener) More...
 
virtual GEOMDATAAPI_EXPORT bool expressionInvalid (int theComponent)=0
 Returns true if text is invalid. More...
 
virtual GEOMDATAAPI_EXPORT void setExpressionError (int theComponent, const std::string &theError)=0
 Allows to set expression (text) error (by the parameters listener) More...
 
virtual GEOMDATAAPI_EXPORT std::string expressionError (int theComponent)=0
 Returns an expression error. More...
 
virtual GEOMDATAAPI_EXPORT void setUsedParameters (int theComponent, const std::set< std::wstring > &theUsedParameters)=0
 Defines the used parameters. More...
 
virtual GEOMDATAAPI_EXPORT std::set< std::wstring > usedParameters (int theComponent) const =0
 Returns the used parameters. More...
 
GEOMDATAAPI_EXPORT void move (const double theDeltaX, const double theDeltaY)
 Appends the delta values to point. More...
 
virtual GEOMDATAAPI_EXPORT std::string attributeType ()
 Returns the type of this class of attributes, not static method. More...
 
virtual void setObject (const std::shared_ptr< ModelAPI_Object > &theObject)
 Sets the owner of this attribute. More...
 
const std::shared_ptr< ModelAPI_Object > & owner () const
 Returns the owner of this attribute. More...
 
virtual bool isInitialized ()
 Returns true if attribute was initialized by some value. More...
 
void setInitialized ()
 Makes attribute initialized. More...
 
bool blockSetInitialized (const bool theBlock)
 Blocks sending "attribute updated" if theBlock is true. More...
 
void setIsArgument (const bool theFlag)
 Set this attribute is argument for result (change of this attribute requires update of result). More...
 
bool isArgument ()
 Returns true if attribute causes the result change. More...
 
bool setImmutable (const bool theFlag)
 Immutable argument can not be changed programmatically (e.g. More...
 
bool isImmutable ()
 Returns true if can not be changed programmatically. More...
 
const std::string & id () const
 ID of the attribute in Data. More...
 
virtual void reset ()
 Resets attribute to deafult state. More...
 

Static Public Member Functions

static std::string typeId ()
 Returns the type of this class of attributes. More...
 
static GEOMDATAAPI_EXPORT std::shared_ptr< GeomDataAPI_Point2DgetPoint2D (const DataPtr &theData, const std::string &theAttribute)
 Returns this attribute from the data if it is possible. More...
 

Protected Member Functions

GEOMDATAAPI_EXPORT GeomDataAPI_Point2D ()
 Objects are created for features automatically. More...
 
virtual void setID (const std::string theID)
 Sets the ID of the attribute in Data (called from Data) More...
 
virtual void reinit ()
 Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc) More...
 

Protected Attributes

bool myIsInitialized
 is some value assigned to this attribute More...
 
bool mySetInitializedBlocked
 is initialized blocked More...
 
bool myIsArgument
 is this attribute used as an argument for execution More...
 
bool myIsImmutable
 is this attribute can be changed programmatically (e.g. by constraint) More...
 

Detailed Description

Attribute that contains 2D point coordinates.

Member Enumeration Documentation

◆ PointComponent

Point component (x,y)

Constructor & Destructor Documentation

◆ GeomDataAPI_Point2D()

GeomDataAPI_Point2D::GeomDataAPI_Point2D ( )
protected

Objects are created for features automatically.

Member Function Documentation

◆ setValue() [1/2]

virtual GEOMDATAAPI_EXPORT void GeomDataAPI_Point2D::setValue ( const double  theX,
const double  theY 
)
pure virtual

Defines the double value.

Implemented in GeomData_Point2D.

◆ setValue() [2/2]

virtual GEOMDATAAPI_EXPORT void GeomDataAPI_Point2D::setValue ( const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint)
pure virtual

Defines the point.

Implemented in GeomData_Point2D.

◆ x()

virtual GEOMDATAAPI_EXPORT double GeomDataAPI_Point2D::x ( ) const
pure virtual

Returns the X double value.

Implemented in GeomData_Point2D.

◆ y()

virtual GEOMDATAAPI_EXPORT double GeomDataAPI_Point2D::y ( ) const
pure virtual

Returns the Y double value.

Implemented in GeomData_Point2D.

◆ pnt()

virtual GEOMDATAAPI_EXPORT std::shared_ptr<GeomAPI_Pnt2d> GeomDataAPI_Point2D::pnt ( )
pure virtual

Returns the 2D point.

Implemented in GeomData_Point2D.

◆ setCalculatedValue()

virtual GEOMDATAAPI_EXPORT void GeomDataAPI_Point2D::setCalculatedValue ( const double  theX,
const double  theY 
)
pure virtual

Defines the calculated double value.

Implemented in GeomData_Point2D.

◆ setText()

virtual GEOMDATAAPI_EXPORT void GeomDataAPI_Point2D::setText ( const std::wstring &  theX,
const std::wstring &  theY 
)
pure virtual

Defines the text values.

Implemented in GeomData_Point2D.

◆ textX()

virtual GEOMDATAAPI_EXPORT std::wstring GeomDataAPI_Point2D::textX ( )
pure virtual

Returns the text value for X.

Implemented in GeomData_Point2D.

◆ textY()

virtual GEOMDATAAPI_EXPORT std::wstring GeomDataAPI_Point2D::textY ( )
pure virtual

Returns the text value for Y.

Implemented in GeomData_Point2D.

◆ setExpressionInvalid()

virtual GEOMDATAAPI_EXPORT void GeomDataAPI_Point2D::setExpressionInvalid ( int  theComponent,
const bool  theFlag 
)
pure virtual

Allows to set expression (text) as invalid (by the parameters listener)

Implemented in GeomData_Point2D.

◆ expressionInvalid()

virtual GEOMDATAAPI_EXPORT bool GeomDataAPI_Point2D::expressionInvalid ( int  theComponent)
pure virtual

Returns true if text is invalid.

Implemented in GeomData_Point2D.

◆ setExpressionError()

virtual GEOMDATAAPI_EXPORT void GeomDataAPI_Point2D::setExpressionError ( int  theComponent,
const std::string &  theError 
)
pure virtual

Allows to set expression (text) error (by the parameters listener)

Implemented in GeomData_Point2D.

◆ expressionError()

virtual GEOMDATAAPI_EXPORT std::string GeomDataAPI_Point2D::expressionError ( int  theComponent)
pure virtual

Returns an expression error.

Implemented in GeomData_Point2D.

◆ setUsedParameters()

virtual GEOMDATAAPI_EXPORT void GeomDataAPI_Point2D::setUsedParameters ( int  theComponent,
const std::set< std::wstring > &  theUsedParameters 
)
pure virtual

Defines the used parameters.

Implemented in GeomData_Point2D.

◆ usedParameters()

virtual GEOMDATAAPI_EXPORT std::set<std::wstring> GeomDataAPI_Point2D::usedParameters ( int  theComponent) const
pure virtual

Returns the used parameters.

Implemented in GeomData_Point2D.

◆ move()

void GeomDataAPI_Point2D::move ( const double  theDeltaX,
const double  theDeltaY 
)

Appends the delta values to point.

◆ typeId()

static std::string GeomDataAPI_Point2D::typeId ( )
inlinestatic

Returns the type of this class of attributes.

◆ attributeType()

std::string GeomDataAPI_Point2D::attributeType ( )
virtual

Returns the type of this class of attributes, not static method.

Implements ModelAPI_Attribute.

◆ getPoint2D()

std::shared_ptr< GeomDataAPI_Point2D > GeomDataAPI_Point2D::getPoint2D ( const DataPtr &  theData,
const std::string &  theAttribute 
)
static

Returns this attribute from the data if it is possible.

Parameters
theDataa model data
theAttributean attribute index

◆ setObject()

void ModelAPI_Attribute::setObject ( const std::shared_ptr< ModelAPI_Object > &  theObject)
virtualinherited

Sets the owner of this attribute.

Reimplemented in Model_AttributeSelection, and Model_AttributeReference.

◆ owner()

const std::shared_ptr< ModelAPI_Object > & ModelAPI_Attribute::owner ( ) const
inherited

Returns the owner of this attribute.

◆ isInitialized()

bool ModelAPI_Attribute::isInitialized ( )
virtualinherited

◆ setInitialized()

void ModelAPI_Attribute::setInitialized ( )
inherited

Makes attribute initialized.

◆ blockSetInitialized()

bool ModelAPI_Attribute::blockSetInitialized ( const bool  theBlock)
inherited

Blocks sending "attribute updated" if theBlock is true.

Parameters
theBlocka block value
Returns
the previous block value

◆ setIsArgument()

void ModelAPI_Attribute::setIsArgument ( const bool  theFlag)
inherited

Set this attribute is argument for result (change of this attribute requires update of result).

By default it is true.

◆ isArgument()

bool ModelAPI_Attribute::isArgument ( )
inherited

Returns true if attribute causes the result change.

◆ setImmutable()

bool ModelAPI_Attribute::setImmutable ( const bool  theFlag)
inherited

Immutable argument can not be changed programmatically (e.g.

by constraint) By default it is false. Returns the previous state of the attribute's immutability.

◆ isImmutable()

bool ModelAPI_Attribute::isImmutable ( )
inherited

Returns true if can not be changed programmatically.

◆ id()

const std::string & ModelAPI_Attribute::id ( ) const
inherited

ID of the attribute in Data.

◆ reset()

void ModelAPI_Attribute::reset ( )
virtualinherited

Resets attribute to deafult state.

Reimplemented in Model_AttributeSelection, Model_AttributeDouble, GeomData_Point2D, and GeomData_Dir.

◆ setID()

void ModelAPI_Attribute::setID ( const std::string  theID)
protectedvirtualinherited

Sets the ID of the attribute in Data (called from Data)

Reimplemented in Model_AttributeSelection.

◆ reinit()

Field Documentation

◆ myIsInitialized

bool ModelAPI_Attribute::myIsInitialized
protectedinherited

is some value assigned to this attribute

◆ mySetInitializedBlocked

bool ModelAPI_Attribute::mySetInitializedBlocked
protectedinherited

is initialized blocked

◆ myIsArgument

bool ModelAPI_Attribute::myIsArgument
protectedinherited

is this attribute used as an argument for execution

◆ myIsImmutable

bool ModelAPI_Attribute::myIsImmutable
protectedinherited

is this attribute can be changed programmatically (e.g. by constraint)