SelectMgr_BVHThreadPool Class Reference

Class defining a thread pool for building BVH for the list of Select3D_SensitiveEntity within background thread(s). More...

#include <SelectMgr_BVHThreadPool.hxx>

Inheritance diagram for SelectMgr_BVHThreadPool:

Data Structures
class	BVHThread
	Thread with back reference to thread pool and thread mutex in it. More...
class	Sentry
	Class providing a simple interface to mutexes for list of BVHThread. More...

Public Member Functions
	SelectMgr_BVHThreadPool (Standard_Integer theNbThreads)
	Main constructor.
virtual	~SelectMgr_BVHThreadPool ()
	Destructor.
void	AddEntity (const Handle< Select3D_SensitiveEntity > &theEntity)
	Queue a sensitive entity to build its BVH.
void	StopThreads ()
	Stops threads.
void	WaitThreads ()
	Waits for all threads finish their jobs.
NCollection_Array1< BVHThread > &	Threads ()
	Returns array of threads.
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.

Protected Attributes
NCollection_List< Handle< Select3D_SensitiveEntity > >	myBVHToBuildList
	list of queued sensitive entities
NCollection_Array1< BVHThread >	myBVHThreads
	threads to build BVH
Standard_Boolean	myToStopBVHThread
	flag to stop BVH threads
Standard_Mutex	myBVHListMutex
	mutex for interaction with myBVHToBuildList
Standard_Condition	myWakeEvent
	raises when any sensitive is added to the BVH list
Standard_Condition	myIdleEvent
	raises when BVH list become empty
Standard_Boolean	myIsStarted
	indicates that threads are running

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

Detailed Description

Class defining a thread pool for building BVH for the list of Select3D_SensitiveEntity within background thread(s).

Constructor & Destructor Documentation

SelectMgr_BVHThreadPool()

SelectMgr_BVHThreadPool::SelectMgr_BVHThreadPool

(

Standard_Integer

theNbThreads

)

Main constructor.

~SelectMgr_BVHThreadPool()

virtual SelectMgr_BVHThreadPool::~SelectMgr_BVHThreadPool ( )

virtual

Destructor.

Member Function Documentation

AddEntity()

void SelectMgr_BVHThreadPool::AddEntity

(

const Handle< Select3D_SensitiveEntity > &

theEntity

)

Queue a sensitive entity to build its BVH.

StopThreads()

void SelectMgr_BVHThreadPool::StopThreads

(

)

Stops threads.

Threads()

NCollection_Array1< BVHThread > & SelectMgr_BVHThreadPool::Threads ( )

inline

Returns array of threads.

WaitThreads()

void SelectMgr_BVHThreadPool::WaitThreads

(

)

Waits for all threads finish their jobs.

Field Documentation

myBVHListMutex

Standard_Mutex SelectMgr_BVHThreadPool::myBVHListMutex

protected

mutex for interaction with myBVHToBuildList

myBVHThreads

NCollection_Array1<BVHThread> SelectMgr_BVHThreadPool::myBVHThreads

protected

threads to build BVH

myBVHToBuildList

NCollection_List<Handle< Select3D_SensitiveEntity > > SelectMgr_BVHThreadPool::myBVHToBuildList

protected

list of queued sensitive entities

myIdleEvent

Standard_Condition SelectMgr_BVHThreadPool::myIdleEvent

protected

raises when BVH list become empty

myIsStarted

Standard_Boolean SelectMgr_BVHThreadPool::myIsStarted

protected

indicates that threads are running

myToStopBVHThread

Standard_Boolean SelectMgr_BVHThreadPool::myToStopBVHThread

protected

flag to stop BVH threads

myWakeEvent

Standard_Condition SelectMgr_BVHThreadPool::myWakeEvent

protected

raises when any sensitive is added to the BVH list

---

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

• SelectMgr_BVHThreadPool.hxx