PhysX SDK 3.2 API Reference: PxCapsuleGeometry.h Source File

PhysX SDK 3.2 API

PxCapsuleGeometry.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_NX_CAPSULE_GEOMETRY
00032 #define PX_PHYSICS_NX_CAPSULE_GEOMETRY
00033 
00036 #include "geometry/PxGeometry.h"
00037 
00038 #ifndef PX_DOXYGEN
00039 namespace physx
00040 {
00041 #endif
00042 
00050 class PxCapsuleGeometry : public PxGeometry      
00051 {
00052 public:
00056     PX_INLINE PxCapsuleGeometry() :                     PxGeometry(PxGeometryType::eCAPSULE), radius(0), halfHeight(0)      {}
00057 
00061     PX_INLINE PxCapsuleGeometry(PxReal radius_, PxReal halfHeight_) :   PxGeometry(PxGeometryType::eCAPSULE), radius(radius_), halfHeight(halfHeight_)  {}
00062 
00068     PX_INLINE bool isValid() const;
00069 
00070 public:
00074     PxReal radius;
00079     PxReal halfHeight;
00080 };
00081 
00082 
00083 PX_INLINE bool PxCapsuleGeometry::isValid() const
00084 {
00085     if (mType != PxGeometryType::eCAPSULE)
00086         return false;
00087     if (!PxIsFinite(radius) || !PxIsFinite(halfHeight))
00088         return false;
00089     if (radius <= 0.0f || halfHeight <= 0.0f)
00090         return false;
00091 
00092     return true;
00093 }
00094 
00095 
00096 /* \brief creates a transform from the endpoints of a segment, suitable for an actor transform for a PxCapsuleGeometry
00097 
00098 \param[in] p0 one end of major axis of the capsule
00099 \param[in] p1 the other end of the axis of the capsule
00100 \param[out] halfHeight the halfHeight of the capsule. This parameter is optional.
00101 \return A PxTransform which will transform the vector (1,0,0) to the capsule axis shrunk by the halfHeight
00102 */
00103 
00104 PX_FOUNDATION_API PxTransform PxTransformFromSegment(const PxVec3& p0, const PxVec3& p1, PxReal* halfHeight = NULL);
00105 
00106 
00107 #ifndef PX_DOXYGEN
00108 } // namespace physx
00109 #endif
00110 
00112 #endif


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