Open CASCADE Technology  7.7.0

BVH_Tree< T, N, BVH_BinaryTree > Class Template Reference

Specialization of binary BVH tree. More...

#include <BVH_BinaryTree.hxx>

Inheritance diagram for BVH_Tree< T, N, BVH_BinaryTree >:
Inheritance graph
[legend]

Public Types

custom data types
typedef BVH_TreeBase< T, N >::BVH_VecNt BVH_VecNt
 
- Public Types inherited from BVH_TreeBase< T, N >
typedef BVH_Box< T, N >::BVH_VecNt BVH_VecNt
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Public Member Functions

methods for accessing individual nodes
 BVH_Tree ()
 Creates new empty BVH tree. More...
 
void SetOuter (const int theNodeIndex)
 Sets node type to 'outer'. More...
 
void SetInner (const int theNodeIndex)
 Sets node type to 'inner'. More...
 
template<int K>
int Child (const int theNodeIndex) const
 Returns index of the K-th child of the given inner node. More...
 
template<int K>
int & ChangeChild (const int theNodeIndex)
 Returns index of the K-th child of the given inner node. More...
 
template<int K>
int & Child (const int theNodeIndex)
 Returns index of the K-th child of the given inner node. More...
 
methods for adding/removing tree nodes
void Clear ()
 Removes all nodes from the tree. More...
 
void Reserve (const int theNbNodes)
 Reserves internal BVH storage, so that it can contain the given number of BVH nodes. More...
 
int AddLeafNode (const BVH_VecNt &theMinPoint, const BVH_VecNt &theMaxPoint, const int theBegElem, const int theEndElem)
 Adds new leaf node to the BVH. More...
 
int AddInnerNode (const BVH_VecNt &theMinPoint, const BVH_VecNt &theMaxPoint, const int theLftChild, const int theRghChild)
 Adds new inner node to the BVH. More...
 
int AddLeafNode (const BVH_Box< T, N > &theAABB, const int theBegElem, const int theEndElem)
 Adds new leaf node to the BVH. More...
 
int AddInnerNode (const BVH_Box< T, N > &theAABB, const int theLftChild, const int theRghChild)
 Adds new inner node to the BVH. More...
 
int AddLeafNode (const int theBegElem, const int theEndElem)
 Adds new leaf node to the BVH with UNINITIALIZED bounds. More...
 
int AddInnerNode (const int theLftChild, const int theRghChild)
 Adds new inner node to the BVH with UNINITIALIZED bounds. More...
 
methods specific to binary BVH
EstimateSAH () const
 Returns value of SAH (surface area heuristic). Allows to compare the quality of BVH trees constructed for the same sets of geometric objects with different methods. More...
 
BVH_Tree< T, N, BVH_QuadTree > * CollapseToQuadTree () const
 Collapses the tree into QBVH an returns it. As a result, each 2-nd level of current tree is kept and the rest are discarded. More...
 
- Public Member Functions inherited from BVH_TreeBase< T, N >
 BVH_TreeBase ()
 Creates new empty BVH tree. More...
 
virtual ~BVH_TreeBase ()
 Releases resources of BVH tree. More...
 
int Depth () const
 Returns depth (height) of BVH tree. More...
 
int Length () const
 Returns total number of BVH tree nodes. More...
 
BVH_VecNtMinPoint (const int theNodeIndex)
 Returns minimum point of the given node. More...
 
BVH_VecNtMaxPoint (const int theNodeIndex)
 Returns maximum point of the given node. More...
 
const BVH_VecNtMinPoint (const int theNodeIndex) const
 Returns minimum point of the given node. More...
 
const BVH_VecNtMaxPoint (const int theNodeIndex) const
 Returns maximum point of the given node. More...
 
int & BegPrimitive (const int theNodeIndex)
 Returns index of first primitive of the given leaf node. More...
 
int & EndPrimitive (const int theNodeIndex)
 Returns index of last primitive of the given leaf node. More...
 
int BegPrimitive (const int theNodeIndex) const
 Returns index of first primitive of the given leaf node. More...
 
int EndPrimitive (const int theNodeIndex) const
 Returns index of last primitive of the given leaf node. More...
 
int NbPrimitives (const int theNodeIndex) const
 Returns number of primitives in the given leaf node. More...
 
int & Level (const int theNodeIndex)
 Returns level (depth) of the given node. More...
 
int Level (const int theNodeIndex) const
 Returns level (depth) of the given node. More...
 
bool IsOuter (const int theNodeIndex) const
 Checks whether the given node is outer. More...
 
BVH_Array4iNodeInfoBuffer ()
 Returns array of node data records. More...
 
const BVH_Array4iNodeInfoBuffer () const
 Returns array of node data records. More...
 
BVH::ArrayType< T, N >::Type & MinPointBuffer ()
 Returns array of node minimum points. More...
 
BVH::ArrayType< T, N >::Type & MaxPointBuffer ()
 Returns array of node maximum points. More...
 
const BVH::ArrayType< T, N >::Type & MinPointBuffer () const
 Returns array of node minimum points. More...
 
const BVH::ArrayType< T, N >::Type & MaxPointBuffer () const
 Returns array of node maximum points. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
virtual void DumpNode (const int theNodeIndex, Standard_OStream &theOStream, Standard_Integer theDepth) const override
 Dumps the content of node into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Data Fields inherited from BVH_TreeBase< T, N >
BVH_Array4i myNodeInfoBuffer
 Array of node data records. More...
 
BVH::ArrayType< T, N >::Type myMinPointBuffer
 Array of node minimum points. More...
 
BVH::ArrayType< T, N >::Type myMaxPointBuffer
 Array of node maximum points. More...
 
int myDepth
 Current depth of BVH tree (set by builder). More...
 
- Protected Member Functions inherited from BVH_TreeBaseTransient
 BVH_TreeBaseTransient ()
 

Detailed Description

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

Specialization of binary BVH tree.

Member Typedef Documentation

◆ BVH_VecNt

template<class T , int N>
typedef BVH_TreeBase<T, N>::BVH_VecNt BVH_Tree< T, N, BVH_BinaryTree >::BVH_VecNt

Constructor & Destructor Documentation

◆ BVH_Tree()

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

Creates new empty BVH tree.

Member Function Documentation

◆ AddInnerNode() [1/3]

template<class T , int N>
int BVH_Tree< T, N, BVH_BinaryTree >::AddInnerNode ( const BVH_Box< T, N > &  theAABB,
const int  theLftChild,
const int  theRghChild 
)
inline

Adds new inner node to the BVH.

◆ AddInnerNode() [2/3]

template<class T , int N>
int BVH_Tree< T, N, BVH_BinaryTree >::AddInnerNode ( const BVH_VecNt theMinPoint,
const BVH_VecNt theMaxPoint,
const int  theLftChild,
const int  theRghChild 
)
inline

Adds new inner node to the BVH.

◆ AddInnerNode() [3/3]

template<class T , int N>
int BVH_Tree< T, N, BVH_BinaryTree >::AddInnerNode ( const int  theLftChild,
const int  theRghChild 
)
inline

Adds new inner node to the BVH with UNINITIALIZED bounds.

◆ AddLeafNode() [1/3]

template<class T , int N>
int BVH_Tree< T, N, BVH_BinaryTree >::AddLeafNode ( const BVH_Box< T, N > &  theAABB,
const int  theBegElem,
const int  theEndElem 
)
inline

Adds new leaf node to the BVH.

◆ AddLeafNode() [2/3]

template<class T , int N>
int BVH_Tree< T, N, BVH_BinaryTree >::AddLeafNode ( const BVH_VecNt theMinPoint,
const BVH_VecNt theMaxPoint,
const int  theBegElem,
const int  theEndElem 
)
inline

Adds new leaf node to the BVH.

◆ AddLeafNode() [3/3]

template<class T , int N>
int BVH_Tree< T, N, BVH_BinaryTree >::AddLeafNode ( const int  theBegElem,
const int  theEndElem 
)
inline

Adds new leaf node to the BVH with UNINITIALIZED bounds.

◆ ChangeChild()

template<class T , int N>
template<int K>
int& BVH_Tree< T, N, BVH_BinaryTree >::ChangeChild ( const int  theNodeIndex)
inline

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

Template Parameters
Kthe index of node child (0 or 1)

◆ Child() [1/2]

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

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

Template Parameters
Kthe index of node child (0 or 1)

◆ Child() [2/2]

template<class T , int N>
template<int K>
int BVH_Tree< T, N, BVH_BinaryTree >::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 (0 or 1)

◆ Clear()

template<class T , int N>
void BVH_Tree< T, N, BVH_BinaryTree >::Clear ( )
inline

Removes all nodes from the tree.

◆ CollapseToQuadTree()

template<class T , int N>
BVH_Tree< T, N, BVH_QuadTree > * BVH_Tree< T, N, BVH_BinaryTree >::CollapseToQuadTree

Collapses the tree into QBVH an returns it. As a result, each 2-nd level of current tree is kept and the rest are discarded.

◆ EstimateSAH()

template<class T , int N>
T BVH_Tree< T, N, BVH_BinaryTree >::EstimateSAH

Returns value of SAH (surface area heuristic). Allows to compare the quality of BVH trees constructed for the same sets of geometric objects with different methods.

◆ Reserve()

template<class T , int N>
void BVH_Tree< T, N, BVH_BinaryTree >::Reserve ( const int  theNbNodes)
inline

Reserves internal BVH storage, so that it can contain the given number of BVH nodes.

◆ SetInner()

template<class T , int N>
void BVH_Tree< T, N, BVH_BinaryTree >::SetInner ( const int  theNodeIndex)
inline

Sets node type to 'inner'.

◆ SetOuter()

template<class T , int N>
void BVH_Tree< T, N, BVH_BinaryTree >::SetOuter ( const int  theNodeIndex)
inline

Sets node type to 'outer'.


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