OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    OpenGl_Flipper Class Reference

    Being rendered, the elements modifies current model-view matrix such that the axes of the specified reference system (in model space) become oriented in the following way: More...

    #include <OpenGl_Flipper.hxx>

    Inheritance diagram for OpenGl_Flipper:

    Public Member Functions

     OpenGl_Flipper (const gp_Ax2 &theReferenceSystem)
     Construct rendering element to flip model-view matrix along the reference system to ensure up-Y, right-X orientation.
    void SetOptions (const bool theIsEnabled)
     Set options for the element.
    void Render (const occ::handle< OpenGl_Workspace > &theWorkspace) const override
    void Release (OpenGl_Context *theCtx) override
     Release GPU resources. Pointer to the context is used because this method might be called when the context is already being destroyed and usage of a handle would be unsafe.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    Public Member Functions inherited from OpenGl_Element
     OpenGl_Element ()
    virtual bool IsFillDrawMode () const
     Return TRUE if primitive type generates shaded triangulation (to be used in filters).
    virtual size_t EstimatedDataSize () const
     Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
    virtual void UpdateMemStats (Graphic3d_FrameStatsDataTmp &theStats) const
     Increment memory usage statistics. Default implementation puts EstimatedDataSize() into Graphic3d_FrameStatsCounter_EstimatedBytesGeom.
    virtual void UpdateDrawStats (Graphic3d_FrameStatsDataTmp &theStats, bool theIsDetailed) const
     Increment draw calls statistics.
    virtual void SynchronizeAspects ()
     Update parameters of the drawable elements.

    Protected Attributes

    NCollection_Vec4< float > myReferenceOrigin
    NCollection_Vec4< float > myReferenceX
    NCollection_Vec4< float > myReferenceY
    NCollection_Vec4< float > myReferenceZ
    bool myIsEnabled

    Additional Inherited Members

    Static Public Member Functions inherited from OpenGl_Element
    template<typename theResource_t>
    static void Destroy (OpenGl_Context *theContext, theResource_t *&theElement)
     Pointer to the context is used because this method might be called when the context is already being destroyed and usage of a handle would be unsafe.
    Protected Member Functions inherited from OpenGl_Element
    virtual ~OpenGl_Element ()

    Detailed Description

    Being rendered, the elements modifies current model-view matrix such that the axes of the specified reference system (in model space) become oriented in the following way:

    • X - heads to the right side of view.
    • Y - heads to the up side of view.
    • N(Z) - heads towards the screen. Originally, this element serves for need of flipping the 3D text of dimension presentations.

    Constructor & Destructor Documentation

    ◆ OpenGl_Flipper()

    OpenGl_Flipper::OpenGl_Flipper ( const gp_Ax2 & theReferenceSystem)

    Construct rendering element to flip model-view matrix along the reference system to ensure up-Y, right-X orientation.

    Parameters
    [in]theReferenceSystemthe reference coordinate system.

    Member Function Documentation

    ◆ DumpJson()

    void OpenGl_Flipper::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    overridevirtual

    Dumps the content of me into the stream.

    Reimplemented from OpenGl_Element.

    ◆ Release()

    void OpenGl_Flipper::Release ( OpenGl_Context * theContext)
    overridevirtual

    Release GPU resources. Pointer to the context is used because this method might be called when the context is already being destroyed and usage of a handle would be unsafe.

    Implements OpenGl_Element.

    ◆ Render()

    void OpenGl_Flipper::Render ( const occ::handle< OpenGl_Workspace > & theWorkspace) const
    overridevirtual

    Implements OpenGl_Element.

    ◆ SetOptions()

    void OpenGl_Flipper::SetOptions ( const bool theIsEnabled)
    inline

    Set options for the element.

    Parameters
    [in]theIsEnabledflag indicates whether the flipper matrix modification should be set up or restored back.

    Field Documentation

    ◆ myIsEnabled

    bool OpenGl_Flipper::myIsEnabled
    protected

    ◆ myReferenceOrigin

    NCollection_Vec4<float> OpenGl_Flipper::myReferenceOrigin
    protected

    ◆ myReferenceX

    NCollection_Vec4<float> OpenGl_Flipper::myReferenceX
    protected

    ◆ myReferenceY

    NCollection_Vec4<float> OpenGl_Flipper::myReferenceY
    protected

    ◆ myReferenceZ

    NCollection_Vec4<float> OpenGl_Flipper::myReferenceZ
    protected

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