PxSpatialIndex.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_PHYSICS_SPATIAL_INDEX
#define PX_PHYSICS_SPATIAL_INDEX

#include "PxPhysXConfig.h"
#include "foundation/PxTransform.h"
#include "geometry/PxGeometry.h"
#include "PxQueryReport.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

typedef PxU32 PxSpatialIndexItemId;
static const PxSpatialIndexItemId PX_SPATIAL_INDEX_INVALID_ITEM_ID = 0xffffffff;


class PxSpatialIndexItem
{
};

struct PxSpatialOverlapCallback
{

    virtual PxAgain onHit(PxSpatialIndexItem& item) = 0;

    virtual ~PxSpatialOverlapCallback() {}
};

struct PxSpatialLocationCallback
{
    virtual PxAgain onHit(PxSpatialIndexItem& item, PxReal distance, PxReal& shrunkDistance) = 0;

    virtual ~PxSpatialLocationCallback() {}
};



class PxSpatialIndex
{
public:


    virtual PxSpatialIndexItemId    insert(PxSpatialIndexItem& item,
                                           const PxBounds3& bounds)                         = 0;

    virtual void                    update(PxSpatialIndexItemId id,
                                           const PxBounds3& bounds)                         = 0;

    virtual void                    remove(PxSpatialIndexItemId id)                         = 0;


    virtual void                    overlap(const PxBounds3 &aabb,
                                            PxSpatialOverlapCallback& callback) const   = 0;

    virtual void                    raycast(const PxVec3& origin, 
                                            const PxVec3& unitDir, 
                                            PxReal maxDist, 
                                            PxSpatialLocationCallback& callback)    const   = 0;

    virtual void                    sweep(const PxBounds3& aabb, 
                                          const PxVec3& unitDir, 
                                          PxReal maxDist, 
                                          PxSpatialLocationCallback& callback)      const   = 0;

    virtual void                    flush()                                                 = 0;

    virtual void                    rebuildFull()                                           = 0;

    virtual void                    setIncrementalRebuildRate(PxU32 rate)                   = 0;

    virtual void                    rebuildStep()                                           = 0;

    virtual void                    release()                                               = 0;
protected:
    virtual                         ~PxSpatialIndex(){}
};

PX_PHYSX_CORE_API PxSpatialIndex* PxCreateSpatialIndex();

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif