A framework to define the display of datums. More...

#include <Prs3d_DatumAspect.hxx>

Inheritance diagram for Prs3d_DatumAspect:

[legend]

Public Member Functions
	Prs3d_DatumAspect ()
	An empty constructor.
const occ::handle< Prs3d_LineAspect > &	LineAspect (Prs3d_DatumParts thePart) const
	Returns line aspect for specified part.
const occ::handle< Prs3d_ShadingAspect > &	ShadingAspect (Prs3d_DatumParts thePart) const
	Returns shading aspect for specified part.
const occ::handle< Prs3d_TextAspect > &	TextAspect (Prs3d_DatumParts thePart) const
	Returns the text attributes for rendering label of specified part (Prs3d_DatumParts_XAxis/Prs3d_DatumParts_YAxis/Prs3d_DatumParts_ZAxis).
void	SetTextAspect (const occ::handle< Prs3d_TextAspect > &theTextAspect)
	Sets text attributes for rendering labels.
const occ::handle< Prs3d_PointAspect > &	PointAspect () const
	Returns the point aspect of origin wireframe presentation.
void	SetPointAspect (const occ::handle< Prs3d_PointAspect > &theAspect)
	Returns the point aspect of origin wireframe presentation.
const occ::handle< Prs3d_ArrowAspect > &	ArrowAspect () const
	Returns the arrow aspect of presentation.
void	SetArrowAspect (const occ::handle< Prs3d_ArrowAspect > &theAspect)
	Sets the arrow aspect of presentation.
bool	DrawDatumPart (Prs3d_DatumParts thePart) const
	Returns true if the given part is used in axes of aspect.
void	SetDrawDatumAxes (Prs3d_DatumAxes theType)
	Sets the axes used in the datum aspect.
Prs3d_DatumAxes	DatumAxes () const
	Returns axes used in the datum aspect.
double	Attribute (Prs3d_DatumAttribute theType) const
	Returns the attribute of the datum type.
void	SetAttribute (Prs3d_DatumAttribute theType, const double theValue)
	Sets the attribute of the datum type.
double	AxisLength (Prs3d_DatumParts thePart) const
	Returns the length of the displayed first axis.
void	SetAxisLength (double theL1, double theL2, double theL3)
	Sets the lengths of the three axes.
bool	ToDrawLabels () const
void	SetDrawLabels (bool theToDraw)
	Sets option to draw or not to draw text labels for axes.
void	SetToDrawLabels (bool theToDraw)
bool	ToDrawArrows () const
void	SetDrawArrows (bool theToDraw)
	Sets option to draw or not arrows for axes.
void	CopyAspectsFrom (const occ::handle< Prs3d_DatumAspect > &theOther)
	Performs deep copy of attributes from another aspect instance.
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Prs3d_DatumParts	ArrowPartForAxis (Prs3d_DatumParts thePart)
	Returns type of arrow for a type of axis.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Data Fields
This method is deprecated TextAspect() with axis parameter should be called instead") const occ occ::handle<Prs3d_LineAspect>	myLineAspects [Prs3d_DatumParts_NB]
	Returns the text attributes for rendering labels.
occ::handle< Prs3d_TextAspect >	myTextAspects [Prs3d_DatumParts_NB]
occ::handle< Prs3d_PointAspect >	myPointAspect
occ::handle< Prs3d_ArrowAspect >	myArrowAspect
double	myAttributes [Prs3d_DatumAttribute_NB]
Prs3d_DatumAxes	myAxes
bool	myToDrawLabels
bool	myToDrawArrows

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

A framework to define the display of datums.

Constructor & Destructor Documentation

◆ Prs3d_DatumAspect()

Prs3d_DatumAspect::Prs3d_DatumAspect ( )

An empty constructor.

Member Function Documentation

◆ ArrowAspect()

const occ::handle< Prs3d_ArrowAspect > & Prs3d_DatumAspect::ArrowAspect ( ) const

inline

Returns the arrow aspect of presentation.

◆ ArrowPartForAxis()

Prs3d_DatumParts Prs3d_DatumAspect::ArrowPartForAxis ( Prs3d_DatumParts thePart )

static

Returns type of arrow for a type of axis.

◆ Attribute()

double Prs3d_DatumAspect::Attribute ( Prs3d_DatumAttribute theType ) const

inline

Returns the attribute of the datum type.

◆ AxisLength()

double Prs3d_DatumAspect::AxisLength ( Prs3d_DatumParts thePart ) const

Returns the length of the displayed first axis.

◆ CopyAspectsFrom()

void Prs3d_DatumAspect::CopyAspectsFrom ( const occ::handle< Prs3d_DatumAspect > & theOther )

Performs deep copy of attributes from another aspect instance.

◆ DatumAxes()

Prs3d_DatumAxes Prs3d_DatumAspect::DatumAxes ( ) const

inline

Returns axes used in the datum aspect.

◆ DrawDatumPart()

bool Prs3d_DatumAspect::DrawDatumPart ( Prs3d_DatumParts thePart ) const

Returns true if the given part is used in axes of aspect.

◆ DumpJson()

void Prs3d_DatumAspect::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

◆ LineAspect()

const occ::handle< Prs3d_LineAspect > & Prs3d_DatumAspect::LineAspect ( Prs3d_DatumParts thePart ) const

inline

Returns line aspect for specified part.

◆ PointAspect()

const occ::handle< Prs3d_PointAspect > & Prs3d_DatumAspect::PointAspect ( ) const

inline

Returns the point aspect of origin wireframe presentation.

◆ SetArrowAspect()

void Prs3d_DatumAspect::SetArrowAspect ( const occ::handle< Prs3d_ArrowAspect > & theAspect )

inline

Sets the arrow aspect of presentation.

◆ SetAttribute()

void Prs3d_DatumAspect::SetAttribute	(	Prs3d_DatumAttribute	theType,
		const double	theValue )

inline

Sets the attribute of the datum type.

◆ SetAxisLength()

void Prs3d_DatumAspect::SetAxisLength	(	double	theL1,
		double	theL2,
		double	theL3 )

inline

Sets the lengths of the three axes.

◆ SetDrawArrows()

void Prs3d_DatumAspect::SetDrawArrows ( bool theToDraw )

inline

Sets option to draw or not arrows for axes.

◆ SetDrawDatumAxes()

void Prs3d_DatumAspect::SetDrawDatumAxes ( Prs3d_DatumAxes theType )

inline

Sets the axes used in the datum aspect.

◆ SetDrawLabels()

void Prs3d_DatumAspect::SetDrawLabels ( bool theToDraw )

inline

Sets option to draw or not to draw text labels for axes.

◆ SetPointAspect()

void Prs3d_DatumAspect::SetPointAspect ( const occ::handle< Prs3d_PointAspect > & theAspect )

inline

Returns the point aspect of origin wireframe presentation.

◆ SetTextAspect()

void Prs3d_DatumAspect::SetTextAspect ( const occ::handle< Prs3d_TextAspect > & theTextAspect )

inline

Sets text attributes for rendering labels.

◆ SetToDrawLabels()

void Prs3d_DatumAspect::SetToDrawLabels ( bool theToDraw )

inline

◆ ShadingAspect()

const occ::handle< Prs3d_ShadingAspect > & Prs3d_DatumAspect::ShadingAspect ( Prs3d_DatumParts thePart ) const

inline

Returns shading aspect for specified part.

◆ TextAspect()

const occ::handle< Prs3d_TextAspect > & Prs3d_DatumAspect::TextAspect ( Prs3d_DatumParts thePart ) const

inline

Returns the text attributes for rendering label of specified part (Prs3d_DatumParts_XAxis/Prs3d_DatumParts_YAxis/Prs3d_DatumParts_ZAxis).

◆ ToDrawArrows()

bool Prs3d_DatumAspect::ToDrawArrows ( ) const

inline

Returns: true if axes arrows are drawn; TRUE by default.

◆ ToDrawLabels()

bool Prs3d_DatumAspect::ToDrawLabels ( ) const

inline

Returns: true if axes labels are drawn; TRUE by default.

Field Documentation

◆ myArrowAspect

occ::handle<Prs3d_ArrowAspect> Prs3d_DatumAspect::myArrowAspect

◆ myAttributes

double Prs3d_DatumAspect::myAttributes[Prs3d_DatumAttribute_NB]

◆ myAxes

Prs3d_DatumAxes Prs3d_DatumAspect::myAxes

◆ myLineAspects

This method is deprecated TextAspect () with axis parameter should be called instead") const occ occ::handle<Prs3d_LineAspect> Prs3d_DatumAspect::myLineAspects[Prs3d_DatumParts_NB]

Returns the text attributes for rendering labels.

Deprecated: (

◆ myPointAspect

occ::handle<Prs3d_PointAspect> Prs3d_DatumAspect::myPointAspect

◆ myTextAspects

occ::handle<Prs3d_TextAspect> Prs3d_DatumAspect::myTextAspects[Prs3d_DatumParts_NB]

◆ myToDrawArrows

bool Prs3d_DatumAspect::myToDrawArrows

◆ myToDrawLabels

bool Prs3d_DatumAspect::myToDrawLabels

The documentation for this class was generated from the following file:

Prs3d_DatumAspect.hxx

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Prs3d_DatumAspect()

Member Function Documentation

◆ ArrowAspect()

◆ ArrowPartForAxis()

◆ Attribute()

◆ AxisLength()

◆ CopyAspectsFrom()

◆ DatumAxes()

◆ DrawDatumPart()

◆ DumpJson()

◆ LineAspect()

◆ PointAspect()

◆ SetArrowAspect()

◆ SetAttribute()

◆ SetAxisLength()

◆ SetDrawArrows()

◆ SetDrawDatumAxes()

◆ SetDrawLabels()

◆ SetPointAspect()

◆ SetTextAspect()

◆ SetToDrawLabels()

◆ ShadingAspect()

◆ TextAspect()

◆ ToDrawArrows()

◆ ToDrawLabels()

Field Documentation

◆ myArrowAspect

◆ myAttributes

◆ myAxes

◆ myLineAspects

◆ myPointAspect

◆ myTextAspects

◆ myToDrawArrows

◆ myToDrawLabels