PxSceneReadLock Class Reference

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

#include <PxSceneLock.h>

Collaboration diagram for PxSceneReadLock:

Public Member Functions
	PxSceneReadLock (PxScene &scene, const char *file=NULL, PxU32 line=0)
	Constructor. More...
	~PxSceneReadLock ()

Private Member Functions
	PxSceneReadLock (const PxSceneReadLock &)
PxSceneReadLock &	operator= (const PxSceneReadLock &)

Private Attributes
PxScene &	mScene

Detailed Description

RAII wrapper for the PxScene read lock.

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

PxSceneReadLock lock(sceneRef);

See also

PxScene::lockRead(), PxScene::unlockRead(), PxSceneFlag::eREQUIRE_RW_LOCK

Constructor & Destructor Documentation

PxSceneReadLock() [1/2]

PxSceneReadLock::PxSceneReadLock ( const PxSceneReadLock &  )

private

PxSceneReadLock() [2/2]

PxSceneReadLock::PxSceneReadLock ( PxScene &  scene, const char *  file = NULL, PxU32  line = 0  )

inline

Constructor.

Parameters

scene	The scene to lock for reading
file	Optional string for debugging purposes
line	Optional line number for debugging purposes

~PxSceneReadLock()

PxSceneReadLock::~PxSceneReadLock ( )

inline

Member Function Documentation

operator=()

PxSceneReadLock& PxSceneReadLock::operator= ( const PxSceneReadLock &  )

private

Member Data Documentation

mScene

PxScene& PxSceneReadLock::mScene

private

---

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

• PxSceneLock.h