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 Handle< Prs3d_LineAspect > &	LineAspect (Prs3d_DatumParts thePart) const
	Returns line aspect for specified part.

const Handle< Prs3d_ShadingAspect > &	ShadingAspect (Prs3d_DatumParts thePart) const
	Returns shading aspect for specified part.

const 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 Handle< Prs3d_TextAspect > &theTextAspect)
	Sets text attributes for rendering labels.

const Handle< Prs3d_PointAspect > &	PointAspect () const
	Returns the point aspect of origin wireframe presentation.

void	SetPointAspect (const Handle< Prs3d_PointAspect > &theAspect)
	Returns the point aspect of origin wireframe presentation.

const Handle< Prs3d_ArrowAspect > &	ArrowAspect () const
	Returns the arrow aspect of presentation.

void	SetArrowAspect (const Handle< Prs3d_ArrowAspect > &theAspect)
	Sets the arrow aspect of presentation.

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

Standard_Real	Attribute (Prs3d_DatumAttribute theType) const
	Returns the attribute of the datum type.

void	SetAttribute (Prs3d_DatumAttribute theType, const Standard_Real theValue)
	Sets the attribute of the datum type.

Standard_Real	AxisLength (Prs3d_DatumParts thePart) const
	Returns the length of the displayed first axis.

void	SetAxisLength (Standard_Real theL1, Standard_Real theL2, Standard_Real theL3)
	Sets the lengths of the three axes.

Standard_Boolean	ToDrawLabels () const

void	SetDrawLabels (Standard_Boolean theToDraw)
	Sets option to draw or not to draw text labels for axes.

void	SetToDrawLabels (Standard_Boolean theToDraw)

Standard_Boolean	ToDrawArrows () const

void	SetDrawArrows (Standard_Boolean theToDraw)
	Sets option to draw or not arrows for axes.

void	CopyAspectsFrom (const Handle< Prs3d_DatumAspect > &theOther)
	Performs deep copy of attributes from another aspect instance.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

const Handle< Prs3d_TextAspect > &	TextAspect () const
	Returns the text attributes for rendering labels.

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 ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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

Standard_Boolean	IsKind (const Standard_CString 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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

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 Public Member Functions inherited from Standard_Transient
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.

Additional Inherited Members
Public Types inherited from Standard_Transient
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 Handle< Prs3d_ArrowAspect > & Prs3d_DatumAspect::ArrowAspect ( ) const

inline

Returns the arrow aspect of presentation.

◆ ArrowPartForAxis()

static Prs3d_DatumParts Prs3d_DatumAspect::ArrowPartForAxis ( Prs3d_DatumParts thePart )

static

Returns type of arrow for a type of axis.

◆ Attribute()

Standard_Real Prs3d_DatumAspect::Attribute ( Prs3d_DatumAttribute theType ) const

inline

Returns the attribute of the datum type.

◆ AxisLength()

Standard_Real Prs3d_DatumAspect::AxisLength ( Prs3d_DatumParts thePart ) const

Returns the length of the displayed first axis.

◆ CopyAspectsFrom()

void Prs3d_DatumAspect::CopyAspectsFrom ( const 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()

Standard_Boolean Prs3d_DatumAspect::DrawDatumPart ( Prs3d_DatumParts thePart ) const

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

◆ DumpJson()

virtual void Prs3d_DatumAspect::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

◆ LineAspect()

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

inline

Returns line aspect for specified part.

◆ PointAspect()

const Handle< Prs3d_PointAspect > & Prs3d_DatumAspect::PointAspect ( ) const

inline

Returns the point aspect of origin wireframe presentation.

◆ SetArrowAspect()

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

inline

Sets the arrow aspect of presentation.

◆ SetAttribute()

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

inline

Sets the attribute of the datum type.

◆ SetAxisLength()

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

inline

Sets the lengths of the three axes.

◆ SetDrawArrows()

void Prs3d_DatumAspect::SetDrawArrows ( Standard_Boolean 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 ( Standard_Boolean theToDraw )

inline

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

◆ SetPointAspect()

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

inline

Returns the point aspect of origin wireframe presentation.

◆ SetTextAspect()

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

inline

Sets text attributes for rendering labels.

◆ SetToDrawLabels()

void Prs3d_DatumAspect::SetToDrawLabels ( Standard_Boolean theToDraw )

inline

◆ ShadingAspect()

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

inline

Returns shading aspect for specified part.

◆ TextAspect() [1/2]

const Handle< Prs3d_TextAspect > & Prs3d_DatumAspect::TextAspect ( ) const

inline

Returns the text attributes for rendering labels.

Deprecated:: ("This method is deprecated - TextAspect() with axis parameter should be called instead")

◆ TextAspect() [2/2]

const 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()

Standard_Boolean Prs3d_DatumAspect::ToDrawArrows ( ) const

inline

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

◆ ToDrawLabels()

Standard_Boolean Prs3d_DatumAspect::ToDrawLabels ( ) const

inline

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

Field Documentation

◆ myArrowAspect

Handle< Prs3d_ArrowAspect > Prs3d_DatumAspect::myArrowAspect

protected

◆ myAttributes

Standard_Real Prs3d_DatumAspect::myAttributes[Prs3d_DatumAttribute_NB]

protected

◆ myAxes

Prs3d_DatumAxes Prs3d_DatumAspect::myAxes

protected

◆ myLineAspects

Handle< Prs3d_LineAspect > Prs3d_DatumAspect::myLineAspects[Prs3d_DatumParts_NB]

protected

◆ myPointAspect

Handle< Prs3d_PointAspect > Prs3d_DatumAspect::myPointAspect

protected

◆ myShadedAspects

Handle< Prs3d_ShadingAspect > Prs3d_DatumAspect::myShadedAspects[Prs3d_DatumParts_NB]

protected

◆ myTextAspects

Handle< Prs3d_TextAspect > Prs3d_DatumAspect::myTextAspects[Prs3d_DatumParts_NB]

protected

◆ myToDrawArrows

Standard_Boolean Prs3d_DatumAspect::myToDrawArrows

protected

◆ myToDrawLabels

Standard_Boolean Prs3d_DatumAspect::myToDrawLabels

protected

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

Prs3d_DatumAspect.hxx

Protected Attributes
Handle< Prs3d_ShadingAspect >	myShadedAspects [Prs3d_DatumParts_NB]

Handle< Prs3d_LineAspect >	myLineAspects [Prs3d_DatumParts_NB]

Handle< Prs3d_TextAspect >	myTextAspects [Prs3d_DatumParts_NB]

Handle< Prs3d_PointAspect >	myPointAspect

Handle< Prs3d_ArrowAspect >	myArrowAspect

Standard_Real	myAttributes [Prs3d_DatumAttribute_NB]

Prs3d_DatumAxes	myAxes

Standard_Boolean	myToDrawLabels

Standard_Boolean	myToDrawArrows

Public Member Functions

Static Public Member Functions

Protected Attributes

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() [1/2]

◆ TextAspect() [2/2]

◆ ToDrawArrows()

◆ ToDrawLabels()

Field Documentation

◆ myArrowAspect

◆ myAttributes

◆ myAxes

◆ myLineAspects

◆ myPointAspect

◆ myShadedAspects

◆ myTextAspects

◆ myToDrawArrows

◆ myToDrawLabels