PhysX SDK 3.2 API Reference: PxPrismaticJoint.h Source File

PhysX SDK 3.2 API

PxPrismaticJoint.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_PRISMATICJOINT_H
00032 #define PX_PRISMATICJOINT_H
00033 
00037 #include "extensions/PxJoint.h"
00038 #include "extensions/PxJointLimit.h"
00039 
00040 #ifndef PX_DOXYGEN
00041 namespace physx
00042 {
00043 #endif
00044 
00045 class PxPrismaticJoint;
00046 
00059 PxPrismaticJoint*   PxPrismaticJointCreate(PxPhysics& physics, 
00060                                            PxRigidActor* actor0, const PxTransform& localFrame0, 
00061                                            PxRigidActor* actor1, const PxTransform& localFrame1);
00062 
00063 
00070 struct PxPrismaticJointFlag
00071 {
00072     enum Enum
00073     {
00074         eLIMIT_ENABLED  = 1<<1,
00075     };
00076 };
00077 
00078 typedef PxFlags<PxPrismaticJointFlag::Enum, PxU16> PxPrismaticJointFlags;
00079 PX_FLAGS_OPERATORS(PxPrismaticJointFlag::Enum, PxU16);
00080 
00081 
00094 class PxPrismaticJoint: public PxJoint
00095 {
00096 public:
00097     static const PxJointType::Enum Type = PxJointType::ePRISMATIC;
00098 
00099 
00105     virtual void            setLimit(const PxJointLimitPair&)           = 0;
00106 
00112     virtual PxJointLimitPair getLimit()                 const           = 0;
00113 
00114 
00125     virtual void                    setPrismaticJointFlags(PxPrismaticJointFlags flags) = 0;
00126 
00136     virtual void                    setPrismaticJointFlag(PxPrismaticJointFlag::Enum flag, bool value) = 0;
00137 
00146     virtual PxPrismaticJointFlags   getPrismaticJointFlags(void)                    const   = 0;
00147 
00167     virtual void            setProjectionLinearTolerance(PxReal tolerance)                  = 0;
00168 
00177     virtual PxReal          getProjectionLinearTolerance()          const                   = 0;
00178 
00198     virtual void            setProjectionAngularTolerance(PxReal tolerance)                 = 0;
00199 
00205     virtual PxReal          getProjectionAngularTolerance()         const                   = 0;
00206 
00207 
00208     virtual const char*     getConcreteTypeName() const             {   return "PxPrismaticJoint"; }
00209 
00210 protected:
00211     PxPrismaticJoint(PxRefResolver& v)  : PxJoint(v)    {}
00212     PxPrismaticJoint()                                  {}
00213     virtual bool            isKindOf(const char* name)  const       {   return !strcmp("PxPrismaticJoint", name) || PxJoint::isKindOf(name); }
00214 };
00215 
00216 #ifndef PX_DOXYGEN
00217 } // namespace physx
00218 #endif
00219 
00221 #endif


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