Class for presentation of trihedron object. More...

#include <V3d_Trihedron.hxx>

Inheritance diagram for V3d_Trihedron:

Public Member Functions
	V3d_Trihedron ()
	Creates a default trihedron.

	~V3d_Trihedron () override
	Destructor.

bool	IsWireframe () const
	Return TRUE if wireframe presentation is set; FALSE by default.

void	SetWireframe (const bool theAsWireframe)
	Switch wireframe / shaded trihedron.

const occ::handle< Graphic3d_TransformPers >	TransformPersistence () const
	Return trihedron position.

void	SetPosition (const Aspect_TypeOfTriedronPosition thePosition)
	Setup the corner to draw the trihedron.

double	Scale () const
	Return scale factor.

void	SetScale (const double theScale)
	Setup the scale factor.

double	SizeRatio () const
	Return size ratio factor.

void	SetSizeRatio (const double theRatio)
	Setup the size ratio factor.

double	ArrowDiameter () const
	Return arrow diameter.

void	SetArrowDiameter (const double theDiam)
	Setup the arrow diameter.

int	NbFacets () const
	Return number of facets for tessellation.

void	SetNbFacets (const int theNbFacets)
	Setup the number of facets for tessellation.

const occ::handle< Prs3d_TextAspect > &	LabelAspect (V3d_TypeOfAxe theAxis) const
	Return text aspect for specified axis.

void	SetLabelsColor (const Quantity_Color &theXColor, const Quantity_Color &theYColor, const Quantity_Color &theZColor)
	Setup per-label color.

void	SetLabelsColor (const Quantity_Color &theColor)
	Setup color of text labels.

const occ::handle< Prs3d_ShadingAspect > &	ArrowAspect (V3d_TypeOfAxe theAxis) const
	Return shading aspect for specified axis.

void	SetArrowsColor (const Quantity_Color &theXColor, const Quantity_Color &theYColor, const Quantity_Color &theZColor)
	Setup colors of arrows.

const occ::handle< Prs3d_ShadingAspect > &	OriginAspect () const
	Return shading aspect of origin sphere.

const TCollection_AsciiString &	Label (V3d_TypeOfAxe theAxis) const
	Return axis text.

void	SetLabels (const TCollection_AsciiString &theX, const TCollection_AsciiString &theY, const TCollection_AsciiString &theZ)
	Setup per-axis text.

void	Display (const occ::handle< V3d_View > &theView)
	Display trihedron.

void	Display (const V3d_View &theView)
	Display trihedron.

void	Erase ()
	Erase trihedron.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	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.

Protected Member Functions
void	compute ()
	Fills Graphic3d_Group.

void	invalidate ()
	Invalidates objects. It leads recompute.

void	setOffset2d ()
	Sets offset 2d for transform persistence.

Protected Attributes
occ::handle< Prs3d_ShadingAspect >	mySphereShadingAspect

occ::handle< Prs3d_TextAspect >	myTextAspects [3]

occ::handle< Prs3d_ShadingAspect >	myArrowShadingAspects [3]

TCollection_AsciiString	myLabels [3]

occ::handle< Graphic3d_Structure >	myStructure

occ::handle< Graphic3d_TransformPers >	myTransformPers

double	myScale

double	myRatio

double	myDiameter

int	myNbFacettes

bool	myIsWireframe

bool	myToCompute

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

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.

Detailed Description

Class for presentation of trihedron object.

Constructor & Destructor Documentation

◆ V3d_Trihedron()

V3d_Trihedron::V3d_Trihedron ( )

Creates a default trihedron.

◆ ~V3d_Trihedron()

V3d_Trihedron::~V3d_Trihedron ( )

override

Destructor.

Member Function Documentation

◆ ArrowAspect()

const occ::handle< Prs3d_ShadingAspect > & V3d_Trihedron::ArrowAspect ( V3d_TypeOfAxe theAxis ) const

inline

Return shading aspect for specified axis.

Parameters

[in] theAxis axis index

Returns: shading aspect

◆ ArrowDiameter()

double V3d_Trihedron::ArrowDiameter ( ) const

inline

Return arrow diameter.

◆ compute()

void V3d_Trihedron::compute ( )

protected

Fills Graphic3d_Group.

◆ Display() [1/2]

void V3d_Trihedron::Display ( const occ::handle< V3d_View > & theView )

inline

Display trihedron.

◆ Display() [2/2]

void V3d_Trihedron::Display ( const V3d_View & theView )

Display trihedron.

◆ DumpJson()

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

Dumps the content of me into the stream.

◆ Erase()

void V3d_Trihedron::Erase ( )

Erase trihedron.

◆ invalidate()

void V3d_Trihedron::invalidate ( )

inlineprotected

Invalidates objects. It leads recompute.

◆ IsWireframe()

bool V3d_Trihedron::IsWireframe ( ) const

inline

Return TRUE if wireframe presentation is set; FALSE by default.

◆ Label()

const TCollection_AsciiString & V3d_Trihedron::Label ( V3d_TypeOfAxe theAxis ) const

inline

Return axis text.

Parameters

[in] theAxis axis index

Returns: text of the label

◆ LabelAspect()

const occ::handle< Prs3d_TextAspect > & V3d_Trihedron::LabelAspect ( V3d_TypeOfAxe theAxis ) const

inline

Return text aspect for specified axis.

Parameters

[in] theAxis axis index

Returns: text aspect

◆ NbFacets()

int V3d_Trihedron::NbFacets ( ) const

inline

Return number of facets for tessellation.

◆ OriginAspect()

const occ::handle< Prs3d_ShadingAspect > & V3d_Trihedron::OriginAspect ( ) const

inline

Return shading aspect of origin sphere.

◆ Scale()

double V3d_Trihedron::Scale ( ) const

inline

Return scale factor.

◆ SetArrowDiameter()

void V3d_Trihedron::SetArrowDiameter ( const double theDiam )

Setup the arrow diameter.

◆ SetArrowsColor()

void V3d_Trihedron::SetArrowsColor	(	const Quantity_Color &	theXColor,
		const Quantity_Color &	theYColor,
		const Quantity_Color &	theZColor )

Setup colors of arrows.

◆ SetLabels()

void V3d_Trihedron::SetLabels	(	const TCollection_AsciiString &	theX,
		const TCollection_AsciiString &	theY,
		const TCollection_AsciiString &	theZ )

Setup per-axis text.

◆ SetLabelsColor() [1/2]

void V3d_Trihedron::SetLabelsColor ( const Quantity_Color & theColor )

Setup color of text labels.

◆ SetLabelsColor() [2/2]

void V3d_Trihedron::SetLabelsColor	(	const Quantity_Color &	theXColor,
		const Quantity_Color &	theYColor,
		const Quantity_Color &	theZColor )

Setup per-label color.

◆ SetNbFacets()

void V3d_Trihedron::SetNbFacets ( const int theNbFacets )

Setup the number of facets for tessellation.

◆ setOffset2d()

void V3d_Trihedron::setOffset2d ( )

protected

Sets offset 2d for transform persistence.

◆ SetPosition()

void V3d_Trihedron::SetPosition ( const Aspect_TypeOfTriedronPosition thePosition )

Setup the corner to draw the trihedron.

◆ SetScale()

void V3d_Trihedron::SetScale ( const double theScale )

Setup the scale factor.

◆ SetSizeRatio()

void V3d_Trihedron::SetSizeRatio ( const double theRatio )

Setup the size ratio factor.

◆ SetWireframe()

void V3d_Trihedron::SetWireframe ( const bool theAsWireframe )

inline

Switch wireframe / shaded trihedron.

◆ SizeRatio()

double V3d_Trihedron::SizeRatio ( ) const

inline

Return size ratio factor.

◆ TransformPersistence()

const occ::handle< Graphic3d_TransformPers > V3d_Trihedron::TransformPersistence ( ) const

inline

Return trihedron position.

Field Documentation

◆ myArrowShadingAspects

occ::handle<Prs3d_ShadingAspect> V3d_Trihedron::myArrowShadingAspects[3]

protected

◆ myDiameter

double V3d_Trihedron::myDiameter

protected

◆ myIsWireframe

bool V3d_Trihedron::myIsWireframe

protected

◆ myLabels

TCollection_AsciiString V3d_Trihedron::myLabels[3]

protected

◆ myNbFacettes

int V3d_Trihedron::myNbFacettes

protected

◆ myRatio

double V3d_Trihedron::myRatio

protected

◆ myScale

double V3d_Trihedron::myScale

protected

◆ mySphereShadingAspect

occ::handle<Prs3d_ShadingAspect> V3d_Trihedron::mySphereShadingAspect

protected

◆ myStructure

occ::handle<Graphic3d_Structure> V3d_Trihedron::myStructure

protected

◆ myTextAspects

occ::handle<Prs3d_TextAspect> V3d_Trihedron::myTextAspects[3]

protected

◆ myToCompute

bool V3d_Trihedron::myToCompute

protected

◆ myTransformPers

occ::handle<Graphic3d_TransformPers> V3d_Trihedron::myTransformPers

protected

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

V3d_Trihedron.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ V3d_Trihedron()

◆ ~V3d_Trihedron()

Member Function Documentation

◆ ArrowAspect()

◆ ArrowDiameter()

◆ compute()

◆ Display() [1/2]

◆ Display() [2/2]

◆ DumpJson()

◆ Erase()

◆ invalidate()

◆ IsWireframe()

◆ Label()

◆ LabelAspect()

◆ NbFacets()

◆ OriginAspect()

◆ Scale()

◆ SetArrowDiameter()

◆ SetArrowsColor()

◆ SetLabels()

◆ SetLabelsColor() [1/2]

◆ SetLabelsColor() [2/2]

◆ SetNbFacets()

◆ setOffset2d()

◆ SetPosition()

◆ SetScale()

◆ SetSizeRatio()

◆ SetWireframe()

◆ SizeRatio()

◆ TransformPersistence()

Field Documentation

◆ myArrowShadingAspects

◆ myDiameter

◆ myIsWireframe

◆ myLabels

◆ myNbFacettes

◆ myRatio

◆ myScale

◆ mySphereShadingAspect

◆ myStructure

◆ myTextAspects

◆ myToCompute

◆ myTransformPers