Open CASCADE Technology 7.9.0
 
Loading...
Searching...
No Matches
Data Structures | Public Types | Public Member Functions | Protected Attributes
Graphic3d_GraduatedTrihedron Class Reference

Defines the class of a graduated trihedron. It contains main style parameters for implementation of graduated trihedron. More...

#include <Graphic3d_GraduatedTrihedron.hxx>

Data Structures

class  AxisAspect
 Class that stores style for one graduated trihedron axis such as colors, lengths and customization flags. It is used in Graphic3d_GraduatedTrihedron. More...
 

Public Types

typedef void(* MinMaxValuesCallback) (Graphic3d_CView *)
 

Public Member Functions

 Graphic3d_GraduatedTrihedron (const TCollection_AsciiString &theNamesFont="Arial", const Font_FontAspect &theNamesStyle=Font_FA_Bold, const Standard_Integer theNamesSize=12, const TCollection_AsciiString &theValuesFont="Arial", const Font_FontAspect &theValuesStyle=Font_FA_Regular, const Standard_Integer theValuesSize=12, const Standard_ShortReal theArrowsLength=30.0f, const Quantity_Color theGridColor=Quantity_NOC_WHITE, const Standard_Boolean theToDrawGrid=Standard_True, const Standard_Boolean theToDrawAxes=Standard_True)
 Default constructor Constructs the default graduated trihedron with grid, X, Y, Z axes, and tickmarks.
 
AxisAspect & ChangeXAxisAspect ()
 
AxisAspect & ChangeYAxisAspect ()
 
AxisAspect & ChangeZAxisAspect ()
 
AxisAspect & ChangeAxisAspect (const Standard_Integer theIndex)
 
const AxisAspect & XAxisAspect () const
 
const AxisAspect & YAxisAspect () const
 
const AxisAspect & ZAxisAspect () const
 
const AxisAspect & AxisAspectAt (const Standard_Integer theIndex) const
 
Standard_ShortReal ArrowsLength () const
 
void SetArrowsLength (const Standard_ShortReal theValue)
 
const Quantity_Color & GridColor () const
 
void SetGridColor (const Quantity_Color &theColor)
 
Standard_Boolean ToDrawGrid () const
 
void SetDrawGrid (const Standard_Boolean theToDraw)
 
Standard_Boolean ToDrawAxes () const
 
void SetDrawAxes (const Standard_Boolean theToDraw)
 
const TCollection_AsciiString & NamesFont () const
 
void SetNamesFont (const TCollection_AsciiString &theFont)
 
Font_FontAspect NamesFontAspect () const
 
void SetNamesFontAspect (Font_FontAspect theAspect)
 
Standard_Integer NamesSize () const
 
void SetNamesSize (const Standard_Integer theValue)
 
const TCollection_AsciiString & ValuesFont () const
 
void SetValuesFont (const TCollection_AsciiString &theFont)
 
Font_FontAspect ValuesFontAspect () const
 
void SetValuesFontAspect (Font_FontAspect theAspect)
 
Standard_Integer ValuesSize () const
 
void SetValuesSize (const Standard_Integer theValue)
 
Standard_Boolean CubicAxesCallback (Graphic3d_CView *theView) const
 
void SetCubicAxesCallback (const MinMaxValuesCallback theCallback)
 

Protected Attributes

MinMaxValuesCallback myCubicAxesCallback
 Callback function to define boundary box of displayed objects.
 
TCollection_AsciiString myNamesFont
 Font name of names of axes: Courier, Arial, ...
 
Font_FontAspect myNamesStyle
 Style of names of axes: OSD_FA_Regular, OSD_FA_Bold,..
 
Standard_Integer myNamesSize
 Size of names of axes: 8, 10,..
 
TCollection_AsciiString myValuesFont
 Font name of values: Courier, Arial, ...
 
Font_FontAspect myValuesStyle
 Style of values: OSD_FA_Regular, OSD_FA_Bold, ...
 
Standard_Integer myValuesSize
 Size of values: 8, 10, 12, 14, ...
 
Standard_ShortReal myArrowsLength
 
Quantity_Color myGridColor
 
Standard_Boolean myToDrawGrid
 
Standard_Boolean myToDrawAxes
 
NCollection_Array1< AxisAspect > myAxes
 X, Y and Z axes parameters.
 

Detailed Description

Defines the class of a graduated trihedron. It contains main style parameters for implementation of graduated trihedron.

See also
OpenGl_GraduatedTrihedron

Member Typedef Documentation

◆ MinMaxValuesCallback

typedef void(* Graphic3d_GraduatedTrihedron::MinMaxValuesCallback) (Graphic3d_CView *)

Constructor & Destructor Documentation

◆ Graphic3d_GraduatedTrihedron()

Graphic3d_GraduatedTrihedron::Graphic3d_GraduatedTrihedron ( const TCollection_AsciiString & theNamesFont = "Arial",
const Font_FontAspect & theNamesStyle = Font_FA_Bold,
const Standard_Integer theNamesSize = 12,
const TCollection_AsciiString & theValuesFont = "Arial",
const Font_FontAspect & theValuesStyle = Font_FA_Regular,
const Standard_Integer theValuesSize = 12,
const Standard_ShortReal theArrowsLength = 30.0f,
const Quantity_Color theGridColor = Quantity_NOC_WHITE,
const Standard_Boolean theToDrawGrid = Standard_True,
const Standard_Boolean theToDrawAxes = Standard_True )
inline

Default constructor Constructs the default graduated trihedron with grid, X, Y, Z axes, and tickmarks.

Member Function Documentation

◆ ArrowsLength()

Standard_ShortReal Graphic3d_GraduatedTrihedron::ArrowsLength ( ) const
inline

◆ AxisAspectAt()

const AxisAspect & Graphic3d_GraduatedTrihedron::AxisAspectAt ( const Standard_Integer theIndex) const
inline

◆ ChangeAxisAspect()

AxisAspect & Graphic3d_GraduatedTrihedron::ChangeAxisAspect ( const Standard_Integer theIndex)
inline

◆ ChangeXAxisAspect()

AxisAspect & Graphic3d_GraduatedTrihedron::ChangeXAxisAspect ( )
inline

◆ ChangeYAxisAspect()

AxisAspect & Graphic3d_GraduatedTrihedron::ChangeYAxisAspect ( )
inline

◆ ChangeZAxisAspect()

AxisAspect & Graphic3d_GraduatedTrihedron::ChangeZAxisAspect ( )
inline

◆ CubicAxesCallback()

Standard_Boolean Graphic3d_GraduatedTrihedron::CubicAxesCallback ( Graphic3d_CView * theView) const
inline

◆ GridColor()

const Quantity_Color & Graphic3d_GraduatedTrihedron::GridColor ( ) const
inline

◆ NamesFont()

const TCollection_AsciiString & Graphic3d_GraduatedTrihedron::NamesFont ( ) const
inline

◆ NamesFontAspect()

Font_FontAspect Graphic3d_GraduatedTrihedron::NamesFontAspect ( ) const
inline

◆ NamesSize()

Standard_Integer Graphic3d_GraduatedTrihedron::NamesSize ( ) const
inline

◆ SetArrowsLength()

void Graphic3d_GraduatedTrihedron::SetArrowsLength ( const Standard_ShortReal theValue)
inline

◆ SetCubicAxesCallback()

void Graphic3d_GraduatedTrihedron::SetCubicAxesCallback ( const MinMaxValuesCallback theCallback)
inline

◆ SetDrawAxes()

void Graphic3d_GraduatedTrihedron::SetDrawAxes ( const Standard_Boolean theToDraw)
inline

◆ SetDrawGrid()

void Graphic3d_GraduatedTrihedron::SetDrawGrid ( const Standard_Boolean theToDraw)
inline

◆ SetGridColor()

void Graphic3d_GraduatedTrihedron::SetGridColor ( const Quantity_Color & theColor)
inline

◆ SetNamesFont()

void Graphic3d_GraduatedTrihedron::SetNamesFont ( const TCollection_AsciiString & theFont)
inline

◆ SetNamesFontAspect()

void Graphic3d_GraduatedTrihedron::SetNamesFontAspect ( Font_FontAspect theAspect)
inline

◆ SetNamesSize()

void Graphic3d_GraduatedTrihedron::SetNamesSize ( const Standard_Integer theValue)
inline

◆ SetValuesFont()

void Graphic3d_GraduatedTrihedron::SetValuesFont ( const TCollection_AsciiString & theFont)
inline

◆ SetValuesFontAspect()

void Graphic3d_GraduatedTrihedron::SetValuesFontAspect ( Font_FontAspect theAspect)
inline

◆ SetValuesSize()

void Graphic3d_GraduatedTrihedron::SetValuesSize ( const Standard_Integer theValue)
inline

◆ ToDrawAxes()

Standard_Boolean Graphic3d_GraduatedTrihedron::ToDrawAxes ( ) const
inline

◆ ToDrawGrid()

Standard_Boolean Graphic3d_GraduatedTrihedron::ToDrawGrid ( ) const
inline

◆ ValuesFont()

const TCollection_AsciiString & Graphic3d_GraduatedTrihedron::ValuesFont ( ) const
inline

◆ ValuesFontAspect()

Font_FontAspect Graphic3d_GraduatedTrihedron::ValuesFontAspect ( ) const
inline

◆ ValuesSize()

Standard_Integer Graphic3d_GraduatedTrihedron::ValuesSize ( ) const
inline

◆ XAxisAspect()

const AxisAspect & Graphic3d_GraduatedTrihedron::XAxisAspect ( ) const
inline

◆ YAxisAspect()

const AxisAspect & Graphic3d_GraduatedTrihedron::YAxisAspect ( ) const
inline

◆ ZAxisAspect()

const AxisAspect & Graphic3d_GraduatedTrihedron::ZAxisAspect ( ) const
inline

Field Documentation

◆ myArrowsLength

Standard_ShortReal Graphic3d_GraduatedTrihedron::myArrowsLength
protected

◆ myAxes

NCollection_Array1<AxisAspect> Graphic3d_GraduatedTrihedron::myAxes
protected

X, Y and Z axes parameters.

◆ myCubicAxesCallback

MinMaxValuesCallback Graphic3d_GraduatedTrihedron::myCubicAxesCallback
protected

Callback function to define boundary box of displayed objects.

◆ myGridColor

Quantity_Color Graphic3d_GraduatedTrihedron::myGridColor
protected

◆ myNamesFont

TCollection_AsciiString Graphic3d_GraduatedTrihedron::myNamesFont
protected

Font name of names of axes: Courier, Arial, ...

◆ myNamesSize

Standard_Integer Graphic3d_GraduatedTrihedron::myNamesSize
protected

Size of names of axes: 8, 10,..

◆ myNamesStyle

Font_FontAspect Graphic3d_GraduatedTrihedron::myNamesStyle
protected

Style of names of axes: OSD_FA_Regular, OSD_FA_Bold,..

◆ myToDrawAxes

Standard_Boolean Graphic3d_GraduatedTrihedron::myToDrawAxes
protected

◆ myToDrawGrid

Standard_Boolean Graphic3d_GraduatedTrihedron::myToDrawGrid
protected

◆ myValuesFont

TCollection_AsciiString Graphic3d_GraduatedTrihedron::myValuesFont
protected

Font name of values: Courier, Arial, ...

◆ myValuesSize

Standard_Integer Graphic3d_GraduatedTrihedron::myValuesSize
protected

Size of values: 8, 10, 12, 14, ...

◆ myValuesStyle

Font_FontAspect Graphic3d_GraduatedTrihedron::myValuesStyle
protected

Style of values: OSD_FA_Regular, OSD_FA_Bold, ...

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