PxDistanceJoint.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-2018 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 #ifndef PX_DISTANCEJOINT_H
00031 #define PX_DISTANCEJOINT_H
00032 
00036 #include "extensions/PxJoint.h"
00037 
00038 #if !PX_DOXYGEN
00039 namespace physx
00040 {
00041 #endif
00042 
00043 class PxDistanceJoint;
00044 
00056 PxDistanceJoint*    PxDistanceJointCreate(PxPhysics& physics, PxRigidActor* actor0, const PxTransform& localFrame0, PxRigidActor* actor1, const PxTransform& localFrame1);
00057 
00058 
00064 struct PxDistanceJointFlag
00065 {
00066     enum Enum
00067     {
00068         eMAX_DISTANCE_ENABLED   = 1<<1,
00069         eMIN_DISTANCE_ENABLED   = 1<<2,
00070         eSPRING_ENABLED         = 1<<3
00071     };
00072 };
00073 
00074 typedef PxFlags<PxDistanceJointFlag::Enum, PxU16> PxDistanceJointFlags;
00075 PX_FLAGS_OPERATORS(PxDistanceJointFlag::Enum, PxU16)
00076 
00077 
00082 class PxDistanceJoint : public PxJoint
00083 {
00084 public:
00085 
00089     virtual PxReal                  getDistance()   const   = 0;
00090     
00103     virtual void                    setMinDistance(PxReal distance) = 0;
00104 
00112     virtual PxReal                  getMinDistance()    const   = 0;
00113 
00126     virtual void                    setMaxDistance(PxReal distance) = 0;
00127 
00135     virtual PxReal                  getMaxDistance()    const   = 0;
00136 
00144     virtual void                    setTolerance(PxReal tolerance)  = 0;
00145 
00159     virtual PxReal                  getTolerance()  const   = 0;
00160 
00173     virtual void                    setStiffness(PxReal stiffness)  = 0;
00174 
00182     virtual PxReal                  getStiffness()  const   = 0;
00183 
00196     virtual void                    setDamping(PxReal damping)  = 0;
00197     
00205     virtual PxReal                  getDamping()    const   = 0;
00206 
00216     virtual void                    setDistanceJointFlags(PxDistanceJointFlags flags) = 0;
00217 
00226     virtual void                    setDistanceJointFlag(PxDistanceJointFlag::Enum flag, bool value) = 0;
00227 
00235     virtual PxDistanceJointFlags    getDistanceJointFlags() const   = 0;
00236 
00240     virtual const char*             getConcreteTypeName() const { return "PxDistanceJoint"; }
00241 
00242 protected:
00243 
00244     //serialization
00245 
00249     PX_INLINE                       PxDistanceJoint(PxType concreteType, PxBaseFlags baseFlags) : PxJoint(concreteType, baseFlags) {}
00250 
00254     PX_INLINE                       PxDistanceJoint(PxBaseFlags baseFlags)  : PxJoint(baseFlags) {}
00255 
00259     virtual bool                    isKindOf(const char* name)  const { return !::strcmp("PxDistanceJoint", name) || PxJoint::isKindOf(name);   }
00260 
00261     //~serialization
00262 };
00263 
00264 #if !PX_DOXYGEN
00265 } // namespace physx
00266 #endif
00267 
00269 #endif


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