include/characterkinematic/PxControllerManager.h

File members: include/characterkinematic/PxControllerManager.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2024 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.

#ifndef PX_CONTROLLER_MANAGER_H
#define PX_CONTROLLER_MANAGER_H

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

#if !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 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;

    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() {}
};

#if !PX_DOXYGEN
} // namespace physx
#endif

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

#endif