PxCollection.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-2018 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_PX_COLLECTION
32 #define PX_PHYSICS_PX_COLLECTION
33 
34 #include "PxSerialFramework.h"
35 
40 #if !PX_DOXYGEN
41 namespace physx
42 {
43 #endif
44 
45 class PxBase;
46 
106 {
107 public:
108 
122  virtual void add(PxBase& object, PxSerialObjectId id = PX_SERIAL_OBJECT_ID_INVALID) = 0;
123 
131  virtual void remove(PxBase& object) = 0;
132 
139  virtual bool contains(PxBase& object) const = 0;
140 
151  virtual void addId(PxBase& object, PxSerialObjectId id) = 0;
152 
160  virtual void removeId(PxSerialObjectId id) = 0;
161 
170  virtual void add(PxCollection& collection) = 0;
171 
180  virtual void remove(PxCollection& collection) = 0;
181 
187  virtual PxU32 getNbObjects() const = 0;
188 
195  virtual PxBase& getObject(PxU32 index) const = 0;
196 
205  virtual PxU32 getObjects(PxBase** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;
206 
215  virtual PxBase* find(PxSerialObjectId id) const = 0;
216 
222  virtual PxU32 getNbIds() const = 0;
223 
232  virtual PxU32 getIds(PxSerialObjectId* userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;
233 
242  virtual PxSerialObjectId getId(const PxBase& object) const = 0;
243 
253  virtual void release() = 0;
254 
255 protected:
257  virtual ~PxCollection() {}
258 };
259 
260 #if !PX_DOXYGEN
261 } // namespace physx
262 #endif
263 
276 
277 
279 #endif
Definition: GuContactBuffer.h:37
#define PX_CALL_CONV
Definition: PxPreprocessor.h:328
PxU64 PxSerialObjectId
ID type for PxBase objects in a PxCollection.
Definition: PxSerialFramework.h:62
virtual ~PxCollection()
Definition: PxCollection.h:257
PX_PHYSX_COMMON_API physx::PxCollection *PX_CALL_CONV PxCreateCollection()
Creates a collection object.
Collection class for serialization.
Definition: PxCollection.h:105
#define PX_SERIAL_OBJECT_ID_INVALID
PxSerialObjectId value for objects that do not have an ID.
Definition: PxSerialFramework.h:59
#define PX_PHYSX_COMMON_API
Definition: PxPhysXCommonConfig.h:97
uint32_t PxU32
Definition: Px.h:48
Base class for objects that can be members of a PxCollection.
Definition: PxBase.h:73
PxCollection()
Definition: PxCollection.h:256