SHAPER  9.12.0
GeomDataAPI_Point Class Referenceabstract

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

Inheritance diagram for GeomDataAPI_Point:
Inheritance graph

Public Types

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

Public Member Functions

virtual void setValue (const double theX, const double theY, const double theZ)=0
 Defines the double value. More...
 
virtual void setValue (const std::shared_ptr< GeomAPI_Pnt > &thePoint)=0
 Defines the point. More...
 
virtual double x () const =0
 Returns the X double value. More...
 
virtual double y () const =0
 Returns the Y double value. More...
 
virtual double z () const =0
 Returns the Z double value. More...
 
virtual std::shared_ptr< GeomAPI_Pntpnt ()=0
 Returns the 3D point. More...
 
virtual void setCalculatedValue (const double theX, const double theY, const double theZ)=0
 Defines the calculated double value. More...
 
virtual void setX (const double theX)=0
 Defines the X coordinate value. More...
 
virtual void setY (const double theY)=0
 Defines the Y coordinate value. More...
 
virtual void setZ (const double theZ)=0
 Defines the Z coordinate value. More...
 
virtual void setText (const std::wstring &theX, const std::wstring &theY, const std::wstring &theZ)=0
 Defines the text values. More...
 
virtual void setTextX (const std::wstring &theX)=0
 Defines the X text value. More...
 
virtual void setTextY (const std::wstring &theY)=0
 Defines the Y text value. More...
 
virtual void setTextZ (const std::wstring &theZ)=0
 Defines the Z text value. More...
 
virtual std::wstring textX ()=0
 Returns the text value for X. More...
 
virtual std::wstring textY ()=0
 Returns the text value for Y. More...
 
virtual std::wstring textZ ()=0
 Returns the text value for Z. More...
 
virtual void setExpressionInvalid (int theComponent, const bool theFlag)=0
 Allows to set expression (text) as invalid (by the parameters listener) More...
 
virtual bool expressionInvalid (int theComponent)=0
 Returns true if text is invalid. More...
 
virtual void setExpressionError (int theComponent, const std::string &theError)=0
 Allows to set expression (text) error (by the parameters listener) More...
 
virtual std::string expressionError (int theComponent)=0
 Returns an expression error. More...
 
virtual void setUsedParameters (int theComponent, const std::set< std::wstring > &theUsedParameters)=0
 Defines the used parameters. More...
 
virtual std::set< std::wstring > usedParameters (int theComponent) const =0
 Returns the used parameters. More...
 
virtual 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...
 

Protected Member Functions

 GeomDataAPI_Point ()
 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 3D point coordinates.

Member Enumeration Documentation

◆ PointComponent

Point component (x,y,z)

Constructor & Destructor Documentation

◆ GeomDataAPI_Point()

GeomDataAPI_Point::GeomDataAPI_Point ( )
protected

Objects are created for features automatically.

Member Function Documentation

◆ setValue() [1/2]

virtual void GeomDataAPI_Point::setValue ( const double  theX,
const double  theY,
const double  theZ 
)
pure virtual

Defines the double value.

Implemented in GeomData_Point.

◆ setValue() [2/2]

virtual void GeomDataAPI_Point::setValue ( const std::shared_ptr< GeomAPI_Pnt > &  thePoint)
pure virtual

Defines the point.

Implemented in GeomData_Point.

◆ x()

virtual double GeomDataAPI_Point::x ( ) const
pure virtual

Returns the X double value.

Implemented in GeomData_Point.

◆ y()

virtual double GeomDataAPI_Point::y ( ) const
pure virtual

Returns the Y double value.

Implemented in GeomData_Point.

◆ z()

virtual double GeomDataAPI_Point::z ( ) const
pure virtual

Returns the Z double value.

Implemented in GeomData_Point.

◆ pnt()

virtual std::shared_ptr<GeomAPI_Pnt> GeomDataAPI_Point::pnt ( )
pure virtual

Returns the 3D point.

Implemented in GeomData_Point.

◆ setCalculatedValue()

virtual void GeomDataAPI_Point::setCalculatedValue ( const double  theX,
const double  theY,
const double  theZ 
)
pure virtual

Defines the calculated double value.

Implemented in GeomData_Point.

◆ setX()

virtual void GeomDataAPI_Point::setX ( const double  theX)
pure virtual

Defines the X coordinate value.

Implemented in GeomData_Point.

◆ setY()

virtual void GeomDataAPI_Point::setY ( const double  theY)
pure virtual

Defines the Y coordinate value.

Implemented in GeomData_Point.

◆ setZ()

virtual void GeomDataAPI_Point::setZ ( const double  theZ)
pure virtual

Defines the Z coordinate value.

Implemented in GeomData_Point.

◆ setText()

virtual void GeomDataAPI_Point::setText ( const std::wstring &  theX,
const std::wstring &  theY,
const std::wstring &  theZ 
)
pure virtual

Defines the text values.

Implemented in GeomData_Point.

◆ setTextX()

virtual void GeomDataAPI_Point::setTextX ( const std::wstring &  theX)
pure virtual

Defines the X text value.

Implemented in GeomData_Point.

◆ setTextY()

virtual void GeomDataAPI_Point::setTextY ( const std::wstring &  theY)
pure virtual

Defines the Y text value.

Implemented in GeomData_Point.

◆ setTextZ()

virtual void GeomDataAPI_Point::setTextZ ( const std::wstring &  theZ)
pure virtual

Defines the Z text value.

Implemented in GeomData_Point.

◆ textX()

virtual std::wstring GeomDataAPI_Point::textX ( )
pure virtual

Returns the text value for X.

Implemented in GeomData_Point.

◆ textY()

virtual std::wstring GeomDataAPI_Point::textY ( )
pure virtual

Returns the text value for Y.

Implemented in GeomData_Point.

◆ textZ()

virtual std::wstring GeomDataAPI_Point::textZ ( )
pure virtual

Returns the text value for Z.

Implemented in GeomData_Point.

◆ setExpressionInvalid()

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

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

Implemented in GeomData_Point.

◆ expressionInvalid()

virtual bool GeomDataAPI_Point::expressionInvalid ( int  theComponent)
pure virtual

Returns true if text is invalid.

Implemented in GeomData_Point.

◆ setExpressionError()

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

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

Implemented in GeomData_Point.

◆ expressionError()

virtual std::string GeomDataAPI_Point::expressionError ( int  theComponent)
pure virtual

Returns an expression error.

Implemented in GeomData_Point.

◆ setUsedParameters()

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

Defines the used parameters.

Implemented in GeomData_Point.

◆ usedParameters()

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

Returns the used parameters.

Implemented in GeomData_Point.

◆ typeId()

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

Returns the type of this class of attributes.

◆ attributeType()

std::string GeomDataAPI_Point::attributeType ( )
virtual

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

Implements ModelAPI_Attribute.

◆ 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)