PhysX SDK 3.2 API Reference: PxCapsuleController.h Source File

PhysX SDK 3.2 API

PxCapsuleController.h

Go to the documentation of this file.
00001 // This code contains NVIDIA Confidential Information and is disclosed to you 
00002 // under a form of NVIDIA software license agreement provided separately to you.
00003 //
00004 // Notice
00005 // NVIDIA Corporation and its licensors retain all intellectual property and
00006 // proprietary rights in and to this software and related documentation and 
00007 // any modifications thereto. Any use, reproduction, disclosure, or 
00008 // distribution of this software and related documentation without an express 
00009 // license agreement from NVIDIA Corporation is strictly prohibited.
00010 // 
00011 // ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
00012 // NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
00013 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
00014 // MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
00015 //
00016 // Information and code furnished is believed to be accurate and reliable.
00017 // However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
00018 // information or for any infringement of patents or other rights of third parties that may
00019 // result from its use. No license is granted by implication or otherwise under any patent
00020 // or patent rights of NVIDIA Corporation. Details are subject to change without notice.
00021 // This code supersedes and replaces all information previously supplied.
00022 // NVIDIA Corporation products are not authorized for use as critical
00023 // components in life support devices or systems without express written approval of
00024 // NVIDIA Corporation.
00025 //
00026 // Copyright (c) 2008-2012 NVIDIA Corporation. All rights reserved.
00027 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
00028 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  
00029 
00030 
00031 #ifndef PX_PHYSICS_CCT_CAPSULE_CONTROLLER
00032 #define PX_PHYSICS_CCT_CAPSULE_CONTROLLER
00033 
00037 #include "characterkinematic/PxCharacter.h"
00038 #include "characterkinematic/PxController.h"
00039 
00040 #ifndef PX_DOXYGEN
00041 namespace physx
00042 {
00043 #endif
00044 
00045 struct PxCapsuleClimbingMode
00046 {
00047     enum Enum
00048     {
00049         eEASY,          
00050         eCONSTRAINED,   
00051 
00052         eLAST
00053     };
00054 };
00055 
00061 class PxCapsuleControllerDesc : public PxControllerDesc
00062 {
00063 public:
00067     PX_INLINE                               PxCapsuleControllerDesc ();
00068     PX_INLINE virtual                       ~PxCapsuleControllerDesc ();
00069 
00073     PX_INLINE virtual   void                setToDefault();
00079     PX_INLINE virtual   bool                isValid()       const;
00080 
00088     PxF32               radius;
00089 
00097     PxF32               height;
00098 
00106     PxCapsuleClimbingMode::Enum     climbingMode;
00107 };
00108 
00109 PX_INLINE PxCapsuleControllerDesc::PxCapsuleControllerDesc () : PxControllerDesc(PxControllerShapeType::eCAPSULE)
00110 {
00111     radius = height = 0.0f;
00112     climbingMode = PxCapsuleClimbingMode::eEASY;
00113 }
00114 
00115 PX_INLINE PxCapsuleControllerDesc::~PxCapsuleControllerDesc()
00116 {
00117 }
00118 
00119 PX_INLINE void PxCapsuleControllerDesc::setToDefault()
00120 {
00121     *this = PxCapsuleControllerDesc();
00122 }
00123 
00124 PX_INLINE bool PxCapsuleControllerDesc::isValid() const
00125 {
00126     if(!PxControllerDesc::isValid())    return false;
00127     if(radius<=0.0f)                    return false;
00128     if(height<=0.0f)                    return false;
00129     if(stepOffset>height+radius*2.0f)   return false;   // Prevents obvious mistakes
00130     return true;
00131 }
00149 class PxCapsuleController : public PxController
00150 {
00151 protected:
00152     PX_INLINE                   PxCapsuleController()   {}
00153     virtual                     ~PxCapsuleController()  {}
00154 
00155 public:
00156 
00164     virtual     PxF32           getRadius() const = 0;
00165 
00176     virtual     bool            setRadius(PxF32 radius) = 0;
00177 
00185     virtual     PxF32           getHeight() const = 0;
00186 
00197     virtual     bool            setHeight(PxF32 height) = 0;
00198 
00206     virtual     PxCapsuleClimbingMode::Enum     getClimbingMode()   const   = 0;
00207 
00215     virtual     bool            setClimbingMode(PxCapsuleClimbingMode::Enum mode)   = 0;
00216 };
00217 
00218 #ifndef PX_DOXYGEN
00219 } // namespace physx
00220 #endif
00221 
00223 #endif


Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com