PxSceneLock.h
Go to the documentation of this file.
1 //
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions
4 // are met:
5 // * Redistributions of source code must retain the above copyright
6 // notice, this list of conditions and the following disclaimer.
7 // * Redistributions in binary form must reproduce the above copyright
8 // notice, this list of conditions and the following disclaimer in the
9 // documentation and/or other materials provided with the distribution.
10 // * Neither the name of NVIDIA CORPORATION nor the names of its
11 // contributors may be used to endorse or promote products derived
12 // from this software without specific prior written permission.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
15 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.
27 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29 
30 
31 #ifndef PX_PHYSICS_NX_SCENELOCK
32 #define PX_PHYSICS_NX_SCENELOCK
33 
37 #include "PxPhysXConfig.h"
38 #include "PxScene.h"
39 
40 #if !PX_DOXYGEN
41 namespace physx
42 {
43 #endif
44 
56 {
58  PxSceneReadLock& operator=(const PxSceneReadLock&);
59 
60 public:
61 
68  PxSceneReadLock(PxScene& scene, const char* file=NULL, PxU32 line=0)
69  : mScene(scene)
70  {
71  mScene.lockRead(file, line);
72  }
73 
75  {
76  mScene.unlockRead();
77  }
78 
79 private:
80 
82 };
83 
95 {
97  PxSceneWriteLock& operator=(const PxSceneWriteLock&);
98 
99 public:
100 
107  PxSceneWriteLock(PxScene& scene, const char* file=NULL, PxU32 line=0)
108  : mScene(scene)
109  {
110  mScene.lockWrite(file, line);
111  }
112 
114  {
115  mScene.unlockWrite();
116  }
117 
118 private:
119 
121 };
122 
123 
124 #if !PX_DOXYGEN
125 } // namespace physx
126 #endif
127 
129 #endif
Definition: GuContactBuffer.h:37
~PxSceneReadLock()
Definition: PxSceneLock.h:74
A scene is a collection of bodies and constraints which can interact.
Definition: PxScene.h:169
RAII wrapper for the PxScene read lock.
Definition: PxSceneLock.h:55
RAII wrapper for the PxScene write lock.
Definition: PxSceneLock.h:94
PxSceneReadLock(PxScene &scene, const char *file=NULL, PxU32 line=0)
Constructor.
Definition: PxSceneLock.h:68
PxScene & mScene
Definition: PxSceneLock.h:120
~PxSceneWriteLock()
Definition: PxSceneLock.h:113
uint32_t PxU32
Definition: Px.h:48
PxScene & mScene
Definition: PxSceneLock.h:81
PxSceneWriteLock(PxScene &scene, const char *file=NULL, PxU32 line=0)
Constructor.
Definition: PxSceneLock.h:107