PxVolumeCache.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_NX_VOLUMECACHE
#define PX_PHYSICS_NX_VOLUMECACHE

#include "PxScene.h"
#include "geometry/PxGeometryHelpers.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxVolumeCache
{
public:
    struct Iterator
    {
        virtual void processShapes(PxU32 count, const PxActorShape* actorShapePairs) = 0;

        virtual void finalizeQuery() {}
    protected:
        virtual ~Iterator() {}
    };


    enum FillStatus
    {
        FILL_OK,

        FILL_OVER_MAX_COUNT,

        FILL_UNSUPPORTED_GEOMETRY_TYPE,

        FILL_OUT_OF_MEMORY
    };

    virtual FillStatus fill(const PxGeometry& cacheVolume, const PxTransform& pose) = 0;
    
    virtual bool isValid() const = 0;

    virtual void invalidate() = 0;

    virtual bool getCacheVolume(PxGeometryHolder& resultVolume, PxTransform& resultPose) = 0;

    virtual PxI32 getNbCachedShapes() = 0;

    virtual void release() = 0;

    virtual void forEach(Iterator& iter) = 0; 

    virtual void setMaxNbStaticShapes(PxU32 maxCount) = 0;

    virtual void setMaxNbDynamicShapes(PxU32 maxCount) = 0;

    virtual PxU32 getMaxNbStaticShapes() = 0;

    virtual PxU32 getMaxNbDynamicShapes() = 0;

    virtual bool raycast(
        const PxVec3& origin, const PxVec3& unitDir, const PxReal distance,
        PxRaycastCallback& hitCall, PxHitFlags hitFlags = PxHitFlags(PxHitFlag::eDEFAULT),
        const PxQueryFilterData& filterData = PxQueryFilterData(), PxQueryFilterCallback* filterCall = NULL) const = 0;

    virtual bool sweep(
        const PxGeometry& geometry, const PxTransform& pose, const PxVec3& unitDir, const PxReal distance,
        PxSweepCallback& hitCall, PxHitFlags hitFlags = PxHitFlags(PxHitFlag::ePOSITION | PxHitFlag::eNORMAL | PxHitFlag::eDISTANCE),
        const PxQueryFilterData& filterData = PxQueryFilterData(), PxQueryFilterCallback* filterCall = NULL,
        const PxReal inflation = 0.f) const = 0;


    virtual bool overlap(
        const PxGeometry& geometry, const PxTransform& pose, PxOverlapCallback& hitCall,
        const PxQueryFilterData& filterData = PxQueryFilterData(), PxQueryFilterCallback* filterCall = NULL) const = 0;

protected:
    virtual ~PxVolumeCache() {}
}; // class PxVolumeCache

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif