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

NVIDIA PhysX SDK 3.4 API

PxSpatialIndex.h

Go to the documentation of this 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-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_SPATIAL_INDEX
00032 #define PX_PHYSICS_SPATIAL_INDEX
00033 
00036 #include "PxPhysXConfig.h"
00037 #include "foundation/PxTransform.h"
00038 #include "geometry/PxGeometry.h"
00039 #include "PxQueryReport.h"
00040 
00041 #if !PX_DOXYGEN
00042 namespace physx
00043 {
00044 #endif
00045 
00046 typedef PxU32 PxSpatialIndexItemId;
00047 static const PxSpatialIndexItemId PX_SPATIAL_INDEX_INVALID_ITEM_ID = 0xffffffff;
00048 
00049 
00050 class PX_DEPRECATED PxSpatialIndexItem
00051 {
00052 };
00053 
00061 struct PX_DEPRECATED PxSpatialOverlapCallback
00062 {
00063 
00071     virtual PxAgain onHit(PxSpatialIndexItem& item) = 0;
00072 
00073     virtual ~PxSpatialOverlapCallback() {}
00074 };
00075 
00083 struct PX_DEPRECATED PxSpatialLocationCallback
00084 {
00096     virtual PxAgain onHit(PxSpatialIndexItem& item, PxReal distance, PxReal& shrunkDistance) = 0;
00097 
00098     virtual ~PxSpatialLocationCallback() {}
00099 };
00100 
00101 
00102 
00116 class PX_DEPRECATED PxSpatialIndex
00117 {
00118 public:
00119 
00120 
00127     virtual PxSpatialIndexItemId    insert(PxSpatialIndexItem& item,
00128                                            const PxBounds3& bounds)                         = 0;
00129 
00136     virtual void                    update(PxSpatialIndexItemId id,
00137                                            const PxBounds3& bounds)                         = 0;
00138 
00144     virtual void                    remove(PxSpatialIndexItemId id)                         = 0;
00145 
00146 
00153     virtual void                    overlap(const PxBounds3 &aabb,
00154                                             PxSpatialOverlapCallback& callback) const   = 0;
00155 
00164     virtual void                    raycast(const PxVec3& origin, 
00165                                             const PxVec3& unitDir, 
00166                                             PxReal maxDist, 
00167                                             PxSpatialLocationCallback& callback)    const   = 0;
00168 
00177     virtual void                    sweep(const PxBounds3& aabb, 
00178                                           const PxVec3& unitDir, 
00179                                           PxReal maxDist, 
00180                                           PxSpatialLocationCallback& callback)      const   = 0;
00181 
00189     virtual void                    flush()                                                 = 0;
00190 
00194     virtual void                    rebuildFull()                                           = 0;
00195 
00207     virtual void                    setIncrementalRebuildRate(PxU32 rate)                   = 0;
00208 
00212     virtual void                    rebuildStep()                                           = 0;
00213 
00217     virtual void                    release()                                               = 0;
00218 protected:
00219     virtual                         ~PxSpatialIndex(){}
00220 };
00221 
00229 PX_DEPRECATED PX_PHYSX_CORE_API PxSpatialIndex* PxCreateSpatialIndex();
00230 
00231 #if !PX_DOXYGEN
00232 } // namespace physx
00233 #endif
00234 
00236 #endif


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