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

    Specialization of quad BVH (QBVH) tree. More...

    #include <BVH_QuadTree.hxx>

    Inheritance diagram for BVH_Tree< T, N, BVH_QuadTree >:

    Public Member Functions

    general methods

    Creates new empty BVH tree.

     BVH_Tree ()
     Returns index of the K-th child of the given inner node.
    template<int K>
    int Child (const int theNodeIndex) const
     Returns index of the K-th child of the given inner node.
    Public Member Functions inherited from BVH_TreeBase< T, N >
     BVH_TreeBase ()
     Releases resources of BVH tree.
     ~BVH_TreeBase () override=default
     Releases resources of BVH tree.
    int Depth () const
     Returns depth (height) of BVH tree.
    int Length () const
     Returns total number of BVH tree nodes.
    BVH_VecNt & MinPoint (const int theNodeIndex)
     Returns maximum point of the given node.
    BVH_VecNt & MaxPoint (const int theNodeIndex)
     Returns maximum point of the given node.
    const BVH_VecNt & MinPoint (const int theNodeIndex) const
     Returns minimum point of the given node.
    const BVH_VecNt & MaxPoint (const int theNodeIndex) const
     Returns maximum point of the given node.
    int & BegPrimitive (const int theNodeIndex)
     Returns index of first primitive of the given leaf node.
    int & EndPrimitive (const int theNodeIndex)
     Returns index of last primitive of the given leaf node.
    int BegPrimitive (const int theNodeIndex) const
     Returns index of first primitive of the given leaf node.
    int EndPrimitive (const int theNodeIndex) const
     Returns index of last primitive of the given leaf node.
    int NbPrimitives (const int theNodeIndex) const
     Returns number of primitives in the given leaf node.
    int & Level (const int theNodeIndex)
     Returns level (depth) of the given node.
    int Level (const int theNodeIndex) const
     Returns level (depth) of the given node.
    bool IsOuter (const int theNodeIndex) const
     Checks whether the given node is outer.
    BVH_Array4i & NodeInfoBuffer ()
     Returns array of node data records.
    const BVH_Array4i & NodeInfoBuffer () const
     Returns array of node data records.
    BVH::ArrayType< T, N >::Type & MinPointBuffer ()
     Returns array of node minimum points.
    BVH::ArrayType< T, N >::Type & MaxPointBuffer ()
     Returns array of node maximum points.
    const BVH::ArrayType< T, N >::Type & MinPointBuffer () const
     Returns array of node minimum points.
    const BVH::ArrayType< T, N >::Type & MaxPointBuffer () const
     Returns array of node maximum points.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    void DumpNode (const int theNodeIndex, Standard_OStream &theOStream, int theDepth) const override
     Dumps the content of node 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.

    Additional Inherited Members

    Public Types inherited from BVH_TreeBase< T, N >
    typedef BVH_Box< T, N >::BVH_VecNt BVH_VecNt
    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.
    Data Fields inherited from BVH_TreeBase< T, N >
    BVH_Array4i myNodeInfoBuffer
     Array of node minimum points.
    BVH::ArrayType< T, N >::Type myMinPointBuffer
     Array of node minimum points.
    BVH::ArrayType< T, N >::Type myMaxPointBuffer
     Array of node maximum points.
    int myDepth
     Current depth of BVH tree (set by builder).
    Protected Member Functions inherited from BVH_TreeBaseTransient
     BVH_TreeBaseTransient ()

    Detailed Description

    template<class T, int N>
    class BVH_Tree< T, N, BVH_QuadTree >

    Specialization of quad BVH (QBVH) tree.

    Constructor & Destructor Documentation

    ◆ BVH_Tree()

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

    Returns index of the K-th child of the given inner node.

    Template Parameters
    Kthe index of node child (from 0 to 3)

    Member Function Documentation

    ◆ Child()

    template<class T, int N>
    template<int K>
    int BVH_Tree< T, N, BVH_QuadTree >::Child ( const int theNodeIndex) const
    inline

    Returns index of the K-th child of the given inner node.

    Template Parameters
    Kthe index of node child (from 0 to 3)

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