Open CASCADE Technology  7.5.0
Public Member Functions | Protected Attributes
Graphic3d_AxisAspect Class Reference

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

#include <Graphic3d_GraduatedTrihedron.hxx>

Public Member Functions

 Graphic3d_AxisAspect (const TCollection_ExtendedString theName="", const Quantity_Color theNameColor=Quantity_NOC_BLACK, const Quantity_Color theColor=Quantity_NOC_BLACK, const Standard_Integer theValuesOffset=10, const Standard_Integer theNameOffset=30, const Standard_Integer theTickmarksNumber=5, const Standard_Integer theTickmarksLength=10, const Standard_Boolean theToDrawName=Standard_True, const Standard_Boolean theToDrawValues=Standard_True, const Standard_Boolean theToDrawTickmarks=Standard_True)
 
void SetName (const TCollection_ExtendedString &theName)
 
const TCollection_ExtendedStringName () const
 
Standard_Boolean ToDrawName () const
 
void SetDrawName (const Standard_Boolean theToDraw)
 
Standard_Boolean ToDrawTickmarks () const
 
void SetDrawTickmarks (const Standard_Boolean theToDraw)
 
Standard_Boolean ToDrawValues () const
 
void SetDrawValues (const Standard_Boolean theToDraw)
 
const Quantity_ColorNameColor () const
 
void SetNameColor (const Quantity_Color &theColor)
 
const Quantity_ColorColor () const
 Color of axis and values. More...
 
void SetColor (const Quantity_Color &theColor)
 Sets color of axis and values. More...
 
Standard_Integer TickmarksNumber () const
 
void SetTickmarksNumber (const Standard_Integer theValue)
 
Standard_Integer TickmarksLength () const
 
void SetTickmarksLength (const Standard_Integer theValue)
 
Standard_Integer ValuesOffset () const
 
void SetValuesOffset (const Standard_Integer theValue)
 
Standard_Integer NameOffset () const
 
void SetNameOffset (const Standard_Integer theValue)
 

Protected Attributes

TCollection_ExtendedString myName
 
Standard_Boolean myToDrawName
 
Standard_Boolean myToDrawTickmarks
 
Standard_Boolean myToDrawValues
 
Quantity_Color myNameColor
 
Standard_Integer myTickmarksNumber
 Number of splits along axes. More...
 
Standard_Integer myTickmarksLength
 Length of tickmarks. More...
 
Quantity_Color myColor
 Color of axis and values. More...
 
Standard_Integer myValuesOffset
 Offset for drawing values. More...
 
Standard_Integer myNameOffset
 Offset for drawing name of axis. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Graphic3d_AxisAspect()

Graphic3d_AxisAspect::Graphic3d_AxisAspect ( const TCollection_ExtendedString  theName = "",
const Quantity_Color  theNameColor = Quantity_NOC_BLACK,
const Quantity_Color  theColor = Quantity_NOC_BLACK,
const Standard_Integer  theValuesOffset = 10,
const Standard_Integer  theNameOffset = 30,
const Standard_Integer  theTickmarksNumber = 5,
const Standard_Integer  theTickmarksLength = 10,
const Standard_Boolean  theToDrawName = Standard_True,
const Standard_Boolean  theToDrawValues = Standard_True,
const Standard_Boolean  theToDrawTickmarks = Standard_True 
)
inline

Member Function Documentation

◆ Color()

const Quantity_Color& Graphic3d_AxisAspect::Color ( ) const
inline

Color of axis and values.

◆ Name()

const TCollection_ExtendedString& Graphic3d_AxisAspect::Name ( ) const
inline

◆ NameColor()

const Quantity_Color& Graphic3d_AxisAspect::NameColor ( ) const
inline

◆ NameOffset()

Standard_Integer Graphic3d_AxisAspect::NameOffset ( ) const
inline

◆ SetColor()

void Graphic3d_AxisAspect::SetColor ( const Quantity_Color theColor)
inline

Sets color of axis and values.

◆ SetDrawName()

void Graphic3d_AxisAspect::SetDrawName ( const Standard_Boolean  theToDraw)
inline

◆ SetDrawTickmarks()

void Graphic3d_AxisAspect::SetDrawTickmarks ( const Standard_Boolean  theToDraw)
inline

◆ SetDrawValues()

void Graphic3d_AxisAspect::SetDrawValues ( const Standard_Boolean  theToDraw)
inline

◆ SetName()

void Graphic3d_AxisAspect::SetName ( const TCollection_ExtendedString theName)
inline

◆ SetNameColor()

void Graphic3d_AxisAspect::SetNameColor ( const Quantity_Color theColor)
inline

◆ SetNameOffset()

void Graphic3d_AxisAspect::SetNameOffset ( const Standard_Integer  theValue)
inline

◆ SetTickmarksLength()

void Graphic3d_AxisAspect::SetTickmarksLength ( const Standard_Integer  theValue)
inline

◆ SetTickmarksNumber()

void Graphic3d_AxisAspect::SetTickmarksNumber ( const Standard_Integer  theValue)
inline

◆ SetValuesOffset()

void Graphic3d_AxisAspect::SetValuesOffset ( const Standard_Integer  theValue)
inline

◆ TickmarksLength()

Standard_Integer Graphic3d_AxisAspect::TickmarksLength ( ) const
inline

◆ TickmarksNumber()

Standard_Integer Graphic3d_AxisAspect::TickmarksNumber ( ) const
inline

◆ ToDrawName()

Standard_Boolean Graphic3d_AxisAspect::ToDrawName ( ) const
inline

◆ ToDrawTickmarks()

Standard_Boolean Graphic3d_AxisAspect::ToDrawTickmarks ( ) const
inline

◆ ToDrawValues()

Standard_Boolean Graphic3d_AxisAspect::ToDrawValues ( ) const
inline

◆ ValuesOffset()

Standard_Integer Graphic3d_AxisAspect::ValuesOffset ( ) const
inline

Field Documentation

◆ myColor

Quantity_Color Graphic3d_AxisAspect::myColor
protected

Color of axis and values.

◆ myName

TCollection_ExtendedString Graphic3d_AxisAspect::myName
protected

◆ myNameColor

Quantity_Color Graphic3d_AxisAspect::myNameColor
protected

◆ myNameOffset

Standard_Integer Graphic3d_AxisAspect::myNameOffset
protected

Offset for drawing name of axis.

◆ myTickmarksLength

Standard_Integer Graphic3d_AxisAspect::myTickmarksLength
protected

Length of tickmarks.

◆ myTickmarksNumber

Standard_Integer Graphic3d_AxisAspect::myTickmarksNumber
protected

Number of splits along axes.

◆ myToDrawName

Standard_Boolean Graphic3d_AxisAspect::myToDrawName
protected

◆ myToDrawTickmarks

Standard_Boolean Graphic3d_AxisAspect::myToDrawTickmarks
protected

◆ myToDrawValues

Standard_Boolean Graphic3d_AxisAspect::myToDrawValues
protected

◆ myValuesOffset

Standard_Integer Graphic3d_AxisAspect::myValuesOffset
protected

Offset for drawing values.


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