NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBoxController.h Source 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-2016 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 #if !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                               PxBoxControllerDesc(const PxBoxControllerDesc&);
+00063 
+00067     PX_INLINE PxBoxControllerDesc&          operator=(const PxBoxControllerDesc&);
+00068 
+00072     PX_INLINE virtual   void                setToDefault();
+00073 
+00079     PX_INLINE virtual   bool                isValid()       const;
+00080 
+00086     PxF32               halfHeight;         // Half-height in the "up" direction
+00087 
+00093     PxF32               halfSideExtent;     // Half-extent in the "side" direction
+00094 
+00100     PxF32               halfForwardExtent;  // Half-extent in the "forward" direction
+00101 
+00102 protected:
+00103     PX_INLINE void copy(const PxBoxControllerDesc&);
+00104 };
+00105 
+00106 PX_INLINE PxBoxControllerDesc::PxBoxControllerDesc() :
+00107     PxControllerDesc    (PxControllerShapeType::eBOX),
+00108     halfHeight          (1.0f),
+00109     halfSideExtent      (0.5f),
+00110     halfForwardExtent   (0.5f)
+00111 {
+00112 }
+00113 
+00114 PX_INLINE PxBoxControllerDesc::PxBoxControllerDesc(const PxBoxControllerDesc& other) : PxControllerDesc(other)
+00115 {
+00116     copy(other);
+00117 }
+00118 
+00119 PX_INLINE PxBoxControllerDesc& PxBoxControllerDesc::operator=(const PxBoxControllerDesc& other)
+00120 {
+00121     PxControllerDesc::operator=(other);
+00122     copy(other);
+00123     return *this;
+00124 }
+00125 
+00126 PX_INLINE void PxBoxControllerDesc::copy(const PxBoxControllerDesc& other)
+00127 {
+00128     halfHeight          = other.halfHeight;
+00129     halfSideExtent      = other.halfSideExtent;
+00130     halfForwardExtent   = other.halfForwardExtent;
+00131 }
+00132 
+00133 PX_INLINE void PxBoxControllerDesc::setToDefault()
+00134 {
+00135     *this = PxBoxControllerDesc();
+00136 }
+00137 
+00138 PX_INLINE bool PxBoxControllerDesc::isValid() const
+00139 {
+00140     if(!PxControllerDesc::isValid())    return false;
+00141     if(halfHeight<=0.0f)                return false;
+00142     if(halfSideExtent<=0.0f)            return false;
+00143     if(halfForwardExtent<=0.0f)         return false;
+00144     if(stepOffset>2.0f*halfHeight)      return false;   // Prevents obvious mistakes
+00145     return true;
+00146 }
+00147 
+00153 class PxBoxController : public PxController
+00154 {
+00155 public:
+00156 
+00164     virtual     PxF32           getHalfHeight()         const   = 0;
+00165 
+00173     virtual     PxF32           getHalfSideExtent()     const   = 0;
+00174 
+00182     virtual     PxF32           getHalfForwardExtent()  const   = 0;
+00183 
+00194     virtual     bool            setHalfHeight(PxF32 halfHeight)                 = 0;
+00195 
+00206     virtual     bool            setHalfSideExtent(PxF32 halfSideExtent)         = 0;
+00207 
+00218     virtual     bool            setHalfForwardExtent(PxF32 halfForwardExtent)   = 0;
+00219 
+00220 protected:
+00221     PX_INLINE                   PxBoxController()   {}
+00222     virtual                     ~PxBoxController()  {}
+00223 };
+00224 
+00225 #if !PX_DOXYGEN
+00226 } // namespace physx
+00227 #endif
+00228 
+00230 #endif
+