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-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_DISTANCEJOINT_H
00032 #define PX_DISTANCEJOINT_H
00033 
00037 #include "extensions/PxJoint.h"
00038 
00039 #if !PX_DOXYGEN
00040 namespace physx
00041 {
00042 #endif
00043 
00044 class PxDistanceJoint;
00045 
00058 PxDistanceJoint*    PxDistanceJointCreate(PxPhysics& physics, 
00059                                           PxRigidActor* actor0, const PxTransform& localFrame0, 
00060                                           PxRigidActor* actor1, const PxTransform& localFrame1);
00061 
00062 
00069 struct PxDistanceJointFlag
00070 {
00071     enum Enum
00072     {
00073         eMAX_DISTANCE_ENABLED   = 1<<1,
00074         eMIN_DISTANCE_ENABLED   = 1<<2,
00075         eSPRING_ENABLED         = 1<<3
00076     };
00077 };
00078 
00079 typedef PxFlags<PxDistanceJointFlag::Enum, PxU16> PxDistanceJointFlags;
00080 PX_FLAGS_OPERATORS(PxDistanceJointFlag::Enum, PxU16)
00081 
00082 
00087 class PxDistanceJoint : public PxJoint
00088 {
00089 public:
00090 
00091 
00096     virtual PxReal                  getDistance() const                                 = 0;
00097     
00111     virtual void                    setMinDistance(PxReal distance)                     = 0;
00112 
00121     virtual PxReal                  getMinDistance()                            const   = 0;
00122 
00123 
00137     virtual void                    setMaxDistance(PxReal distance)                     = 0;
00138 
00147     virtual PxReal                  getMaxDistance()                            const   = 0;
00148 
00149 
00158     virtual void                    setTolerance(PxReal tolerance)                      = 0;
00159 
00160 
00174     virtual PxReal                  getTolerance()                              const   = 0;
00175 
00189     virtual void                    setStiffness(PxReal stiffness)                  = 0;
00190 
00199     virtual PxReal                  getStiffness()                                  const   = 0;
00200 
00201 
00215     virtual void                    setDamping(PxReal damping)                          = 0;
00216     
00217 
00226     virtual PxReal                  getDamping()                                    const   = 0;
00227 
00238     virtual void                    setDistanceJointFlags(PxDistanceJointFlags flags) = 0;
00239 
00240 
00250     virtual void                    setDistanceJointFlag(PxDistanceJointFlag::Enum flag, bool value) = 0;
00251 
00260     virtual PxDistanceJointFlags    getDistanceJointFlags(void)                 const   = 0;
00261 
00265     virtual const char*             getConcreteTypeName() const { return "PxDistanceJoint"; }
00266 
00267 protected:
00268 
00269     //serialization
00270 
00274     PX_INLINE                       PxDistanceJoint(PxType concreteType, PxBaseFlags baseFlags) : PxJoint(concreteType, baseFlags) {}
00275 
00279     PX_INLINE                       PxDistanceJoint(PxBaseFlags baseFlags)  : PxJoint(baseFlags) {}
00280 
00284     virtual bool                    isKindOf(const char* name)  const { return !::strcmp("PxDistanceJoint", name) || PxJoint::isKindOf(name);   }
00285 
00286     //~serialization
00287 };
00288 
00289 #if !PX_DOXYGEN
00290 } // namespace physx
00291 #endif
00292 
00294 #endif


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