PxPrismaticJoint Class Reference
[Extensions]
A prismatic joint permits relative translational movement between two bodies along an axis, but no relative rotational movement.
More...
#include <PxPrismaticJoint.h>
Public Member Functions | |
| virtual void | setLimit (const PxJointLimitPair &)=0 |
| sets the joint upper limit parameters. | |
| virtual PxJointLimitPair | getLimit () const =0 |
| gets the joint upper limit parameters. | |
| virtual void | setPrismaticJointFlags (PxPrismaticJointFlags flags)=0 |
| Set the flags specific to the Prismatic Joint. | |
| virtual void | setPrismaticJointFlag (PxPrismaticJointFlag::Enum flag, bool value)=0 |
| Set a single flag specific to a Prismatic Joint to true or false. | |
| virtual PxPrismaticJointFlags | getPrismaticJointFlags (void) const =0 |
| Get the flags specific to the Prismatic Joint. | |
| virtual void | setProjectionLinearTolerance (PxReal tolerance)=0 |
| Set the linear tolerance threshold for projection. | |
| virtual PxReal | getProjectionLinearTolerance () const =0 |
| Get the linear tolerance threshold for projection. | |
| virtual void | setProjectionAngularTolerance (PxReal tolerance)=0 |
| Set the angular tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJECTION is set for the joint. | |
| virtual PxReal | getProjectionAngularTolerance () const =0 |
| Get the angular tolerance threshold for projection. | |
| virtual const char * | getConcreteTypeName () const |
| returns string name of dynamic type. | |
Static Public Attributes | |
| static const PxJointType::Enum | Type = PxJointType::ePRISMATIC |
Protected Member Functions | |
| PxPrismaticJoint (PxRefResolver &v) | |
| PxPrismaticJoint () | |
| virtual bool | isKindOf (const char *name) const |
Detailed Description
A prismatic joint permits relative translational movement between two bodies along an axis, but no relative rotational movement.the axis on each body is defined as the line containing the origin of the joint frame and extending along the x-axis of that frame
- See also:
- PxPrismaticJointCreate() PxJoint
Constructor & Destructor Documentation
| PxPrismaticJoint::PxPrismaticJoint | ( | PxRefResolver & | v | ) | [inline, protected] |
| PxPrismaticJoint::PxPrismaticJoint | ( | ) | [inline, protected] |
Member Function Documentation
| virtual const char* PxPrismaticJoint::getConcreteTypeName | ( | ) | const [inline, virtual] |
returns string name of dynamic type.
- Returns:
- class name of most derived type of this object.
Reimplemented from PxSerializable.
| virtual PxJointLimitPair PxPrismaticJoint::getLimit | ( | ) | const [pure virtual] |
| virtual PxPrismaticJointFlags PxPrismaticJoint::getPrismaticJointFlags | ( | void | ) | const [pure virtual] |
Get the flags specific to the Prismatic Joint.
- Returns:
- the joint flags
- See also:
- PxPrismaticJoint::flags, PxPrismaticJointFlag setFlag() setFlags()
| virtual PxReal PxPrismaticJoint::getProjectionAngularTolerance | ( | ) | const [pure virtual] |
| virtual PxReal PxPrismaticJoint::getProjectionLinearTolerance | ( | ) | const [pure virtual] |
Get the linear tolerance threshold for projection.
- Returns:
- the linear tolerance threshold in radians
- See also:
- setProjectionLinearTolerance()
| virtual bool PxPrismaticJoint::isKindOf | ( | const char * | name | ) | const [inline, protected, virtual] |
| virtual void PxPrismaticJoint::setLimit | ( | const PxJointLimitPair & | ) | [pure virtual] |
| virtual void PxPrismaticJoint::setPrismaticJointFlag | ( | PxPrismaticJointFlag::Enum | flag, | |
| bool | value | |||
| ) | [pure virtual] |
Set a single flag specific to a Prismatic Joint to true or false.
- Parameters:
-
[in] flag The flag to set or clear. [in] value the value to which to set the flag
- See also:
- PxPrismaticJointFlag, getFlags() setFlags()
| virtual void PxPrismaticJoint::setPrismaticJointFlags | ( | PxPrismaticJointFlags | flags | ) | [pure virtual] |
Set the flags specific to the Prismatic Joint.
Default PxPrismaticJointFlags(0)
- Parameters:
-
[in] flags The joint flags.
- See also:
- PxPrismaticJointFlag setFlag() getFlags()
| virtual void PxPrismaticJoint::setProjectionAngularTolerance | ( | PxReal | tolerance | ) | [pure virtual] |
Set the angular tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJECTION is set for the joint.
If the joint separates by more than this distance along its locked degrees of freedom, the solver will move the bodies to close the distance.
Setting a very small tolerance may result in simulation jitter or other artifacts.
Sometimes it is not possible to project (for example when the joints form a cycle).
Range: [0,inf)
Default: 1e10f
- Parameters:
-
[in] tolerance the linear tolerance threshold
| virtual void PxPrismaticJoint::setProjectionLinearTolerance | ( | PxReal | tolerance | ) | [pure virtual] |
Set the linear tolerance threshold for projection.
If the joint separates by more than this distance along its locked degrees of freedom, the solver will move the bodies to close the distance.
Setting a very small tolerance may result in simulation jitter or other artifacts.
Sometimes it is not possible to project (for example when the joints form a cycle).
This value must be nonnegative.
Range: [0,inf)
Default: 1e10f
- Parameters:
-
[in] tolerance the linear tolerance threshold
- See also:
- getProjectionLinearTolerance()
Member Data Documentation
const PxJointType::Enum PxPrismaticJoint::Type = PxJointType::ePRISMATIC [static] |
The documentation for this class was generated from the following file:
Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com