PhysX SDK 3.2 API Reference: PxBoxController.h Source File

PhysX SDK 3.2 API

PxBoxController.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_BOX_CONTROLLER
00032 #define PX_PHYSICS_CCT_BOX_CONTROLLER
00033 
00037 #include "characterkinematic/PxCharacter.h"
00038 #include "characterkinematic/PxController.h"
00039 
00040 #ifndef PX_DOXYGEN
00041 namespace physx
00042 {
00043 #endif
00044 
00050 class PxBoxControllerDesc : public PxControllerDesc
00051 {
00052 public:
00056     PX_INLINE                               PxBoxControllerDesc();
00057     PX_INLINE virtual                       ~PxBoxControllerDesc();
00058 
00062     PX_INLINE virtual   void                setToDefault();
00063 
00069     PX_INLINE virtual   bool                isValid()       const;
00070 
00076     PxF32               halfHeight;         // Half-height in the "up" direction
00077 
00083     PxF32               halfSideExtent;     // Half-extent in the "side" direction
00084 
00090     PxF32               halfForwardExtent;  // Half-extent in the "forward" direction
00091 };
00092 
00093 PX_INLINE PxBoxControllerDesc::PxBoxControllerDesc() :
00094     PxControllerDesc    (PxControllerShapeType::eBOX),
00095     halfHeight          (1.0f),
00096     halfSideExtent      (0.5f),
00097     halfForwardExtent   (0.5f)
00098 {
00099 }
00100 
00101 PX_INLINE PxBoxControllerDesc::~PxBoxControllerDesc()
00102 {
00103 }
00104 
00105 PX_INLINE void PxBoxControllerDesc::setToDefault()
00106 {
00107     *this = PxBoxControllerDesc();
00108 }
00109 
00110 PX_INLINE bool PxBoxControllerDesc::isValid() const
00111 {
00112     if(!PxControllerDesc::isValid())    return false;
00113     if(halfHeight<=0.0f)                return false;
00114     if(halfSideExtent<=0.0f)            return false;
00115     if(halfForwardExtent<=0.0f)         return false;
00116     if(stepOffset>2.0f*halfHeight)      return false;   // Prevents obvious mistakes
00117     return true;
00118 }
00119 
00125 class PxBoxController : public PxController
00126 {
00127 protected:
00128     PX_INLINE                   PxBoxController()   {}
00129     virtual                     ~PxBoxController()  {}
00130 
00131 public:
00132 
00140     virtual     PxF32           getHalfHeight()         const   = 0;
00141 
00149     virtual     PxF32           getHalfSideExtent()     const   = 0;
00150 
00158     virtual     PxF32           getHalfForwardExtent()  const   = 0;
00159 
00170     virtual     bool            setHalfHeight(PxF32 halfHeight)                 = 0;
00171 
00182     virtual     bool            setHalfSideExtent(PxF32 halfSideExtent)         = 0;
00183 
00194     virtual     bool            setHalfForwardExtent(PxF32 halfForwardExtent)   = 0;
00195 };
00196 
00197 #ifndef PX_DOXYGEN
00198 } // namespace physx
00199 #endif
00200 
00202 #endif


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