PxSceneWriteLock Class Reference

RAII wrapper for the PxScene write lock. More...

#include <PxSceneLock.h>

Collaboration diagram for PxSceneWriteLock:

Public Member Functions

 PxSceneWriteLock (PxScene &scene, const char *file=NULL, PxU32 line=0)
 Constructor. More...
 
 ~PxSceneWriteLock ()
 

Private Member Functions

 PxSceneWriteLock (const PxSceneWriteLock &)
 
PxSceneWriteLockoperator= (const PxSceneWriteLock &)
 

Private Attributes

PxScenemScene
 

Detailed Description

RAII wrapper for the PxScene write lock.

Use this class as follows to lock the scene for writing by the current thread for the duration of the enclosing scope:

PxSceneWriteLock lock(sceneRef);

See also
PxScene::lockWrite(), PxScene::unlockWrite(), PxSceneFlag::eREQUIRE_RW_LOCK

Constructor & Destructor Documentation

◆ PxSceneWriteLock() [1/2]

PxSceneWriteLock::PxSceneWriteLock ( const PxSceneWriteLock )
private

◆ PxSceneWriteLock() [2/2]

PxSceneWriteLock::PxSceneWriteLock ( PxScene scene,
const char *  file = NULL,
PxU32  line = 0 
)
inline

Constructor.

Parameters
sceneThe scene to lock for writing
fileOptional string for debugging purposes
lineOptional line number for debugging purposes

◆ ~PxSceneWriteLock()

PxSceneWriteLock::~PxSceneWriteLock ( )
inline

Member Function Documentation

◆ operator=()

PxSceneWriteLock& PxSceneWriteLock::operator= ( const PxSceneWriteLock )
private

Member Data Documentation

◆ mScene

PxScene& PxSceneWriteLock::mScene
private

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