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

    Class defines a Clipping Volume as a logical OR (disjunction) operation between Graphic3d_ClipPlane in sequence. Each Graphic3d_ClipPlane represents either a single Plane clipping a halfspace (direction is specified by normal), or a sub-chain of planes defining a logical AND (conjunction) operation. Therefore, this collection allows defining a Clipping Volume through the limited set of Boolean operations between clipping Planes. More...

    #include <Graphic3d_SequenceOfHClipPlane.hxx>

    Inheritance diagram for Graphic3d_SequenceOfHClipPlane:
    Inheritance graph
    [legend]

    Data Structures

    class  Iterator
     Iterator through clipping planes. More...

    Public Member Functions

     Graphic3d_SequenceOfHClipPlane ()
     Empty constructor.
    bool ToOverrideGlobal () const
     Return true if local properties should override global properties.
    void SetOverrideGlobal (const bool theToOverride)
     Setup flag defining if local properties should override global properties.
    bool IsEmpty () const
     Return TRUE if sequence is empty.
    int Size () const
     Return the number of items in sequence.
    bool Append (const occ::handle< Graphic3d_ClipPlane > &theItem)
     Append a plane.
    bool Remove (const occ::handle< Graphic3d_ClipPlane > &theItem)
     Remove a plane.
    void Remove (Iterator &theItem)
     Remove a plane.
    void Clear ()
     Clear the items out.
    const occ::handle< Graphic3d_ClipPlane > & First () const
     Return the first item in sequence.
    virtual void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
     Dumps the content of me into the stream.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transient & operator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_Transient * This () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Protected Attributes

    NCollection_Sequence< occ::handle< Graphic3d_ClipPlane > > myItems
    bool myToOverrideGlobal

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.

    Detailed Description

    Class defines a Clipping Volume as a logical OR (disjunction) operation between Graphic3d_ClipPlane in sequence. Each Graphic3d_ClipPlane represents either a single Plane clipping a halfspace (direction is specified by normal), or a sub-chain of planes defining a logical AND (conjunction) operation. Therefore, this collection allows defining a Clipping Volume through the limited set of Boolean operations between clipping Planes.

    The Clipping Volume can be assigned either to entire View or to a specific Object; in the latter case property ToOverrideGlobal() will specify if Object planes should override (suppress) globally defined ones or extend their definition through logical OR (disjunction) operation.

    Note that defining (many) planes will lead to performance degradation, and Graphics Driver may limit the overall number of simultaneously active clipping planes - but at least 6 planes should be supported on all configurations.

    Constructor & Destructor Documentation

    ◆ Graphic3d_SequenceOfHClipPlane()

    Graphic3d_SequenceOfHClipPlane::Graphic3d_SequenceOfHClipPlane ( )

    Empty constructor.

    Member Function Documentation

    ◆ Append()

    bool Graphic3d_SequenceOfHClipPlane::Append ( const occ::handle< Graphic3d_ClipPlane > & theItem)

    Append a plane.

    Returns
    TRUE if new item has been added (FALSE if item already existed)

    ◆ Clear()

    void Graphic3d_SequenceOfHClipPlane::Clear ( )
    		inline

    Clear the items out.

    ◆ DumpJson()

    virtual void Graphic3d_SequenceOfHClipPlane::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    		virtual

    Dumps the content of me into the stream.

    ◆ First()

    const occ::handle< Graphic3d_ClipPlane > & Graphic3d_SequenceOfHClipPlane::First ( ) const
    		inline

    Return the first item in sequence.

    ◆ IsEmpty()

    bool Graphic3d_SequenceOfHClipPlane::IsEmpty ( ) const
    		inline

    Return TRUE if sequence is empty.

    ◆ Remove() [1/2]

    bool Graphic3d_SequenceOfHClipPlane::Remove ( const occ::handle< Graphic3d_ClipPlane > & theItem)

    Remove a plane.

    Returns
    TRUE if item has been found and removed

    ◆ Remove() [2/2]

    void Graphic3d_SequenceOfHClipPlane::Remove ( Iterator & theItem)
    		inline

    Remove a plane.

    ◆ SetOverrideGlobal()

    void Graphic3d_SequenceOfHClipPlane::SetOverrideGlobal ( const bool theToOverride)
    		inline

    Setup flag defining if local properties should override global properties.

    ◆ Size()

    int Graphic3d_SequenceOfHClipPlane::Size ( ) const
    		inline

    Return the number of items in sequence.

    ◆ ToOverrideGlobal()

    bool Graphic3d_SequenceOfHClipPlane::ToOverrideGlobal ( ) const
    		inline

    Return true if local properties should override global properties.

    Field Documentation

    ◆ myItems

    NCollection_Sequence<occ::handle<Graphic3d_ClipPlane> > Graphic3d_SequenceOfHClipPlane::myItems
    		protected

    ◆ myToOverrideGlobal

    bool Graphic3d_SequenceOfHClipPlane::myToOverrideGlobal
    		protected
    The documentation for this class was generated from the following file: