NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxRevoluteJoint.h Source File

NVIDIA PhysX API

PxRevoluteJoint.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-2017 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_REVOLUTEJOINT_H
00032 #define PX_REVOLUTEJOINT_H
00033 
00037 #include "extensions/PxJoint.h"
00038 #include "extensions/PxJointLimit.h"
00039 
00040 #if !PX_DOXYGEN
00041 namespace physx
00042 {
00043 #endif
00044 
00045 class PxRevoluteJoint;
00046 
00059 PxRevoluteJoint*    PxRevoluteJointCreate(PxPhysics& physics, 
00060                                           PxRigidActor* actor0, const PxTransform& localFrame0, 
00061                                           PxRigidActor* actor1, const PxTransform& localFrame1);
00062 
00063 
00070 struct PxRevoluteJointFlag
00071 {
00072     enum Enum
00073     {
00074         eLIMIT_ENABLED          = 1<<0,     
00075         eDRIVE_ENABLED          = 1<<1,     
00076         eDRIVE_FREESPIN         = 1<<2      
00077     };
00078 };
00079 
00080 typedef PxFlags<PxRevoluteJointFlag::Enum, PxU16> PxRevoluteJointFlags;
00081 PX_FLAGS_OPERATORS(PxRevoluteJointFlag::Enum, PxU16)
00082 
00083 
00084 
00107 class PxRevoluteJoint : public PxJoint
00108 {
00109 public:
00110 
00114     virtual PxReal getAngle()                           const           = 0;
00115 
00116 
00120     virtual PxReal getVelocity()                        const           = 0;
00121 
00135     virtual void            setLimit(const PxJointAngularLimitPair& limits)         = 0;
00136 
00144     virtual PxJointAngularLimitPair getLimit()          const           = 0;
00145 
00146 
00147 
00167     virtual void            setDriveVelocity(PxReal velocity)           = 0;
00168 
00176     virtual PxReal          getDriveVelocity()          const           = 0;
00177 
00178 
00191     virtual void            setDriveForceLimit(PxReal limit)            = 0;
00192 
00200     virtual PxReal          getDriveForceLimit()        const           = 0;
00201 
00202 
00216     virtual void            setDriveGearRatio(PxReal ratio)         = 0;
00217 
00225     virtual PxReal          getDriveGearRatio()     const           = 0;
00226 
00227 
00238     virtual void                    setRevoluteJointFlags(PxRevoluteJointFlags flags) = 0;
00239 
00249     virtual void                    setRevoluteJointFlag(PxRevoluteJointFlag::Enum flag, bool value) = 0;
00250 
00259     virtual PxRevoluteJointFlags    getRevoluteJointFlags(void)                 const   = 0;
00260 
00280     virtual void                setProjectionLinearTolerance(PxReal tolerance)                  = 0;
00281 
00282 
00291     virtual PxReal              getProjectionLinearTolerance()          const                   = 0;
00292 
00312     virtual void                setProjectionAngularTolerance(PxReal tolerance)                 = 0;
00313 
00322     virtual PxReal              getProjectionAngularTolerance()         const                   = 0;
00323 
00327     virtual const char*         getConcreteTypeName() const { return "PxRevoluteJoint"; }
00328 
00329 protected:
00330 
00331     //serialization
00332 
00336     PX_INLINE                   PxRevoluteJoint(PxType concreteType, PxBaseFlags baseFlags) : PxJoint(concreteType, baseFlags) {}
00337 
00341     PX_INLINE                   PxRevoluteJoint(PxBaseFlags baseFlags) : PxJoint(baseFlags) {}
00342 
00346     virtual bool                isKindOf(const char* name) const { return !::strcmp("PxRevoluteJoint", name) || PxJoint::isKindOf(name); }
00347     
00348     //~serialization
00349 };
00350 
00351 #if !PX_DOXYGEN
00352 } // namespace physx
00353 #endif
00354 
00356 #endif


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