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_ClippingIterator Class Reference

    The iterator through clipping planes. More...

    #include <OpenGl_ClippingIterator.hxx>

    Public Member Functions

     OpenGl_ClippingIterator (const OpenGl_Clipping &theClipping)
     Main constructor.
    bool More () const
     Return true if iterator points to the valid clipping plane.
    void Next ()
     Go to the next clipping plane.
    bool IsDisabled () const
     Return true if plane has been temporarily disabled either by Graphic3d_ClipPlane->IsOn() property or by temporary filter. Beware that this method does NOT handle a Chain filter for Capping algorithm OpenGl_Clipping::CappedChain()!
    const occ::handle< Graphic3d_ClipPlane > & Value () const
     Return the plane at current iterator position.
    bool IsGlobal () const
     Return true if plane from the global (view) list.
    int PlaneIndex () const
     Return the plane index.

    Detailed Description

    The iterator through clipping planes.

    Constructor & Destructor Documentation

    ◆ OpenGl_ClippingIterator()

    OpenGl_ClippingIterator::OpenGl_ClippingIterator ( const OpenGl_Clipping & theClipping)
    inline

    Main constructor.

    Member Function Documentation

    ◆ IsDisabled()

    bool OpenGl_ClippingIterator::IsDisabled ( ) const
    inline

    Return true if plane has been temporarily disabled either by Graphic3d_ClipPlane->IsOn() property or by temporary filter. Beware that this method does NOT handle a Chain filter for Capping algorithm OpenGl_Clipping::CappedChain()!

    ◆ IsGlobal()

    bool OpenGl_ClippingIterator::IsGlobal ( ) const
    inline

    Return true if plane from the global (view) list.

    ◆ More()

    bool OpenGl_ClippingIterator::More ( ) const
    inline

    Return true if iterator points to the valid clipping plane.

    ◆ Next()

    void OpenGl_ClippingIterator::Next ( )
    inline

    Go to the next clipping plane.

    ◆ PlaneIndex()

    int OpenGl_ClippingIterator::PlaneIndex ( ) const
    inline

    Return the plane index.

    ◆ Value()

    const occ::handle< Graphic3d_ClipPlane > & OpenGl_ClippingIterator::Value ( ) const
    inline

    Return the plane at current iterator position.


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