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
    BVH_PrimitiveSet< T, N > Class Template Reference

    Set of abstract geometric primitives organized with bounding volume hierarchy (BVH). Unlike an object set, this collection is designed for storing structural elements of a single object (such as triangles in the object triangulation). Because there may be a large number of such elements, the implementations of this interface should be sufficiently optimized. More...

    #include <BVH_PrimitiveSet.hxx>

    Inheritance diagram for BVH_PrimitiveSet< T, N >:

    Public Member Functions

     BVH_PrimitiveSet ()
     Creates set of abstract primitives.
     BVH_PrimitiveSet (const opencascade::handle< BVH_Builder< T, N > > &theBuilder)
     Creates set of abstract primitives.
     ~BVH_PrimitiveSet () override
     Releases resources of set of abstract primitives.
    BVH_Box< T, N > Box () const override
     Returns AABB of primitive set.
    virtual const opencascade::handle< BVH_Tree< T, N > > & BVH ()
     Returns BVH tree (and builds it if necessary).
    virtual const opencascade::handle< BVH_Builder< T, N > > & Builder () const
     Returns the method (builder) used to construct BVH.
    virtual void SetBuilder (const opencascade::handle< BVH_Builder< T, N > > &theBuilder)
     Sets the method (builder) used to construct BVH.
    Public Member Functions inherited from BVH_Object< T, N >
     BVH_Object ()=default
     Creates new abstract geometric object.
     ~BVH_Object () override=default
     Releases resources of geometric object.
    Public Member Functions inherited from BVH_ObjectTransient
    virtual const occ::handle< BVH_Properties > & Properties () const
     Returns properties of the geometric object.
    virtual void SetProperties (const occ::handle< BVH_Properties > &theProperties)
     Sets properties of the geometric object.
    virtual bool IsDirty () const
     Returns TRUE if object state should be updated.
    virtual void MarkDirty ()
     Marks object state as outdated (needs BVH rebuilding).
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (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_TransientThis () 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.
    Public Member Functions inherited from BVH_Set< T, N >
     BVH_Set ()=default
     Creates new abstract set of objects.
    virtual ~BVH_Set ()=default
     Releases resources of set of objects.
    virtual int Size () const =0
     Returns total number of objects.
    virtual BVH_Box< T, N > Box (const int theIndex) const =0
     Returns AABB of the given object.
    virtual T Center (const int theIndex, const int theAxis) const =0
     Returns centroid position along the given axis.
    virtual void Swap (const int theIndex1, const int theIndex2)=0
     Performs transposing the two given objects in the set.

    Static Public Attributes

    static const int MaxTreeDepth = BVH_Constants_MaxTreeDepth

    Protected Member Functions

    virtual void Update ()
     Updates BVH of primitive set.
    Protected Member Functions inherited from BVH_ObjectTransient
     BVH_ObjectTransient ()
     Creates new abstract geometric object.

    Protected Attributes

    opencascade::handle< BVH_Tree< T, N > > myBVH
     Constructed bottom-level BVH.
    opencascade::handle< BVH_Builder< T, N > > myBuilder
     Builder for bottom-level BVH.
    BVH_Box< T, N > myBox
     Cached bounding box of geometric primitives.
    Protected Attributes inherited from BVH_ObjectTransient
    bool myIsDirty
     Marks internal object state as outdated.
    occ::handle< BVH_PropertiesmyProperties
     Generic properties assigned to the object.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Public Types inherited from BVH_Set< T, N >
    typedef BVH_Box< T, N > BVH_BoxNt
    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

    template<class T, int N>
    class BVH_PrimitiveSet< T, N >

    Set of abstract geometric primitives organized with bounding volume hierarchy (BVH). Unlike an object set, this collection is designed for storing structural elements of a single object (such as triangles in the object triangulation). Because there may be a large number of such elements, the implementations of this interface should be sufficiently optimized.

    Template Parameters
    TNumeric data type
    NVector dimension

    Constructor & Destructor Documentation

    ◆ BVH_PrimitiveSet() [1/2]

    template<class T, int N>
    BVH_PrimitiveSet< T, N >::BVH_PrimitiveSet ( )
    inline

    Creates set of abstract primitives.

    ◆ BVH_PrimitiveSet() [2/2]

    template<class T, int N>
    BVH_PrimitiveSet< T, N >::BVH_PrimitiveSet ( const opencascade::handle< BVH_Builder< T, N > > & theBuilder)
    inline

    Creates set of abstract primitives.

    ◆ ~BVH_PrimitiveSet()

    template<class T, int N>
    BVH_PrimitiveSet< T, N >::~BVH_PrimitiveSet ( )
    inlineoverride

    Releases resources of set of abstract primitives.

    Member Function Documentation

    ◆ Box()

    template<class T, int N>
    BVH_Box< T, N > BVH_PrimitiveSet< T, N >::Box ( ) const
    inlineoverridevirtual

    ◆ Builder()

    template<class T, int N>
    virtual const opencascade::handle< BVH_Builder< T, N > > & BVH_PrimitiveSet< T, N >::Builder ( ) const
    inlinevirtual

    Returns the method (builder) used to construct BVH.

    ◆ BVH()

    template<class T, int N>
    virtual const opencascade::handle< BVH_Tree< T, N > > & BVH_PrimitiveSet< T, N >::BVH ( )
    inlinevirtual

    Returns BVH tree (and builds it if necessary).

    ◆ SetBuilder()

    template<class T, int N>
    virtual void BVH_PrimitiveSet< T, N >::SetBuilder ( const opencascade::handle< BVH_Builder< T, N > > & theBuilder)
    inlinevirtual

    Sets the method (builder) used to construct BVH.

    ◆ Update()

    template<class T, int N>
    virtual void BVH_PrimitiveSet< T, N >::Update ( )
    inlineprotectedvirtual

    Updates BVH of primitive set.

    Field Documentation

    ◆ MaxTreeDepth

    template<class T, int N>
    const int BVH_PrimitiveSet< T, N >::MaxTreeDepth = BVH_Constants_MaxTreeDepth
    static

    ◆ myBox

    template<class T, int N>
    BVH_Box<T, N> BVH_PrimitiveSet< T, N >::myBox
    mutableprotected

    Cached bounding box of geometric primitives.

    ◆ myBuilder

    template<class T, int N>
    opencascade::handle<BVH_Builder<T, N> > BVH_PrimitiveSet< T, N >::myBuilder
    protected

    Builder for bottom-level BVH.

    ◆ myBVH

    template<class T, int N>
    opencascade::handle<BVH_Tree<T, N> > BVH_PrimitiveSet< T, N >::myBVH
    protected

    Constructed bottom-level BVH.


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