Specialization of binary BVH tree. More...

#include <BVH_BinaryTree.hxx>

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

[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

typedef void	base_type
	Returns a type descriptor about this object.

Public Member Functions
methods for accessing individual nodes
Creates new empty BVH tree.
	BVH_Tree ()
	Sets node type to 'outer'.

void	SetOuter (const int theNodeIndex)
	Sets node type to 'outer'.

void	SetInner (const int theNodeIndex)
	Sets node type to 'inner'.

template<int K>
int	Child (const int theNodeIndex) const
	Returns index of the K-th child of the given inner node.

template<int K>
int &	ChangeChild (const int theNodeIndex)
	Returns index of the K-th child of the given inner node.

template<int K>
int &	Child (const int theNodeIndex)
	Returns index of the K-th child of the given inner node.

methods for adding/removing tree nodes
Removes all nodes from the tree.
void	Clear ()
	Reserves internal BVH storage, so that it can contain the given number of BVH nodes.

void	Reserve (const int theNbNodes)
	Reserves internal BVH storage, so that it can contain the given number of BVH nodes.

int	AddLeafNode (const BVH_VecNt &theMinPoint, const BVH_VecNt &theMaxPoint, const int theBegElem, const int theEndElem)
	Adds new leaf node to the BVH.

int	AddInnerNode (const BVH_VecNt &theMinPoint, const BVH_VecNt &theMaxPoint, const int theLftChild, const int theRghChild)
	Adds new inner node to the BVH.

int	AddLeafNode (const BVH_Box< T, N > &theAABB, const int theBegElem, const int theEndElem)
	Adds new leaf node to the BVH.

int	AddInnerNode (const BVH_Box< T, N > &theAABB, const int theLftChild, const int theRghChild)
	Adds new inner node to the BVH.

int	AddLeafNode (const int theBegElem, const int theEndElem)
	Adds new leaf node to the BVH with UNINITIALIZED bounds.

int	AddInnerNode (const int theLftChild, const int theRghChild)
	Adds new inner node to the BVH with UNINITIALIZED bounds.

methods specific to binary BVH
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.
T	EstimateSAH () 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.

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.

Public Member Functions inherited from BVH_TreeBase< T, N >
	BVH_TreeBase ()
	Releases resources of BVH tree.

virtual	~BVH_TreeBase ()
	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.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

virtual void	DumpNode (const int theNodeIndex, Standard_OStream &theOStream, Standard_Integer 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 ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
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_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

Sets node type to 'outer'.

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

K	the 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

K	the 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

K	the index of node child (0 or 1)

◆ Clear()

template<class T, int N>

void BVH_Tree< T, N, BVH_BinaryTree >::Clear ( )

inline

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

◆ CollapseToQuadTree()

template<class T, int N>

BVH_Tree< T, N, BVH_QuadTree > * BVH_Tree< T, N, BVH_BinaryTree >::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.

◆ EstimateSAH()

template<class T, int N>

T BVH_Tree< T, N, BVH_BinaryTree >::EstimateSAH ( ) 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.

◆ 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:

BVH_BinaryTree.hxx

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BVH_VecNt

Constructor & Destructor Documentation

◆ BVH_Tree()

Member Function Documentation

◆ AddInnerNode() [1/3]

◆ AddInnerNode() [2/3]

◆ AddInnerNode() [3/3]

◆ AddLeafNode() [1/3]

◆ AddLeafNode() [2/3]

◆ AddLeafNode() [3/3]

◆ ChangeChild()

◆ Child() [1/2]

◆ Child() [2/2]

◆ Clear()

◆ CollapseToQuadTree()

◆ EstimateSAH()

◆ Reserve()

◆ SetInner()

◆ SetOuter()