Open CASCADE Technology  7.6.0.dev
Data Structures | Public Member Functions | Protected Member Functions | Protected Attributes
BVH_QueueBuilder< T, N > Class Template Referenceabstract

Abstract BVH builder based on the concept of work queue. Queue based BVH builders support parallelization with a fixed number of threads (maximum efficiency is achieved by setting the number of threads equal to the number of CPU cores plus one). Note that to support parallel mode, a corresponding BVH primitive set should provide thread safe implementations of interface functions (e.g., Swap, Box, Center). Otherwise, the results will be undefined. More...

#include <BVH_QueueBuilder.hxx>

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

Data Structures

struct  BVH_ChildNodes
 Stores parameters of constructed child nodes. More...
 
struct  BVH_PrimitiveRange
 Stores range of primitives belonging to a BVH node. More...
 
class  BVH_TypedBuildTool
 Wrapper for BVH build data. More...
 

Public Member Functions

 BVH_QueueBuilder (const Standard_Integer theLeafNodeSize, const Standard_Integer theMaxTreeDepth, const Standard_Integer theNumOfThreads=1)
 Creates new BVH queue based builder. More...
 
virtual ~BVH_QueueBuilder ()
 Releases resources of BVH queue based builder. More...
 
virtual void Build (BVH_Set< T, N > *theSet, BVH_Tree< T, N > *theBVH, const BVH_Box< T, N > &theBox) const override
 Builds BVH using specific algorithm. More...
 
- Public Member Functions inherited from BVH_BuilderTransient
Standard_Integer MaxTreeDepth () const
 Returns the maximum depth of constructed BVH. More...
 
Standard_Integer LeafNodeSize () const
 Returns the maximum number of sub-elements in the leaf. More...
 
Standard_Boolean IsParallel () const
 Returns parallel flag. More...
 
void SetParallel (const Standard_Boolean isParallel)
 Set parallel flag contolling possibility of parallel execution. 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...
 

Protected Member Functions

virtual BVH_QueueBuilder< T, N >::BVH_ChildNodes buildNode (BVH_Set< T, N > *theSet, BVH_Tree< T, N > *theBVH, const Standard_Integer theNode) const =0
 Performs splitting of the given BVH node. More...
 
virtual void addChildren (BVH_Tree< T, N > *theBVH, BVH_BuildQueue &theBuildQueue, const Standard_Integer theNode, const BVH_ChildNodes &theSubNodes) const
 Processes child nodes of the splitted BVH node. More...
 
- Protected Member Functions inherited from BVH_Builder< T, N >
 BVH_Builder (const Standard_Integer theLeafNodeSize, const Standard_Integer theMaxTreeDepth)
 Creates new abstract BVH builder. More...
 
void updateDepth (BVH_Tree< T, N > *theBVH, const Standard_Integer theLevel) const
 Updates depth of constructed BVH tree. More...
 
- Protected Member Functions inherited from BVH_BuilderTransient
 BVH_BuilderTransient (const Standard_Integer theLeafNodeSize, const Standard_Integer theMaxTreeDepth)
 Creates new abstract BVH builder. More...
 

Protected Attributes

Standard_Integer myNumOfThreads
 Number of threads used to build BVH. More...
 
- Protected Attributes inherited from BVH_BuilderTransient
Standard_Integer myMaxTreeDepth
 Maximum depth of constructed BVH. More...
 
Standard_Integer myLeafNodeSize
 Maximum number of objects per leaf. More...
 
Standard_Boolean myIsParallel
 Parallel execution flag. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- 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...
 

Detailed Description

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

Abstract BVH builder based on the concept of work queue. Queue based BVH builders support parallelization with a fixed number of threads (maximum efficiency is achieved by setting the number of threads equal to the number of CPU cores plus one). Note that to support parallel mode, a corresponding BVH primitive set should provide thread safe implementations of interface functions (e.g., Swap, Box, Center). Otherwise, the results will be undefined.

Template Parameters
TNumeric data type
NVector dimension

Constructor & Destructor Documentation

◆ BVH_QueueBuilder()

template<class T , int N>
BVH_QueueBuilder< T, N >::BVH_QueueBuilder ( const Standard_Integer  theLeafNodeSize,
const Standard_Integer  theMaxTreeDepth,
const Standard_Integer  theNumOfThreads = 1 
)
inline

Creates new BVH queue based builder.

◆ ~BVH_QueueBuilder()

template<class T , int N>
virtual BVH_QueueBuilder< T, N >::~BVH_QueueBuilder ( )
inlinevirtual

Releases resources of BVH queue based builder.

Member Function Documentation

◆ addChildren()

template<class T , int N>
void BVH_QueueBuilder< T, N >::addChildren ( BVH_Tree< T, N > *  theBVH,
BVH_BuildQueue theBuildQueue,
const Standard_Integer  theNode,
const BVH_ChildNodes theSubNodes 
) const
protectedvirtual

Processes child nodes of the splitted BVH node.

◆ Build()

template<class T , int N>
void BVH_QueueBuilder< T, N >::Build ( BVH_Set< T, N > *  theSet,
BVH_Tree< T, N > *  theBVH,
const BVH_Box< T, N > &  theBox 
) const
overridevirtual

Builds BVH using specific algorithm.

Implements BVH_Builder< T, N >.

◆ buildNode()

template<class T , int N>
virtual BVH_QueueBuilder<T, N>::BVH_ChildNodes BVH_QueueBuilder< T, N >::buildNode ( BVH_Set< T, N > *  theSet,
BVH_Tree< T, N > *  theBVH,
const Standard_Integer  theNode 
) const
protectedpure virtual

Performs splitting of the given BVH node.

Implemented in BVH_BinnedBuilder< T, N, Bins >, BVH_BinnedBuilder< T, N, 2 >, and BVH_SweepPlaneBuilder< T, N >.

Field Documentation

◆ myNumOfThreads

template<class T , int N>
Standard_Integer BVH_QueueBuilder< T, N >::myNumOfThreads
protected

Number of threads used to build BVH.


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