PxSpatialIndex.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_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-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com