physx::PxJointLinearLimitPair Class Reference

Describes a two-sided limit. More...

#include <PxJointLimit.h>

Inheritance diagram for physx::PxJointLinearLimitPair:

Collaboration diagram for physx::PxJointLinearLimitPair:

Public Member Functions
	PxJointLinearLimitPair (const PxTolerancesScale &scale, PxReal lowerLimit=-PX_MAX_F32/3.0f, PxReal upperLimit=PX_MAX_F32/3.0f, PxReal contactDist_deprecated=-1.0f)
	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 Member Functions inherited from physx::PxJointLimitParameters
	PxJointLimitParameters (const PxJointLimitParameters &p)
PX_INLINE bool	isValid () const
	Returns true if the current settings are valid.
PX_INLINE bool	isSoft () const

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
Public Attributes inherited from physx::PxJointLimitParameters
PxReal	restitution
	Controls the amount of bounce when the joint hits a limit.
PxReal	bounceThreshold
PxReal	stiffness
	if greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit
PxReal	damping
	if spring is greater than zero, this is the damping of the limit spring
PxReal	contactDistance_deprecated
	The distance inside the limit value at which the limit will be considered to be active by the solver. As this value is made larger, the limit becomes active more quickly. It thus becomes less likely to violate the extents of the limit, but more expensive.

Detailed Description

Describes a two-sided limit.

Constructor & Destructor Documentation

PxJointLinearLimitPair() [1/2]

physx::PxJointLinearLimitPair::PxJointLinearLimitPair ( const PxTolerancesScale &  scale, PxReal  lowerLimit = -PX_MAX_F32/3.0f, PxReal  upperLimit = PX_MAX_F32/3.0f, PxReal  contactDist_deprecated = -1.0f  )

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_deprecated	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). This is deprecated in PhysX 5.1.

See also

PxJointLimitParameters PxTolerancesScale

PxJointLinearLimitPair() [2/2]

physx::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

Member Function Documentation

isValid()

PX_INLINE bool physx::PxJointLinearLimitPair::isValid ( ) const

inline

Returns true if the limit is valid.

Returns

true if the current settings are valid

Member Data Documentation

upper

PxReal physx::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.

Range: See the joint on which the limit is used for details
Default: lower = -PX_MAX_F32/3, upper = PX_MAX_F32/3

---

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

• RavEngine/deps/physx/physx/include/extensions/PxJointLimit.h