PxJointAngularLimitPair Class Reference
[Extensions]

#include <PxJointLimit.h>

Inheritance diagram for PxJointAngularLimitPair:

[legend]

Collaboration diagram for PxJointAngularLimitPair:

[legend]

List of all members.

Public Member Functions
	PxJointAngularLimitPair (PxReal lowerLimit, PxReal upperLimit, PxReal contactDist=-1)
	construct an angular hard limit pair.
	PxJointAngularLimitPair (PxReal lowerLimit, PxReal upperLimit, const PxSpring &spring)
	construct an angular 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.
PxReal	lower

---

Constructor & Destructor Documentation

PxJointAngularLimitPair::PxJointAngularLimitPair	(	PxReal	lowerLimit,
		PxReal	upperLimit,
		PxReal	contactDist = -1
	)			[inline]

construct an angular hard limit pair.

The lower value must be less than the upper value.

Parameters:

[in]	lowerLimit	the lower angle of the limit
[in]	upperLimit	the upper angle of the limit
[in]	contactDist	the distance from the limit at which it becomes active. Default is the lesser of 0.1 radians, and 0.49 * (upperLimit - lowerLimit)

See also:

PxJointLimitParameters

References PxJointLimitParameters::contactDistance, and PxMin().

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

construct an angular soft limit pair.

The lower value must be less than the upper value.

Parameters:

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

See also:

PxJointLimitParameters

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

---

Member Function Documentation

PX_INLINE bool PxJointAngularLimitPair::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 PxJointAngularLimitPair::lower

PxReal PxJointAngularLimitPair::upper

the range of the limit. The upper limit must be no lower than the lower limit.

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