OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    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 int theNamesSize=12, const TCollection_AsciiString &theValuesFont="Arial", const Font_FontAspect &theValuesStyle=Font_FA_Regular, const int theValuesSize=12, const float theArrowsLength=30.0f, const Quantity_Color theGridColor=Quantity_NOC_WHITE, const bool theToDrawGrid=true, const bool theToDrawAxes=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 int theIndex)
    const AxisAspect & XAxisAspect () const
    const AxisAspect & YAxisAspect () const
    const AxisAspect & ZAxisAspect () const
    const AxisAspect & AxisAspectAt (const int theIndex) const
    float ArrowsLength () const
    void SetArrowsLength (const float theValue)
    const Quantity_Color & GridColor () const
    void SetGridColor (const Quantity_Color &theColor)
    bool ToDrawGrid () const
    void SetDrawGrid (const bool theToDraw)
    bool ToDrawAxes () const
    void SetDrawAxes (const bool theToDraw)
    const TCollection_AsciiString & NamesFont () const
    void SetNamesFont (const TCollection_AsciiString &theFont)
    Font_FontAspect NamesFontAspect () const
    void SetNamesFontAspect (Font_FontAspect theAspect)
    int NamesSize () const
    void SetNamesSize (const int theValue)
    const TCollection_AsciiString & ValuesFont () const
    void SetValuesFont (const TCollection_AsciiString &theFont)
    Font_FontAspect ValuesFontAspect () const
    void SetValuesFontAspect (Font_FontAspect theAspect)
    int ValuesSize () const
    void SetValuesSize (const int theValue)
    bool 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,..
    int 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, ...
    int myValuesSize
     Size of values: 8, 10, 12, 14, ...
    float myArrowsLength
    Quantity_Color myGridColor
    bool myToDrawGrid
    bool 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 int theNamesSize = 12,
    const TCollection_AsciiString & theValuesFont = "Arial",
    const Font_FontAspect & theValuesStyle = Font_FA_Regular,
    const int theValuesSize = 12,
    const float theArrowsLength = 30.0f,
    const Quantity_Color theGridColor = Quantity_NOC_WHITE,
    const bool theToDrawGrid = true,
    const bool theToDrawAxes = true )
    inline

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

    Member Function Documentation

    ◆ ArrowsLength()

    float Graphic3d_GraduatedTrihedron::ArrowsLength ( ) const
    inline

    ◆ AxisAspectAt()

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

    ◆ ChangeAxisAspect()

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

    ◆ ChangeXAxisAspect()

    AxisAspect & Graphic3d_GraduatedTrihedron::ChangeXAxisAspect ( )
    inline

    ◆ ChangeYAxisAspect()

    AxisAspect & Graphic3d_GraduatedTrihedron::ChangeYAxisAspect ( )
    inline

    ◆ ChangeZAxisAspect()

    AxisAspect & Graphic3d_GraduatedTrihedron::ChangeZAxisAspect ( )
    inline

    ◆ CubicAxesCallback()

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

    int Graphic3d_GraduatedTrihedron::NamesSize ( ) const
    inline

    ◆ SetArrowsLength()

    void Graphic3d_GraduatedTrihedron::SetArrowsLength ( const float theValue)
    inline

    ◆ SetCubicAxesCallback()

    void Graphic3d_GraduatedTrihedron::SetCubicAxesCallback ( const MinMaxValuesCallback theCallback)
    inline

    ◆ SetDrawAxes()

    void Graphic3d_GraduatedTrihedron::SetDrawAxes ( const bool theToDraw)
    inline

    ◆ SetDrawGrid()

    void Graphic3d_GraduatedTrihedron::SetDrawGrid ( const bool 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 int 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 int theValue)
    inline

    ◆ ToDrawAxes()

    bool Graphic3d_GraduatedTrihedron::ToDrawAxes ( ) const
    inline

    ◆ ToDrawGrid()

    bool Graphic3d_GraduatedTrihedron::ToDrawGrid ( ) const
    inline

    ◆ ValuesFont()

    const TCollection_AsciiString & Graphic3d_GraduatedTrihedron::ValuesFont ( ) const
    inline

    ◆ ValuesFontAspect()

    Font_FontAspect Graphic3d_GraduatedTrihedron::ValuesFontAspect ( ) const
    inline

    ◆ ValuesSize()

    int 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

    float 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

    int 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

    bool Graphic3d_GraduatedTrihedron::myToDrawAxes
    protected

    ◆ myToDrawGrid

    bool Graphic3d_GraduatedTrihedron::myToDrawGrid
    protected

    ◆ myValuesFont

    TCollection_AsciiString Graphic3d_GraduatedTrihedron::myValuesFont
    protected

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

    ◆ myValuesSize

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