NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPrismaticJoint Class Reference

NVIDIA PhysX API

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>

Inheritance diagram for PxPrismaticJoint:
Collaboration diagram for PxPrismaticJoint:

List of all members.


Public Member Functions

virtual PxReal getPosition () const =0
 returns the displacement of the joint along its axis.
virtual PxReal getVelocity () const =0
 returns the velocity of the joint along its axis
virtual void setLimit (const PxJointLinearLimitPair &)=0
 sets the joint limit parameters.
virtual PxJointLinearLimitPair getLimit () const =0
 gets the joint 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 PxPrismaticJoint, used for serialization.

Protected Member Functions

PX_INLINE PxPrismaticJoint (PxType concreteType, PxBaseFlags baseFlags)
 Constructor.
PX_INLINE PxPrismaticJoint (PxBaseFlags baseFlags)
 Deserialization constructor.
virtual bool isKindOf (const char *name) const
 Returns whether a given type name matches with the type of this instance.

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

prismJoint.png

See also:
PxPrismaticJointCreate() PxJoint

Constructor & Destructor Documentation

PX_INLINE PxPrismaticJoint::PxPrismaticJoint ( PxType  concreteType,
PxBaseFlags  baseFlags 
) [inline, protected]

Constructor.

PX_INLINE PxPrismaticJoint::PxPrismaticJoint ( PxBaseFlags  baseFlags  )  [inline, protected]

Deserialization constructor.


Member Function Documentation

virtual const char* PxPrismaticJoint::getConcreteTypeName (  )  const [inline, virtual]

Returns string name of PxPrismaticJoint, used for serialization.

Implements PxBase.

virtual PxJointLinearLimitPair PxPrismaticJoint::getLimit (  )  const [pure virtual]

gets the joint limit parameters.

See also:
PxJointLinearLimit getLimit()

virtual PxReal PxPrismaticJoint::getPosition (  )  const [pure virtual]

returns the displacement of the joint along its axis.

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]

Get the angular tolerance threshold for projection.

See also:
getProjectionAngularTolerance()

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 PxReal PxPrismaticJoint::getVelocity (  )  const [pure virtual]

returns the velocity of the joint along its axis

virtual bool PxPrismaticJoint::isKindOf ( const char *  name  )  const [inline, protected, virtual]

Returns whether a given type name matches with the type of this instance.

Reimplemented from PxJoint.

References PxJoint::isKindOf().

virtual void PxPrismaticJoint::setLimit ( const PxJointLinearLimitPair  )  [pure virtual]

sets the joint limit parameters.

The limit range is [-PX_MAX_F32, PX_MAX_F32], but note that the width of the limit (upper-lower) must also be a valid float.

See also:
PxJointLinearLimitPair getLimit()

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, PX_MAX_F32)
Default: Pi

Parameters:
[in] tolerance the linear tolerance threshold
See also:
getProjectionLinearTolerance() PxJoint::setConstraintFlags()

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, PX_MAX_F32)
Default: 1e10f

Parameters:
[in] tolerance the linear tolerance threshold
See also:
getProjectionLinearTolerance()


The documentation for this class was generated from the following file:



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