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.

virtual	~V3d_Trihedron ()
	Destructor.

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

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

const Handle< Graphic3d_TransformPers >	TransformPersistence () const
	Return trihedron position.

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

Standard_Real	Scale () const
	Return scale factor.

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

Standard_Real	SizeRatio () const
	Return size ratio factor.

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

Standard_Real	ArrowDiameter () const
	Return arrow diameter.

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

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

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

const 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 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 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 Handle< V3d_View > &theView)
	Display trihedron.

void	Display (const V3d_View &theView)
	Display trihedron.

void	Erase ()
	Erase trihedron.

void	DumpJson (Standard_OStream &theOStream, Standard_Integer 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 ()
	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.

Protected Member Functions
void	compute ()
	Fills Graphic3d_Group.

void	invalidate ()
	Invalidates objects. It leads recompute.

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

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

virtual V3d_Trihedron::~V3d_Trihedron ( )

virtual

Destructor.

Member Function Documentation

◆ ArrowAspect()

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

inline

Return shading aspect for specified axis.

Parameters

theAxis [in] axis index

Returns: shading aspect

◆ ArrowDiameter()

Standard_Real 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 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,
		Standard_Integer	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

theAxis [in] axis index

Returns: text of the label

◆ LabelAspect()

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

inline

Return text aspect for specified axis.

Parameters

theAxis [in] axis index

Returns: text aspect

◆ NbFacets()

Standard_Integer V3d_Trihedron::NbFacets ( ) const

inline

Return number of facets for tessellation.

◆ OriginAspect()

const Handle< Prs3d_ShadingAspect > & V3d_Trihedron::OriginAspect ( ) const

inline

Return shading aspect of origin sphere.

◆ Scale()

Standard_Real V3d_Trihedron::Scale ( ) const

inline

Return scale factor.

◆ SetArrowDiameter()

void V3d_Trihedron::SetArrowDiameter ( const Standard_Real 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 Standard_Integer 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 Standard_Real theScale )

Setup the scale factor.

◆ SetSizeRatio()

void V3d_Trihedron::SetSizeRatio ( const Standard_Real theRatio )

Setup the size ratio factor.

◆ SetWireframe()

void V3d_Trihedron::SetWireframe ( const Standard_Boolean theAsWireframe )

inline

Switch wireframe / shaded trihedron.

◆ SizeRatio()

Standard_Real V3d_Trihedron::SizeRatio ( ) const

inline

Return size ratio factor.

◆ TransformPersistence()

const Handle< Graphic3d_TransformPers > V3d_Trihedron::TransformPersistence ( ) const

inline

Return trihedron position.

Field Documentation

◆ myArrowShadingAspects

Handle< Prs3d_ShadingAspect > V3d_Trihedron::myArrowShadingAspects[3]

protected

◆ myDiameter

Standard_Real V3d_Trihedron::myDiameter

protected

◆ myIsWireframe

Standard_Boolean V3d_Trihedron::myIsWireframe

protected

◆ myLabels

TCollection_AsciiString V3d_Trihedron::myLabels[3]

protected

◆ myNbFacettes

Standard_Integer V3d_Trihedron::myNbFacettes

protected

◆ myRatio

Standard_Real V3d_Trihedron::myRatio

protected

◆ myScale

Standard_Real V3d_Trihedron::myScale

protected

◆ mySphereShadingAspect

Handle< Prs3d_ShadingAspect > V3d_Trihedron::mySphereShadingAspect

protected

◆ myStructure

Handle< Graphic3d_Structure > V3d_Trihedron::myStructure

protected

◆ myTextAspects

Handle< Prs3d_TextAspect > V3d_Trihedron::myTextAspects[3]

protected

◆ myToCompute

Standard_Boolean V3d_Trihedron::myToCompute

protected

◆ myTransformPers

Handle< Graphic3d_TransformPers > V3d_Trihedron::myTransformPers

protected

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

V3d_Trihedron.hxx

Protected Attributes
Handle< Prs3d_ShadingAspect >	mySphereShadingAspect

Handle< Prs3d_TextAspect >	myTextAspects [3]

Handle< Prs3d_ShadingAspect >	myArrowShadingAspects [3]

TCollection_AsciiString	myLabels [3]

Handle< Graphic3d_Structure >	myStructure

Handle< Graphic3d_TransformPers >	myTransformPers

Standard_Real	myScale

Standard_Real	myRatio

Standard_Real	myDiameter

Standard_Integer	myNbFacettes

Standard_Boolean	myIsWireframe

Standard_Boolean	myToCompute

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