Open CASCADE Technology  7.7.0.dev
Data Structures | Public Member Functions | Protected Attributes

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:
Inheritance graph
[legend]

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

NCollection_List< Handle< Select3D_SensitiveEntity > > myBVHToBuildList
 list of queued sensitive entities More...
 
NCollection_Array1< BVHThreadmyBVHThreads
 threads to build BVH More...
 
Standard_Boolean myToStopBVHThread
 flag to stop BVH threads More...
 
Standard_Mutex myBVHListMutex
 mutex for interaction with myBVHToBuildList More...
 
Standard_Condition myWakeEvent
 raises when any sensitive is added to the BVH list More...
 
Standard_Condition myIdleEvent
 raises when BVH list become empty More...
 
Standard_Boolean myIsStarted
 indicates that threads are running 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

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: