include/characterkinematic/PxCapsuleController.h

File members: include/characterkinematic/PxCapsuleController.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_CAPSULE_CONTROLLER_H
#define PX_CAPSULE_CONTROLLER_H

#include "characterkinematic/PxController.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

struct PxCapsuleClimbingMode
{
    enum Enum
    {
        eEASY,
        eCONSTRAINED,

        eLAST
    };
};

class PxCapsuleControllerDesc : public PxControllerDesc
{
public:
    PX_INLINE                                   PxCapsuleControllerDesc ();
    PX_INLINE virtual                           ~PxCapsuleControllerDesc () {}

    PX_INLINE                                   PxCapsuleControllerDesc(const PxCapsuleControllerDesc&);

    PX_INLINE PxCapsuleControllerDesc&          operator=(const PxCapsuleControllerDesc&);

    PX_INLINE virtual   void                setToDefault();
    PX_INLINE virtual   bool                isValid()       const;

    PxF32               radius;

    PxF32               height;

    PxCapsuleClimbingMode::Enum     climbingMode;

protected:
    PX_INLINE void                              copy(const PxCapsuleControllerDesc&);
};

PX_INLINE PxCapsuleControllerDesc::PxCapsuleControllerDesc () : PxControllerDesc(PxControllerShapeType::eCAPSULE)
{
    radius = height = 0.0f;
    climbingMode = PxCapsuleClimbingMode::eEASY;
}

PX_INLINE PxCapsuleControllerDesc::PxCapsuleControllerDesc(const PxCapsuleControllerDesc& other) : PxControllerDesc(other)
{
    copy(other);
}

PX_INLINE PxCapsuleControllerDesc& PxCapsuleControllerDesc::operator=(const PxCapsuleControllerDesc& other)
{
    PxControllerDesc::operator=(other);
    copy(other);
    return *this;
}

PX_INLINE void PxCapsuleControllerDesc::copy(const PxCapsuleControllerDesc& other)
{
    radius          = other.radius;
    height          = other.height;
    climbingMode    = other.climbingMode;
}

PX_INLINE void PxCapsuleControllerDesc::setToDefault()
{
    *this = PxCapsuleControllerDesc();
}

PX_INLINE bool PxCapsuleControllerDesc::isValid() const
{
    if(!PxControllerDesc::isValid())    return false;
    if(radius<=0.0f)                    return false;
    if(height<=0.0f)                    return false;
    if(stepOffset>height+radius*2.0f)   return false;   // Prevents obvious mistakes
    return true;
}
class PxCapsuleController : public PxController
{
public:

    virtual     PxF32           getRadius() const = 0;

    virtual     bool            setRadius(PxF32 radius) = 0;

    virtual     PxF32           getHeight() const = 0;

    virtual     bool            setHeight(PxF32 height) = 0;

    virtual     PxCapsuleClimbingMode::Enum     getClimbingMode()   const   = 0;

    virtual     bool            setClimbingMode(PxCapsuleClimbingMode::Enum mode)   = 0;

protected:
    PX_INLINE                   PxCapsuleController()   {}
    virtual                     ~PxCapsuleController()  {}
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif