Stores parameters of bounding volume hierarchy (BVH). Bounding volume hierarchy (BVH) organizes geometric objects in the tree based on spatial relationships. Each node in the tree contains an axis-aligned bounding box of all the objects below it. Bounding volume hierarchies are used in many algorithms to support efficient operations on the sets of geometric objects, such as collision detection, ray-tracing, searching of nearest objects, and view frustum culling. More...

#include <BVH_Tree.hxx>

Inheritance diagram for BVH_TreeBase< T, N >:

[legend]

Public Types
custom data types
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.

Public Member Functions
general methods
	BVH_TreeBase ()
	Creates new empty 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.

methods for accessing individual nodes
BVH_VecNt &	MinPoint (const int theNodeIndex)
	Returns minimum 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.

methods for accessing serialized tree data
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.

Data Fields
protected fields
BVH_Array4i	myNodeInfoBuffer
	Array of node data records.

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).

Additional Inherited Members
Static Public Member Functions inherited from Standard_Transient
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.

Protected Member Functions inherited from BVH_TreeBaseTransient
	BVH_TreeBaseTransient ()

Detailed Description

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

Stores parameters of bounding volume hierarchy (BVH). Bounding volume hierarchy (BVH) organizes geometric objects in the tree based on spatial relationships. Each node in the tree contains an axis-aligned bounding box of all the objects below it. Bounding volume hierarchies are used in many algorithms to support efficient operations on the sets of geometric objects, such as collision detection, ray-tracing, searching of nearest objects, and view frustum culling.

Member Typedef Documentation

◆ BVH_VecNt

template<class T , int N>

typedef BVH_Box<T,N>::BVH_VecNt BVH_TreeBase< T, N >::BVH_VecNt

Constructor & Destructor Documentation

◆ BVH_TreeBase()

template<class T , int N>

BVH_TreeBase< T, N >::BVH_TreeBase ( )

inline

Creates new empty BVH tree.

◆ ~BVH_TreeBase()

template<class T , int N>

virtual BVH_TreeBase< T, N >::~BVH_TreeBase ( )

inlinevirtual

Releases resources of BVH tree.

Member Function Documentation

◆ BegPrimitive() [1/2]

template<class T , int N>

int & BVH_TreeBase< T, N >::BegPrimitive ( const int theNodeIndex )

inline

Returns index of first primitive of the given leaf node.

◆ BegPrimitive() [2/2]

template<class T , int N>

int BVH_TreeBase< T, N >::BegPrimitive ( const int theNodeIndex ) const

inline

Returns index of first primitive of the given leaf node.

◆ Depth()

template<class T , int N>

int BVH_TreeBase< T, N >::Depth ( ) const

inline

Returns depth (height) of BVH tree.

◆ DumpJson()

template<class T , int N>

virtual void BVH_TreeBase< T, N >::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

inlineoverridevirtual

Dumps the content of me into the stream.

Reimplemented from BVH_TreeBaseTransient.

◆ DumpNode()

template<class T , int N>

virtual void BVH_TreeBase< T, N >::DumpNode	(	const int	theNodeIndex,
		Standard_OStream &	theOStream,
		Standard_Integer	theDepth
	)		const

inlineoverridevirtual

Dumps the content of node into the stream.

Reimplemented from BVH_TreeBaseTransient.

◆ EndPrimitive() [1/2]

template<class T , int N>

int & BVH_TreeBase< T, N >::EndPrimitive ( const int theNodeIndex )

inline

Returns index of last primitive of the given leaf node.

◆ EndPrimitive() [2/2]

template<class T , int N>

int BVH_TreeBase< T, N >::EndPrimitive ( const int theNodeIndex ) const

inline

Returns index of last primitive of the given leaf node.

◆ IsOuter()

template<class T , int N>

bool BVH_TreeBase< T, N >::IsOuter ( const int theNodeIndex ) const

inline

Checks whether the given node is outer.

◆ Length()

template<class T , int N>

int BVH_TreeBase< T, N >::Length ( ) const

inline

Returns total number of BVH tree nodes.

◆ Level() [1/2]

template<class T , int N>

int & BVH_TreeBase< T, N >::Level ( const int theNodeIndex )

inline

Returns level (depth) of the given node.

◆ Level() [2/2]

template<class T , int N>

int BVH_TreeBase< T, N >::Level ( const int theNodeIndex ) const

inline

Returns level (depth) of the given node.

◆ MaxPoint() [1/2]

template<class T , int N>

BVH_VecNt & BVH_TreeBase< T, N >::MaxPoint ( const int theNodeIndex )

inline

Returns maximum point of the given node.

◆ MaxPoint() [2/2]

template<class T , int N>

const BVH_VecNt & BVH_TreeBase< T, N >::MaxPoint ( const int theNodeIndex ) const

inline

Returns maximum point of the given node.

◆ MaxPointBuffer() [1/2]

template<class T , int N>

BVH::ArrayType< T, N >::Type & BVH_TreeBase< T, N >::MaxPointBuffer ( )

inline

Returns array of node maximum points.

◆ MaxPointBuffer() [2/2]

template<class T , int N>

const BVH::ArrayType< T, N >::Type & BVH_TreeBase< T, N >::MaxPointBuffer ( ) const

inline

Returns array of node maximum points.

◆ MinPoint() [1/2]

template<class T , int N>

BVH_VecNt & BVH_TreeBase< T, N >::MinPoint ( const int theNodeIndex )

inline

Returns minimum point of the given node.

◆ MinPoint() [2/2]

template<class T , int N>

const BVH_VecNt & BVH_TreeBase< T, N >::MinPoint ( const int theNodeIndex ) const

inline

Returns minimum point of the given node.

◆ MinPointBuffer() [1/2]

template<class T , int N>

BVH::ArrayType< T, N >::Type & BVH_TreeBase< T, N >::MinPointBuffer ( )

inline

Returns array of node minimum points.

◆ MinPointBuffer() [2/2]

template<class T , int N>

const BVH::ArrayType< T, N >::Type & BVH_TreeBase< T, N >::MinPointBuffer ( ) const

inline

Returns array of node minimum points.

◆ NbPrimitives()

template<class T , int N>

int BVH_TreeBase< T, N >::NbPrimitives ( const int theNodeIndex ) const

inline

Returns number of primitives in the given leaf node.

◆ NodeInfoBuffer() [1/2]

template<class T , int N>

BVH_Array4i & BVH_TreeBase< T, N >::NodeInfoBuffer ( )

inline

Returns array of node data records.

◆ NodeInfoBuffer() [2/2]

template<class T , int N>

const BVH_Array4i & BVH_TreeBase< T, N >::NodeInfoBuffer ( ) const

inline

Returns array of node data records.

Field Documentation

◆ myDepth

template<class T , int N>

int BVH_TreeBase< T, N >::myDepth

Current depth of BVH tree (set by builder).

◆ myMaxPointBuffer

template<class T , int N>

BVH::ArrayType<T,N>::Type BVH_TreeBase< T, N >::myMaxPointBuffer

Array of node maximum points.

◆ myMinPointBuffer

template<class T , int N>

BVH::ArrayType<T,N>::Type BVH_TreeBase< T, N >::myMinPointBuffer

Array of node minimum points.

◆ myNodeInfoBuffer

template<class T , int N>

BVH_Array4i BVH_TreeBase< T, N >::myNodeInfoBuffer

Array of node data records.

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

BVH_Tree.hxx

Public Types

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BVH_VecNt

Constructor & Destructor Documentation

◆ BVH_TreeBase()

◆ ~BVH_TreeBase()

Member Function Documentation

◆ BegPrimitive() [1/2]

◆ BegPrimitive() [2/2]

◆ Depth()

◆ DumpJson()

◆ DumpNode()

◆ EndPrimitive() [1/2]

◆ EndPrimitive() [2/2]

◆ IsOuter()

◆ Length()

◆ Level() [1/2]

◆ Level() [2/2]

◆ MaxPoint() [1/2]

◆ MaxPoint() [2/2]

◆ MaxPointBuffer() [1/2]

◆ MaxPointBuffer() [2/2]

◆ MinPoint() [1/2]

◆ MinPoint() [2/2]

◆ MinPointBuffer() [1/2]

◆ MinPointBuffer() [2/2]

◆ NbPrimitives()

◆ NodeInfoBuffer() [1/2]

◆ NodeInfoBuffer() [2/2]

Field Documentation

◆ myDepth

◆ myMaxPointBuffer

◆ myMinPointBuffer

◆ myNodeInfoBuffer