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

#include <Prs3d_DatumAspect.hxx>

Inheritance diagram for Prs3d_DatumAspect:

Public Member Functions
	Prs3d_DatumAspect ()
	An empty framework to define the display of datums. More...

Handle< Prs3d_LineAspect >	LineAspect (Prs3d_DatumParts thePart) const
	Returns the right-handed coordinate system set in SetComponent. More...

Handle< Prs3d_ShadingAspect >	ShadingAspect (Prs3d_DatumParts thePart) const
	Returns the right-handed coordinate system set in SetComponent. More...

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

void	SetTextAspect (const Handle< Prs3d_TextAspect > &theTextAspect)
	Sets text attributes for rendering labels. More...

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

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

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

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

const Handle< Prs3d_LineAspect > &	FirstAxisAspect () const
	Returns the attributes for display of the first axis. More...

const Handle< Prs3d_LineAspect > &	SecondAxisAspect () const
	Returns the attributes for display of the second axis. More...

const Handle< Prs3d_LineAspect > &	ThirdAxisAspect () const
	Returns the attributes for display of the third axis. More...

void	SetDrawFirstAndSecondAxis (Standard_Boolean theToDraw)
	Sets the DrawFirstAndSecondAxis attributes to active. More...

Standard_Boolean	DrawFirstAndSecondAxis () const
	Returns true if the first and second axes can be drawn. More...

void	SetDrawThirdAxis (Standard_Boolean theToDraw)
	Sets the DrawThirdAxis attributes to active. More...

Standard_Boolean	DrawThirdAxis () const
	Returns true if the third axis can be drawn. More...

Standard_Boolean	DrawDatumPart (Prs3d_DatumParts thePart) const
	Returns true if the given part is used in axes of aspect. More...

void	SetDrawDatumAxes (Prs3d_DatumAxes theType)
	Sets the axes used in the datum aspect. More...

Prs3d_DatumAxes	DatumAxes () const
	Returns axes used in the datum aspect. More...

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

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

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

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

Standard_Real	FirstAxisLength () const
	Returns the length of the displayed first axis. More...

Standard_Real	SecondAxisLength () const
	Returns the length of the displayed second axis. More...

Standard_Real	ThirdAxisLength () const
	Returns the length of the displayed third axis. More...

Standard_Boolean	ToDrawLabels () const

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

void	SetToDrawLabels (Standard_Boolean theToDraw)

Standard_Boolean	ToDrawArrows () const

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

Prs3d_DatumParts	ArrowPartForAxis (Prs3d_DatumParts thePart) const
	Returns type of arrow for a type of axis. More...

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

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	Delete () const
	Memory deallocator for transient classes. More...

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

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

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

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

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

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

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

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

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

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object. More...

Static Public Member Functions inherited from Standard_Transient
static const char *	get_type_name ()
	Returns a type descriptor about this object. More...

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class. More...

Detailed Description

A framework to define the display of datums.

Constructor & Destructor Documentation

◆ Prs3d_DatumAspect()

Prs3d_DatumAspect::Prs3d_DatumAspect ( )

An empty framework to define the display of datums.

Member Function Documentation

◆ ArrowAspect()

const Handle< Prs3d_ArrowAspect >& Prs3d_DatumAspect::ArrowAspect ( ) const

inline

Returns the arrow aspect of presentation.

◆ ArrowPartForAxis()

Prs3d_DatumParts Prs3d_DatumAspect::ArrowPartForAxis ( Prs3d_DatumParts thePart ) const

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.

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

◆ DrawFirstAndSecondAxis()

Standard_Boolean Prs3d_DatumAspect::DrawFirstAndSecondAxis ( ) const

inline

Returns true if the first and second axes can be drawn.

Deprecated:: ("This method is deprecated - DatumAxes() should be called instead")

◆ DrawThirdAxis()

Standard_Boolean Prs3d_DatumAspect::DrawThirdAxis ( ) const

inline

Returns true if the third axis can be drawn.

Deprecated:: ("This method is deprecated - DatumAxes() should be called instead")

◆ DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Implements Prs3d_BasicAspect.

◆ FirstAxisAspect()

const Handle< Prs3d_LineAspect >& Prs3d_DatumAspect::FirstAxisAspect ( ) const

inline

Returns the attributes for display of the first axis.

Deprecated:: ("This method is deprecated - LineAspect() should be called instead")

◆ FirstAxisLength()

Standard_Real Prs3d_DatumAspect::FirstAxisLength ( ) const

inline

Returns the length of the displayed first axis.

Deprecated:: ("This method is deprecated - AxisLength() should be called instead")

◆ LineAspect()

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

Returns the right-handed coordinate system set in SetComponent.

◆ PointAspect()

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

inline

Returns the point aspect of origin wireframe presentation.

◆ SecondAxisAspect()

const Handle< Prs3d_LineAspect >& Prs3d_DatumAspect::SecondAxisAspect ( ) const

inline

Returns the attributes for display of the second axis.

Deprecated:: ("This method is deprecated - LineAspect() should be called instead")

◆ SecondAxisLength()

Standard_Real Prs3d_DatumAspect::SecondAxisLength ( ) const

inline

Returns the length of the displayed second axis.

Deprecated:: ("This method is deprecated - AxisLength() should be called instead")

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

◆ SetDrawFirstAndSecondAxis()

void Prs3d_DatumAspect::SetDrawFirstAndSecondAxis ( Standard_Boolean theToDraw )

Sets the DrawFirstAndSecondAxis attributes to active.

Deprecated:: ("This method is deprecated - SetDrawDatumAxes() should be called instead")

◆ SetDrawLabels()

void Prs3d_DatumAspect::SetDrawLabels ( Standard_Boolean theToDraw )

inline

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

◆ SetDrawThirdAxis()

void Prs3d_DatumAspect::SetDrawThirdAxis ( Standard_Boolean theToDraw )

Sets the DrawThirdAxis attributes to active.

Deprecated:: ("This method is deprecated - SetDrawDatumAxes() should be called instead")

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

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

Returns the right-handed coordinate system set in SetComponent.

◆ TextAspect()

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

inline

Returns the text attributes for rendering labels.

◆ ThirdAxisAspect()

const Handle< Prs3d_LineAspect >& Prs3d_DatumAspect::ThirdAxisAspect ( ) const

inline

Returns the attributes for display of the third axis.

Deprecated:: ("This method is deprecated - LineAspect() should be called instead")

◆ ThirdAxisLength()

Standard_Real Prs3d_DatumAspect::ThirdAxisLength ( ) const

inline

Returns the length of the displayed third axis.

Deprecated:: ("This method is deprecated - AxisLength() should be called instead")

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

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

Prs3d_DatumAspect.hxx

Prs3d_DatumAspect Class Reference

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Prs3d_DatumAspect()

Member Function Documentation

◆ ArrowAspect()

◆ ArrowPartForAxis()

◆ Attribute()

◆ AxisLength()

◆ DatumAxes()

◆ DrawDatumPart()

◆ DrawFirstAndSecondAxis()

◆ DrawThirdAxis()

◆ DumpJson()

◆ FirstAxisAspect()

◆ FirstAxisLength()

◆ LineAspect()

◆ PointAspect()

◆ SecondAxisAspect()

◆ SecondAxisLength()

◆ SetArrowAspect()

◆ SetAttribute()

◆ SetAxisLength()

◆ SetDrawArrows()

◆ SetDrawDatumAxes()

◆ SetDrawFirstAndSecondAxis()

◆ SetDrawLabels()

◆ SetDrawThirdAxis()

◆ SetPointAspect()

◆ SetTextAspect()

◆ SetToDrawLabels()

◆ ShadingAspect()

◆ TextAspect()

◆ ThirdAxisAspect()

◆ ThirdAxisLength()

◆ ToDrawArrows()

◆ ToDrawLabels()