PxCollection.h

Go to the documentation of this file.
00001 //
00002 // Redistribution and use in source and binary forms, with or without
00003 // modification, are permitted provided that the following conditions
00004 // are met:
00005 //  * Redistributions of source code must retain the above copyright
00006 //    notice, this list of conditions and the following disclaimer.
00007 //  * Redistributions in binary form must reproduce the above copyright
00008 //    notice, this list of conditions and the following disclaimer in the
00009 //    documentation and/or other materials provided with the distribution.
00010 //  * Neither the name of NVIDIA CORPORATION nor the names of its
00011 //    contributors may be used to endorse or promote products derived
00012 //    from this software without specific prior written permission.
00013 //
00014 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
00015 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00016 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00017 // PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00018 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00019 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00020 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00021 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
00022 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00023 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00024 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00025 //
00026 // Copyright (c) 2008-2018 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


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