PxControllerManager.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_CCT_MANAGER
#define PX_PHYSICS_CCT_MANAGER

#include "characterkinematic/PxCharacter.h"

#include "PxPhysXConfig.h"
#include "foundation/PxFlags.h"
#include "common/PxRenderBuffer.h"
#include "foundation/PxFoundation.h"
#include "foundation/PxErrorCallback.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxPhysics;
class PxScene;
class PxController;
class PxControllerDesc;
class PxObstacleContext;
class PxControllerFilterCallback;

struct PxControllerDebugRenderFlag
{
    enum Enum
    {
        eTEMPORAL_BV    = (1<<0),   
        eCACHED_BV      = (1<<1),   
        eOBSTACLES      = (1<<2),   

        eNONE           = 0,
        eALL            = 0xffffffff
    };
};

typedef PxFlags<PxControllerDebugRenderFlag::Enum, PxU32> PxControllerDebugRenderFlags;
PX_FLAGS_OPERATORS(PxControllerDebugRenderFlag::Enum, PxU32)



class PX_PHYSX_CHARACTER_API PxControllerManager
{
public:
    virtual void                release() = 0;

    virtual PxScene&            getScene() const = 0;

    virtual PxU32               getNbControllers() const = 0;

    virtual PxController*       getController(PxU32 index) = 0;

    virtual PxController*       createController(const PxControllerDesc& desc) = 0;

    PX_DEPRECATED virtual PxController*     createController(PxPhysics&, PxScene*, const PxControllerDesc& desc)
    {
        // The SDK & scene parameters are not needed anymore
        PxGetFoundation().getErrorCallback().reportError(PxErrorCode::eDEBUG_WARNING, "The PxControllerManager::createController prototype has changed. Please upate your code.", __FILE__, __LINE__);
        return createController(desc);
    }

    virtual void                purgeControllers() = 0;

    virtual PxRenderBuffer&     getRenderBuffer()       = 0;

    virtual void                setDebugRenderingFlags(PxControllerDebugRenderFlags flags)  = 0;

    virtual PxU32               getNbObstacleContexts() const = 0;

    virtual PxObstacleContext*  getObstacleContext(PxU32 index) = 0;

    virtual PxObstacleContext*  createObstacleContext() = 0;

    virtual void                computeInteractions(PxF32 elapsedTime, PxControllerFilterCallback* cctFilterCb=NULL) = 0;

    virtual void                setTessellation(bool flag, float maxEdgeLength) = 0;

    virtual void                setOverlapRecoveryModule(bool flag) = 0;

    virtual void                setPreciseSweeps(bool flag) = 0;

    virtual void                setPreventVerticalSlidingAgainstCeiling(bool flag) = 0;

    virtual void                shiftOrigin(const PxVec3& shift) = 0;

protected:
    PxControllerManager() {}
    virtual ~PxControllerManager() {}
};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

PX_C_EXPORT PX_PHYSX_CHARACTER_API physx::PxControllerManager* PX_CALL_CONV PxCreateControllerManager(physx::PxScene& scene, bool lockingEnabled = false);

#endif //PX_PHYSICS_CCT_MANAGER