PxControllerObstacles.h

↰ Return to documentation for include/characterkinematic/PxControllerObstacles.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-2022 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_OBSTACLES_H
#define PX_CONTROLLER_OBSTACLES_H

#include "characterkinematic/PxExtended.h"
#include "geometry/PxGeometry.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

    class PxControllerManager;

    #define PX_INVALID_OBSTACLE_HANDLE  0xffffffff

    class PxObstacle
    {
        protected:
                                                PxObstacle() :
                                                    mType       (PxGeometryType::eINVALID),
                                                    mUserData   (NULL),
                                                    mPos        (0.0, 0.0, 0.0),
                                                    mRot        (PxQuat(PxIdentity))
                                                {}

                        PxGeometryType::Enum    mType;
        public:

        PX_FORCE_INLINE PxGeometryType::Enum    getType()   const   { return mType; }

                        void*                   mUserData;
                        PxExtendedVec3          mPos;
                        PxQuat                  mRot;
    };

    class PxBoxObstacle : public PxObstacle
    {
        public:
                                                PxBoxObstacle() :
                                                    mHalfExtents(0.0f)
                                                { mType = PxGeometryType::eBOX;      }

                        PxVec3                  mHalfExtents;
    };

    class PxCapsuleObstacle : public PxObstacle
    {
        public:
                                                PxCapsuleObstacle() :
                                                    mHalfHeight (0.0f),
                                                    mRadius     (0.0f)
                                                { mType = PxGeometryType::eCAPSULE;  }

                        PxReal                  mHalfHeight;
                        PxReal                  mRadius;
    };

    typedef PxU32   PxObstacleHandle;

    class PxObstacleContext
    {
        public:
                                    PxObstacleContext()     {}
        virtual                     ~PxObstacleContext()    {}

        virtual void                release()                                                           = 0;

        virtual PxControllerManager&    getControllerManager() const                                    = 0;

        virtual PxObstacleHandle    addObstacle(const PxObstacle& obstacle)                             = 0;

        virtual bool                removeObstacle(PxObstacleHandle handle)                             = 0;

        virtual bool                updateObstacle(PxObstacleHandle handle, const PxObstacle& obstacle) = 0;

        virtual PxU32               getNbObstacles()                                            const   = 0;

        virtual const PxObstacle*   getObstacle(PxU32 i)                                        const   = 0;

        virtual const PxObstacle*   getObstacleByHandle(PxObstacleHandle handle)                const   = 0;
    };

#if !PX_DOXYGEN
}
#endif

#endif