PxJointLinearLimitPair Class Reference
[Extensions]

Describes a two-sided limit. More...

#include <PxJointLimit.h>

Inheritance diagram for PxJointLinearLimitPair:

[legend]

Collaboration diagram for PxJointLinearLimitPair:

[legend]

List of all members.

Public Member Functions
	PxJointLinearLimitPair (const PxTolerancesScale &scale, PxReal lowerLimit, PxReal upperLimit, PxReal contactDist=-1)
	Construct a linear hard limit pair. The lower distance value must be less than the upper distance value.
	PxJointLinearLimitPair (PxReal lowerLimit, PxReal upperLimit, const PxSpring &spring)
	construct a linear soft limit pair
PX_INLINE bool	isValid () const
	Returns true if the limit is valid.
Public Attributes
PxReal	upper
	the range of the limit. The upper limit must be no lower than the lower limit, and if they are equal the limited degree of freedom will be treated as locked.
PxReal	lower

---

Detailed Description

Describes a two-sided limit.

---

Constructor & Destructor Documentation

PxJointLinearLimitPair::PxJointLinearLimitPair	(	const PxTolerancesScale &	scale,
		PxReal	lowerLimit,
		PxReal	upperLimit,
		PxReal	contactDist = -1
	)			[inline]

Construct a linear hard limit pair. The lower distance value must be less than the upper distance value.

Parameters:

[in]	scale	a PxTolerancesScale struct. Should be the same as used when creating the PxPhysics object.
[in]	lowerLimit	the lower distance of the limit
[in]	upperLimit	the upper distance of the limit
[in]	contactDist	the distance from the limit at which it becomes active. Default is the lesser of 0.01f scaled by the tolerance length scale, and 0.49 * (upperLimit - lowerLimit)

See also:

PxJointLimitParameters PxTolerancesScale

References PxJointLimitParameters::contactDistance, PxTolerancesScale::length, and PxMin().

PxJointLinearLimitPair::PxJointLinearLimitPair	(	PxReal	lowerLimit,
		PxReal	upperLimit,
		const PxSpring &	spring
	)			[inline]

construct a linear soft limit pair

Parameters:

[in]	lowerLimit	the lower distance of the limit
[in]	upperLimit	the upper distance of the limit
[in]	spring	the stiffness and damping parameters of the limit spring

See also:

PxJointLimitParameters PxTolerancesScale

References PxSpring::damping, and PxSpring::stiffness.

---

Member Function Documentation

PX_INLINE bool PxJointLinearLimitPair::isValid

(

)

const [inline]

Returns true if the limit is valid.

Returns:

true if the current settings are valid

Reimplemented from PxJointLimitParameters.

References PxJointLimitParameters::isValid(), and PxIsFinite().

---

Member Data Documentation

PxReal PxJointLinearLimitPair::lower

PxReal PxJointLinearLimitPair::upper

the range of the limit. The upper limit must be no lower than the lower limit, and if they are equal the limited degree of freedom will be treated as locked.

Unit: Angular: Radians Range: See the joint on which the limit is used for details
Default: 0.0

---

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

• PxJointLimit.h