SHAPER  9.12.0
GeomData_Dir Class Reference

Attribute that contains direction. More...

Inheritance diagram for GeomData_Dir:
Inheritance graph

Public Member Functions

virtual void setValue (const double theX, const double theY, const double theZ)
 Defines the double value. More...
 
virtual void setValue (const std::shared_ptr< GeomAPI_Dir > &theDir)
 Defines the direction. More...
 
virtual double x () const
 Returns the X double value. More...
 
virtual double y () const
 Returns the Y double value. More...
 
virtual double z () const
 Returns the Z double value. More...
 
virtual std::shared_ptr< GeomAPI_Dirdir ()
 Returns the direction of this attribute. More...
 
virtual std::shared_ptr< GeomAPI_XYZxyz ()
 Returns the coordinates of this attribute. More...
 
virtual bool isInitialized ()
 Returns ture if the direction is initialized. More...
 
virtual void reset ()
 Resets attribute to default state. 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...
 
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...
 

Static Public Member Functions

static std::string typeId ()
 Returns the type of this class of attributes. More...
 

Protected Member Functions

 GeomData_Dir (TDF_Label &theLabel)
 Initializes attributes. More...
 
virtual void reinit ()
 Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc) More...
 
virtual void setID (const std::string theID)
 Sets the ID of the attribute in Data (called from Data) 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...
 

Friends

class Model_Data
 

Detailed Description

Attribute that contains direction.

Constructor & Destructor Documentation

◆ GeomData_Dir()

GeomData_Dir::GeomData_Dir ( TDF_Label &  theLabel)
protected

Initializes attributes.

Member Function Documentation

◆ setValue() [1/2]

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

Defines the double value.

Implements GeomDataAPI_Dir.

◆ setValue() [2/2]

void GeomData_Dir::setValue ( const std::shared_ptr< GeomAPI_Dir > &  theDir)
virtual

Defines the direction.

Implements GeomDataAPI_Dir.

◆ x()

double GeomData_Dir::x ( ) const
virtual

Returns the X double value.

Implements GeomDataAPI_Dir.

◆ y()

double GeomData_Dir::y ( ) const
virtual

Returns the Y double value.

Implements GeomDataAPI_Dir.

◆ z()

double GeomData_Dir::z ( ) const
virtual

Returns the Z double value.

Implements GeomDataAPI_Dir.

◆ dir()

std::shared_ptr< GeomAPI_Dir > GeomData_Dir::dir ( )
virtual

Returns the direction of this attribute.

Implements GeomDataAPI_Dir.

◆ xyz()

std::shared_ptr< GeomAPI_XYZ > GeomData_Dir::xyz ( )
virtual

Returns the coordinates of this attribute.

Implements GeomDataAPI_Dir.

◆ isInitialized()

bool GeomData_Dir::isInitialized ( )
virtual

Returns ture if the direction is initialized.

Reimplemented from ModelAPI_Attribute.

◆ reset()

void GeomData_Dir::reset ( )
virtual

Resets attribute to default state.

Reimplemented from ModelAPI_Attribute.

◆ reinit()

void GeomData_Dir::reinit ( )
protectedvirtual

Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)

Reimplemented from ModelAPI_Attribute.

◆ typeId()

static std::string GeomDataAPI_Dir::typeId ( )
inlinestaticinherited

Returns the type of this class of attributes.

◆ attributeType()

std::string GeomDataAPI_Dir::attributeType ( )
virtualinherited

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.

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

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

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)