Open CASCADE Technology  7.7.0.dev
Public Member Functions | Protected Member Functions | Protected Attributes

V3d_Trihedron Class Reference

Class for presentation of trihedron object. More...

#include <V3d_Trihedron.hxx>

Inheritance diagram for V3d_Trihedron:
Inheritance graph
[legend]

Public Member Functions

 V3d_Trihedron ()
 Creates a default trihedron. More...
 
virtual ~V3d_Trihedron ()
 Destructor. More...
 
bool IsWireframe () const
 Return TRUE if wireframe presentation is set; FALSE by default. More...
 
void SetWireframe (const Standard_Boolean theAsWireframe)
 Switch wireframe / shaded trihedron. More...
 
const Handle< Graphic3d_TransformPersTransformPersistence () const
 Return trihedron position. More...
 
void SetPosition (const Aspect_TypeOfTriedronPosition thePosition)
 Setup the corner to draw the trihedron. More...
 
Standard_Real Scale () const
 Return scale factor. More...
 
void SetScale (const Standard_Real theScale)
 Setup the scale factor. More...
 
Standard_Real SizeRatio () const
 Return size ratio factor. More...
 
void SetSizeRatio (const Standard_Real theRatio)
 Setup the size ratio factor. More...
 
Standard_Real ArrowDiameter () const
 Return arrow diameter. More...
 
void SetArrowDiameter (const Standard_Real theDiam)
 Setup the arrow diameter. More...
 
Standard_Integer NbFacets () const
 Return number of facets for tessellation. More...
 
void SetNbFacets (const Standard_Integer theNbFacets)
 Setup the number of facets for tessellation. More...
 
const Handle< Prs3d_TextAspect > & LabelAspect (V3d_TypeOfAxe theAxis) const
 Return text aspect for specified axis. More...
 
void SetLabelsColor (const Quantity_Color &theXColor, const Quantity_Color &theYColor, const Quantity_Color &theZColor)
 Setup per-label color. More...
 
void SetLabelsColor (const Quantity_Color &theColor)
 Setup color of text labels. More...
 
const Handle< Prs3d_ShadingAspect > & ArrowAspect (V3d_TypeOfAxe theAxis) const
 Return shading aspect for specified axis. More...
 
void SetArrowsColor (const Quantity_Color &theXColor, const Quantity_Color &theYColor, const Quantity_Color &theZColor)
 Setup colors of arrows. More...
 
const Handle< Prs3d_ShadingAspect > & OriginAspect () const
 Return shading aspect of origin sphere. More...
 
const TCollection_AsciiStringLabel (V3d_TypeOfAxe theAxis) const
 Return axis text. More...
 
void SetLabels (const TCollection_AsciiString &theX, const TCollection_AsciiString &theY, const TCollection_AsciiString &theZ)
 Setup per-axis text. More...
 
void Display (const Handle< V3d_View > &theView)
 Display trihedron. More...
 
void Display (const V3d_View &theView)
 Display trihedron. More...
 
void Erase ()
 Erase trihedron. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 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_Transientoperator= (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_TransientThis () 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...
 

Protected Member Functions

void compute ()
 Fills Graphic3d_Group. More...
 
void invalidate ()
 Invalidates objects. It leads recompute. More...
 
void setOffset2d ()
 Sets offset 2d for transform persistence. More...
 

Protected Attributes

Handle< Prs3d_ShadingAspectmySphereShadingAspect
 
Handle< Prs3d_TextAspectmyTextAspects [3]
 
Handle< Prs3d_ShadingAspectmyArrowShadingAspects [3]
 
TCollection_AsciiString myLabels [3]
 
Handle< Graphic3d_StructuremyStructure
 
Handle< Graphic3d_TransformPersmyTransformPers
 
Standard_Real myScale
 
Standard_Real myRatio
 
Standard_Real myDiameter
 
Standard_Integer myNbFacettes
 
Standard_Boolean myIsWireframe
 
Standard_Boolean myToCompute
 

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

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

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