PhysX SDK 3.2 API Reference: PxJointLimitPair Class Reference

PhysX SDK 3.2 API

PxJointLimitPair Class Reference
[Extensions]

Describes a two-sided limit. More...

#include <PxJointLimit.h>

Inheritance diagram for PxJointLimitPair:
Collaboration diagram for PxJointLimitPair:

List of all members.


Public Member Functions

 PxJointLimitPair (PxReal lowerLimit, PxReal upperLimit, PxReal limitContactDistance)
 Construct a joint limit pair. The lower value must be less than the upper value. For good behavior the breadth of the limit should be more than twice the limit contact distance.
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 now 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.

Platform:


Constructor & Destructor Documentation

PxJointLimitPair::PxJointLimitPair ( PxReal  lowerLimit,
PxReal  upperLimit,
PxReal  limitContactDistance 
) [inline]

Construct a joint limit pair. The lower value must be less than the upper value. For good behavior the breadth of the limit should be more than twice the limit contact distance.

Parameters:
[in] lowerLimit the lower value of the limit
[in] upperLimit the upper value of the limit
[in] limitContactDistance the distance from the upper or lower limit at which the limit constraint becomes active.
See also:
PxJointLimitParameters


Member Function Documentation

PX_INLINE bool PxJointLimitPair::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

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

Unit: Angular: Radians Range: Angular: (-PI/2, PI/2)
Range: Linear: [-PX_MAX_F32, PX_MAX_F32]
Default: 0.0


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



Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com