00001 // This code contains NVIDIA Confidential Information and is disclosed to you
00002 // under a form of NVIDIA software license agreement provided separately to you.
00003 //
00004 // Notice
00005 // NVIDIA Corporation and its licensors retain all intellectual property and
00006 // proprietary rights in and to this software and related documentation and
00007 // any modifications thereto. Any use, reproduction, disclosure, or
00008 // distribution of this software and related documentation without an express
00009 // license agreement from NVIDIA Corporation is strictly prohibited.
00010 //
00011 // ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
00012 // NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
00013 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
00014 // MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
00015 //
00016 // Information and code furnished is believed to be accurate and reliable.
00017 // However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
00018 // information or for any infringement of patents or other rights of third parties that may
00019 // result from its use. No license is granted by implication or otherwise under any patent
00020 // or patent rights of NVIDIA Corporation. Details are subject to change without notice.
00021 // This code supersedes and replaces all information previously supplied.
00022 // NVIDIA Corporation products are not authorized for use as critical
00023 // components in life support devices or systems without express written approval of
00024 // NVIDIA Corporation.
00025 //
00026 // Copyright (c) 2008-2017 NVIDIA Corporation. All rights reserved.
00027 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
00028 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  
00029 
00030 
00031 #ifndef PX_PHYSICS_PX_COLLECTION
00032 #define PX_PHYSICS_PX_COLLECTION
00033 
00034 #include "PxSerialFramework.h"
00035 
00040 #if !PX_DOXYGEN
00041 namespace physx
00042 {
00043 #endif
00044 
00045 class PxBase;
00046 
00105 class PxCollection
00106 {
00107 public: 
00108 
00122     virtual void                        add(PxBase& object, PxSerialObjectId id = PX_SERIAL_OBJECT_ID_INVALID) = 0;
00123 
00131     virtual void                        remove(PxBase& object) = 0;
00132             
00139     virtual bool                        contains(PxBase& object) const = 0;
00140 
00151     virtual void                        addId(PxBase& object, PxSerialObjectId id) = 0;
00152 
00160     virtual void                        removeId(PxSerialObjectId id) = 0;
00161     
00170     virtual void                        add(PxCollection& collection) = 0;
00171 
00180     virtual void                        remove(PxCollection& collection) = 0;
00181 
00187     virtual PxU32                       getNbObjects() const = 0;
00188 
00195     virtual PxBase&                     getObject(PxU32 index) const = 0;
00196 
00205     virtual PxU32                       getObjects(PxBase** userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;
00206 
00215     virtual PxBase*                     find(PxSerialObjectId id) const = 0;
00216     
00222     virtual PxU32                       getNbIds() const = 0;
00223 
00232     virtual PxU32                       getIds(PxSerialObjectId* userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const = 0;
00233 
00242     virtual PxSerialObjectId            getId(const PxBase& object) const = 0;  
00243 
00253     virtual void                        release() = 0;
00254 
00255 protected:
00256                                         PxCollection()  {}
00257     virtual                             ~PxCollection() {}
00258 };
00259     
00260 #if !PX_DOXYGEN
00261 } // namespace physx
00262 #endif
00263 
00275 PX_PHYSX_COMMON_API physx::PxCollection* PX_CALL_CONV PxCreateCollection();
00276 
00277 
00279 #endif