NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVolumeCache.h Source File

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-2016 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 #ifndef PX_PHYSICS_NX_VOLUMECACHE
+00031 #define PX_PHYSICS_NX_VOLUMECACHE
+00032 
+00036 #include "PxScene.h"
+00037 #include "geometry/PxGeometryHelpers.h"
+00038 
+00039 #if !PX_DOXYGEN
+00040 namespace physx
+00041 {
+00042 #endif
+00043 
+00053 class PX_DEPRECATED PxVolumeCache
+00054 {
+00055 public:
+00063     struct Iterator
+00064     {
+00073         virtual void processShapes(PxU32 count, const PxActorShape* actorShapePairs) = 0;
+00074 
+00080         virtual void finalizeQuery() {}
+00081     protected:
+00082         virtual ~Iterator() {}
+00083     };
+00084 
+00085 
+00091     enum FillStatus
+00092     {
+00097         FILL_OK,
+00098 
+00107         FILL_OVER_MAX_COUNT,
+00108 
+00115         FILL_UNSUPPORTED_GEOMETRY_TYPE,
+00116 
+00121         FILL_OUT_OF_MEMORY
+00122     };
+00123 
+00134     virtual FillStatus fill(const PxGeometry& cacheVolume, const PxTransform& pose) = 0;
+00135     
+00143     virtual bool isValid() const = 0;
+00144 
+00151     virtual void invalidate() = 0;
+00152 
+00160     virtual bool getCacheVolume(PxGeometryHolder& resultVolume, PxTransform& resultPose) = 0;
+00161 
+00167     virtual PxI32 getNbCachedShapes() = 0;
+00168 
+00174     virtual void release() = 0;
+00175 
+00185     virtual void forEach(Iterator& iter) = 0; 
+00186 
+00194     virtual void setMaxNbStaticShapes(PxU32 maxCount) = 0;
+00195 
+00203     virtual void setMaxNbDynamicShapes(PxU32 maxCount) = 0;
+00204 
+00210     virtual PxU32 getMaxNbStaticShapes() = 0;
+00211 
+00217     virtual PxU32 getMaxNbDynamicShapes() = 0;
+00218 
+00238     virtual bool raycast(
+00239         const PxVec3& origin, const PxVec3& unitDir, const PxReal distance,
+00240         PxRaycastCallback& hitCall, PxHitFlags hitFlags = PxHitFlags(PxHitFlag::eDEFAULT),
+00241         const PxQueryFilterData& filterData = PxQueryFilterData(), PxQueryFilterCallback* filterCall = NULL) const = 0;
+00242 
+00262     virtual bool sweep(
+00263         const PxGeometry& geometry, const PxTransform& pose, const PxVec3& unitDir, const PxReal distance,
+00264         PxSweepCallback& hitCall, PxHitFlags hitFlags = PxHitFlag::eDEFAULT,
+00265         const PxQueryFilterData& filterData = PxQueryFilterData(), PxQueryFilterCallback* filterCall = NULL,
+00266         const PxReal inflation = 0.f) const = 0;
+00267 
+00268 
+00283     virtual bool overlap(
+00284         const PxGeometry& geometry, const PxTransform& pose, PxOverlapCallback& hitCall,
+00285         const PxQueryFilterData& filterData = PxQueryFilterData(), PxQueryFilterCallback* filterCall = NULL) const = 0;
+00286 
+00287 protected:
+00288     virtual ~PxVolumeCache() {}
+00289 }; // class PxVolumeCache
+00290 
+00291 #if !PX_DOXYGEN
+00292 } // namespace physx
+00293 #endif
+00294 
+00296 #endif
+