PxJointLimitCone Class Reference
[Extensions]

Describes an elliptical conical joint limit. Note that very small or highly elliptical limit cones may result in jitter. More...

#include <PxJointLimit.h>

Inheritance diagram for PxJointLimitCone:

Inheritance graph
PxJointLimitParameters
[legend]
Collaboration diagram for PxJointLimitCone:

Collaboration graph
PxJointLimitParameters
[legend]

List of all members.

Public Member Functions

 PxJointLimitCone (PxReal yLimitAngle, PxReal zLimitAngle, PxReal contactDist=-1)
 Construct a cone hard limit.
 PxJointLimitCone (PxReal yLimitAngle, PxReal zLimitAngle, const PxSpring &spring)
 Construct a cone soft limit.
PX_INLINE bool isValid () const
 Returns true if the limit is valid.

Public Attributes

PxReal yAngle
 the maximum angle from the Y axis of the constraint frame.
PxReal zAngle
 the maximum angle from the Z-axis of the constraint frame.


Detailed Description

Describes an elliptical conical joint limit. Note that very small or highly elliptical limit cones may result in jitter.

See also:
PxD6Joint PxSphericalJoint

Constructor & Destructor Documentation

PxJointLimitCone::PxJointLimitCone ( PxReal  yLimitAngle,
PxReal  zLimitAngle,
PxReal  contactDist = -1 
) [inline]

Construct a cone hard limit.

Parameters:
[in] yLimitAngle the limit angle from the Y-axis of the constraint frame
[in] zLimitAngle the limit angle from the Z-axis of the constraint frame
[in] contactDist the distance from the limit at which it becomes active. Default is the lesser of 0.1 radians, and 0.49 * the lower of the limit angles
See also:
PxJointLimitParameters

References PxJointLimitParameters::contactDistance, and PxMin().

PxJointLimitCone::PxJointLimitCone ( PxReal  yLimitAngle,
PxReal  zLimitAngle,
const PxSpring spring 
) [inline]

Construct a cone soft limit.

Parameters:
[in] yLimitAngle the limit angle from the Y-axis of the constraint frame
[in] zLimitAngle the limit angle from the Z-axis of the constraint frame
[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 PxJointLimitCone::isValid (  )  const [inline]

Returns true if the limit is valid.

Returns:
true if the current settings are valid

Reimplemented from PxJointLimitParameters.

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


Member Data Documentation

the maximum angle from the Y axis of the constraint frame.

Unit: Angular: Radians Range: Angular: (0,PI)
Default: PI/2

the maximum angle from the Z-axis of the constraint frame.

Unit: Angular: Radians Range: Angular: (0,PI)
Default: PI/2


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


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