PxBoxController.h

Go to the documentation of this file.

//
// 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-2021 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_PHYSICS_CCT_BOX_CONTROLLER
#define PX_PHYSICS_CCT_BOX_CONTROLLER

#include "characterkinematic/PxController.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

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

    PX_INLINE                               PxBoxControllerDesc(const PxBoxControllerDesc&);

    PX_INLINE PxBoxControllerDesc&          operator=(const PxBoxControllerDesc&);

    PX_INLINE virtual   void                setToDefault();

    PX_INLINE virtual   bool                isValid()       const;

    PxF32               halfHeight;         // Half-height in the "up" direction

    PxF32               halfSideExtent;     // Half-extent in the "side" direction

    PxF32               halfForwardExtent;  // Half-extent in the "forward" direction

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

PX_INLINE PxBoxControllerDesc::PxBoxControllerDesc() :
    PxControllerDesc    (PxControllerShapeType::eBOX),
    halfHeight          (1.0f),
    halfSideExtent      (0.5f),
    halfForwardExtent   (0.5f)
{
}

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

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

PX_INLINE void PxBoxControllerDesc::copy(const PxBoxControllerDesc& other)
{
    halfHeight          = other.halfHeight;
    halfSideExtent      = other.halfSideExtent;
    halfForwardExtent   = other.halfForwardExtent;
}

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

PX_INLINE bool PxBoxControllerDesc::isValid() const
{
    if(!PxControllerDesc::isValid())    return false;
    if(halfHeight<=0.0f)                return false;
    if(halfSideExtent<=0.0f)            return false;
    if(halfForwardExtent<=0.0f)         return false;
    if(stepOffset>2.0f*halfHeight)      return false;   // Prevents obvious mistakes
    return true;
}

class PxBoxController : public PxController
{
public:

    virtual     PxF32           getHalfHeight()         const   = 0;

    virtual     PxF32           getHalfSideExtent()     const   = 0;

    virtual     PxF32           getHalfForwardExtent()  const   = 0;

    virtual     bool            setHalfHeight(PxF32 halfHeight)                 = 0;

    virtual     bool            setHalfSideExtent(PxF32 halfSideExtent)         = 0;

    virtual     bool            setHalfForwardExtent(PxF32 halfForwardExtent)   = 0;

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

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif