NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSceneWriteLock Class Reference

NVIDIA PhysX API

PxSceneWriteLock Class Reference
[Physics]

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

#include <PxSceneLock.h>

Collaboration diagram for PxSceneWriteLock:

List of all members.


Public Member Functions

 PxSceneWriteLock (PxScene &scene, const char *file=NULL, PxU32 line=0)
 Constructor.
 ~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::PxSceneWriteLock ( const PxSceneWriteLock  )  [private]

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

Constructor.

Parameters:
scene The scene to lock for writing
file Optional string for debugging purposes
line Optional line number for debugging purposes

PxSceneWriteLock::~PxSceneWriteLock (  )  [inline]


Member Function Documentation

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


Member Data Documentation


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



Copyright © 2008-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com