PxJointLinearLimit Class Reference

Describes a one-sided linear limit. More...

#include <PxJointLimit.h>

Inheritance diagram for PxJointLinearLimit:
Collaboration diagram for PxJointLinearLimit:

Public Member Functions

 PxJointLinearLimit (const PxTolerancesScale &scale, PxReal extent, PxReal contactDist=-1.0f)
 construct a linear hard limit More...
 
 PxJointLinearLimit (PxReal extent, const PxSpring &spring)
 construct a linear soft limit More...
 
PX_INLINE bool isValid () const
 Returns true if the limit is valid. More...
 
- Public Member Functions inherited from PxJointLimitParameters
 PxJointLimitParameters ()
 
 PxJointLimitParameters (const PxJointLimitParameters &p)
 
PX_INLINE bool isValid () const
 Returns true if the current settings are valid. More...
 
PX_INLINE bool isSoft () const
 

Public Attributes

PxReal value
 the extent of the limit. More...
 
- Public Attributes inherited from PxJointLimitParameters
PxReal restitution
 Controls the amount of bounce when the joint hits a limit. More...
 
PxReal bounceThreshold
 
PxReal stiffness
 if greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit More...
 
PxReal damping
 if spring is greater than zero, this is the damping of the limit spring More...
 
PxReal contactDistance
 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. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PxJointLimitParameters
 ~PxJointLimitParameters ()
 

Detailed Description

Describes a one-sided linear limit.

Constructor & Destructor Documentation

◆ PxJointLinearLimit() [1/2]

PxJointLinearLimit::PxJointLinearLimit ( const PxTolerancesScale scale,
PxReal  extent,
PxReal  contactDist = -1.0f 
)
inline

construct a linear hard limit

Parameters
[in]scaleA PxTolerancesScale struct. Should be the same as used when creating the PxPhysics object.
[in]extentThe extent of the limit
[in]contactDistThe distance from the limit at which it becomes active. Default is 0.01f scaled by the tolerance length scale
See also
PxJointLimitParameters PxTolerancesScale

References PxJointLimitParameters::contactDistance, and PxTolerancesScale::length.

◆ PxJointLinearLimit() [2/2]

PxJointLinearLimit::PxJointLinearLimit ( PxReal  extent,
const PxSpring spring 
)
inline

construct a linear soft limit

Parameters
[in]extentthe extent of the limit
[in]springthe stiffness and damping parameters for the limit spring
See also
PxJointLimitParameters PxTolerancesScale

References damping, spring, and stiffness.

Member Function Documentation

◆ isValid()

PX_INLINE bool PxJointLinearLimit::isValid ( ) const
inline

Returns true if the limit is valid.

Returns
true if the current settings are valid

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

Member Data Documentation

◆ value

PxReal PxJointLinearLimit::value

the extent of the limit.

Range: (0, PX_MAX_F32)
Default: PX_MAX_F32


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