From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classPxJointLinearLimit.html | 205 +++++++++++++++++++++ 1 file changed, 205 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimit.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimit.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimit.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimit.html new file mode 100644 index 00000000..f51a0e6b --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxJointLinearLimit.html @@ -0,0 +1,205 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxJointLinearLimit Class Reference + + + + + + + +
+

PxJointLinearLimit Class Reference
+ +[Extensions] +

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

+#include <PxJointLimit.h> +

+

+Inheritance diagram for PxJointLinearLimit:
+
+

Inheritance graph
+ +PxJointLimitParameters +
[legend]
+
+Collaboration diagram for PxJointLinearLimit:
+
+

Collaboration graph
+ +PxJointLimitParameters +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + +

Public Member Functions

 PxJointLinearLimit (const PxTolerancesScale &scale, PxReal extent, PxReal contactDist=-1)
 construct a linear hard limit
 PxJointLinearLimit (PxReal extent, const PxSpring &spring)
 construct a linear soft limit
PX_INLINE bool isValid () const
 Returns true if the limit is valid.

Public Attributes

PxReal value
 the extent of the limit.
+

Detailed Description

+Describes a one-sided linear limit.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
PxJointLinearLimit::PxJointLinearLimit (const PxTolerancesScale &  scale,
PxReal  extent,
PxReal  contactDist = -1 
) [inline]
+
+
+ +

+construct a linear hard limit +

+

Parameters:
+ + + + +
[in] scale a PxTolerancesScale struct. Should be the same as used when creating the PxPhysics object.
[in] extent the extent of the limit
[in] contactDist the 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::PxJointLinearLimit (PxReal  extent,
const PxSpring &  spring 
) [inline]
+
+
+ +

+construct a linear soft limit +

+

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

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

+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
PX_INLINE bool PxJointLinearLimit::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 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: +
+ +

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