PxDistanceJoint Class Reference
[Extensions]

#include <PxDistanceJoint.h>

Inheritance diagram for PxDistanceJoint:

[legend]

Collaboration diagram for PxDistanceJoint:

[legend]

List of all members.

Public Member Functions
virtual void	setMinDistance (PxReal distance)=0
	Set the allowed minimum distance for the joint.
virtual PxReal	getMinDistance () const =0
	Get the allowed minimum distance for the joint.
virtual void	setMaxDistance (PxReal distance)=0
	Set the allowed maximum distance for the joint.
virtual PxReal	getMaxDistance () const =0
	Get the allowed maximum distance for the joint.
virtual void	setTolerance (PxReal tolerance)=0
	Set the error tolerance of the joint.
virtual PxReal	getTolerance () const =0
	Get the error tolerance of the joint.
virtual void	setSpring (PxReal spring)=0
	Set the strength of the joint spring.
virtual PxReal	getSpring () const =0
	Get the strength of the joint spring.
virtual void	setDamping (PxReal damping)=0
	Set the damping of the joint spring.
virtual PxReal	getDamping () const =0
	Get the damping of the joint spring.
virtual void	setDistanceJointFlags (PxDistanceJointFlags flags)=0
	Set the flags specific to the Distance Joint.
virtual void	setDistanceJointFlag (PxDistanceJointFlag::Enum flag, bool value)=0
	Set a single flag specific to a Distance Joint to true or false.
virtual PxDistanceJointFlags	getDistanceJointFlags (void) const =0
	Get the flags specific to the Distance Joint.
virtual const char *	getConcreteTypeName () const
	returns string name of dynamic type.
Static Public Attributes
static const PxJointType::Enum	Type = PxJointType::eDISTANCE
Protected Member Functions
	PxDistanceJoint (PxRefResolver &v)
	PxDistanceJoint ()
virtual bool	isKindOf (const char *name) const

---

Constructor & Destructor Documentation

PxDistanceJoint::PxDistanceJoint

(

PxRefResolver &

v

)

[inline, protected]

PxDistanceJoint::PxDistanceJoint

(

)

[inline, protected]

---

Member Function Documentation

virtual const char* PxDistanceJoint::getConcreteTypeName

(

)

const [inline, virtual]

returns string name of dynamic type.

Returns:

class name of most derived type of this object.

Reimplemented from PxSerializable.

virtual PxReal PxDistanceJoint::getDamping

(

)

const [pure virtual]

Get the damping of the joint spring.

Returns:

the degree of damping of the joint spring of the joint

See also:

PxDistanceJointFlag::eSPRING_ENABLED setDamping()

virtual PxDistanceJointFlags PxDistanceJoint::getDistanceJointFlags

(

void

)

const [pure virtual]

Get the flags specific to the Distance Joint.

Returns:

the joint flags

See also:

PxDistanceJoint::flags, PxDistanceJointFlag setFlag() setFlags()

virtual PxReal PxDistanceJoint::getMaxDistance

(

)

const [pure virtual]

Get the allowed maximum distance for the joint.

Returns:

the allowed maximum distance

See also:

PxDistanceJoint::maxDistance, PxDistanceJointFlag::eMAX_DISTANCE_ENABLED setMaxDistance()

virtual PxReal PxDistanceJoint::getMinDistance

(

)

const [pure virtual]

Get the allowed minimum distance for the joint.

Returns:

the allowed minimum distance

See also:

PxDistanceJoint::minDistance, PxDistanceJointFlag::eMIN_DISTANCE_ENABLED setMinDistance()

virtual PxReal PxDistanceJoint::getSpring

(

)

const [pure virtual]

Get the strength of the joint spring.

Returns:

spring the spring strength of the joint

See also:

PxDistanceJointFlag::eSPRING_ENABLED setSpring()

virtual PxReal PxDistanceJoint::getTolerance

(

)

const [pure virtual]

Get the error tolerance of the joint.

the distance beyond the joint's [min, max] range before the joint becomes active. Default 0.25f * PxTolerancesScale::length Range (0, +inf)

This value should be used to ensure that if the minimum distance is zero and the spring function is in use, the rest length of the spring is non-zero.

See also:

PxDistanceJoint::tolerance, setTolerance()

virtual bool PxDistanceJoint::isKindOf

(

const char *

name

)

const [inline, protected, virtual]

Reimplemented from PxJoint.

References PxJoint::isKindOf().

virtual void PxDistanceJoint::setDamping

(

PxReal

damping

)

[pure virtual]

Set the damping of the joint spring.

The spring is used if enabled, and the distance exceeds the range [min-error, max+error].

Default 0.0f Range [0, +inf)

Parameters:

[in]

damping

the degree of damping of the joint spring of the joint

See also:

PxDistanceJointFlag::eSPRING_ENABLED setDamping()

virtual void PxDistanceJoint::setDistanceJointFlag	(	PxDistanceJointFlag::Enum	flag,
		bool	value
	)			[pure virtual]

Set a single flag specific to a Distance 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:

PxDistanceJointFlag, getFlags() setFlags()

virtual void PxDistanceJoint::setDistanceJointFlags

(

PxDistanceJointFlags

flags

)

[pure virtual]

Set the flags specific to the Distance Joint.

Default PxDistanceJointFlag::eMAX_DISTANCE_ENABLED

Parameters:

[in]

flags

The joint flags.

See also:

PxDistanceJointFlag setFlag() getFlags()

virtual void PxDistanceJoint::setMaxDistance

(

PxReal

distance

)

[pure virtual]

Set the allowed maximum distance for the joint.

The maximum distance must be no less than the minimum distance.

Default 0.0f Range [0, +inf)

Parameters:

[in]

distance

the maximum distance

See also:

PxDistanceJoint::maxDistance, PxDistanceJointFlag::eMAX_DISTANCE_ENABLED getMinDistance()

virtual void PxDistanceJoint::setMinDistance

(

PxReal

distance

)

[pure virtual]

Set the allowed minimum distance for the joint.

The minimum distance must be no more than the maximum distance

Default 0.0f Range [0, +inf)

Parameters:

[in]

distance

the minimum distance

See also:

PxDistanceJoint::minDistance, PxDistanceJointFlag::eMIN_DISTANCE_ENABLED getMinDistance()

virtual void PxDistanceJoint::setSpring

(

PxReal

spring

)

[pure virtual]

Set the strength of the joint spring.

The spring is used if enabled, and the distance exceeds the range [min-error, max+error].

Default 0.0f Range [0, +inf)

Parameters:

[in]

spring

the spring strength of the joint

See also:

PxDistanceJointFlag::eSPRING_ENABLED getSpring()

virtual void PxDistanceJoint::setTolerance

(

PxReal

tolerance

)

[pure virtual]

Set the error tolerance of the joint.

Parameters:

[in]

tolerance

the distance beyond the allowed range at which the joint becomes active

See also:

PxDistanceJoint::tolerance, getTolerance()

---

Member Data Documentation

const PxJointType::Enum PxDistanceJoint::Type = PxJointType::eDISTANCE [static]

---

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

• PxDistanceJoint.h