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/classPxFixedJoint.html | 306 +++++++++++++++++++++ 1 file changed, 306 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html new file mode 100644 index 00000000..80506ac6 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFixedJoint.html @@ -0,0 +1,306 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxFixedJoint Class Reference + + + + + + + +
+

PxFixedJoint Class Reference
+ +[Extensions] +

A fixed joint permits no relative movement between two bodies. ie the bodies are glued together. +More... +

+#include <PxFixedJoint.h> +

+

+Inheritance diagram for PxFixedJoint:
+
+

Inheritance graph
+ +PxJointPxBase +
[legend]
+
+Collaboration diagram for PxFixedJoint:
+
+

Collaboration graph
+ +PxJointPxBasePxFlags\< PxBaseFlag::Enum, PxU16 \> +
[legend]
+ +

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

Public Member Functions

virtual void setProjectionLinearTolerance (PxReal tolerance)=0
 Set the linear tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJECTION is set for the joint.
virtual PxReal getProjectionLinearTolerance () const =0
 Get the linear tolerance threshold for projection.
virtual void setProjectionAngularTolerance (PxReal tolerance)=0
 Set the angular tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJECTION is set for the joint.
virtual PxReal getProjectionAngularTolerance () const =0
 Get the angular tolerance threshold for projection.
virtual const char * getConcreteTypeName () const
 Returns string name of PxFixedJoint, used for serialization.

Protected Member Functions

PX_INLINE PxFixedJoint (PxType concreteType, PxBaseFlags baseFlags)
 Constructor.
PX_INLINE PxFixedJoint (PxBaseFlags baseFlags)
 Deserialization constructor.
virtual bool isKindOf (const char *name) const
 Returns whether a given type name matches with the type of this instance.
+

Detailed Description

+A fixed joint permits no relative movement between two bodies. ie the bodies are glued together. +

+

+fixedJoint.png +
+

+

See also:
PxFixedJointCreate() PxJoint
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
PX_INLINE PxFixedJoint::PxFixedJoint (PxType  concreteType,
PxBaseFlags  baseFlags 
) [inline, protected]
+
+
+ +

+Constructor. +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE PxFixedJoint::PxFixedJoint (PxBaseFlags  baseFlags  )  [inline, protected]
+
+
+ +

+Deserialization constructor. +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
virtual const char* PxFixedJoint::getConcreteTypeName (  )  const [inline, virtual]
+
+
+ +

+Returns string name of PxFixedJoint, used for serialization. +

+ +

Implements PxBase.

+ +
+

+ +

+
+ + + + + + + + +
virtual PxReal PxFixedJoint::getProjectionAngularTolerance (  )  const [pure virtual]
+
+
+ +

+Get the angular tolerance threshold for projection. +

+

Returns:
the angular tolerance threshold in radians
+
See also:
setProjectionAngularTolerance()
+ +
+

+ +

+
+ + + + + + + + +
virtual PxReal PxFixedJoint::getProjectionLinearTolerance (  )  const [pure virtual]
+
+
+ +

+Get the linear tolerance threshold for projection. +

+

Returns:
the linear tolerance threshold
+
See also:
setProjectionLinearTolerance() PxJoint::setConstraintFlag()
+ +
+

+ +

+
+ + + + + + + + + +
virtual bool PxFixedJoint::isKindOf (const char *  name  )  const [inline, protected, virtual]
+
+
+ +

+Returns whether a given type name matches with the type of this instance. +

+ +

Reimplemented from PxJoint.

+ +

References PxJoint::isKindOf().

+ +
+

+ +

+
+ + + + + + + + + +
virtual void PxFixedJoint::setProjectionAngularTolerance (PxReal  tolerance  )  [pure virtual]
+
+
+ +

+Set the angular tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJECTION is set for the joint. +

+If the joint deviates by more than this angle around its locked angular degrees of freedom, the solver will move the bodies to close the angle.

+Setting a very small tolerance may result in simulation jitter or other artifacts.

+Sometimes it is not possible to project (for example when the joints form a cycle).

+Range: [0,Pi]
+ Default: Pi

+

Parameters:
+ + +
[in] tolerance the angular tolerance threshold in radians
+
+
See also:
getProjectionAngularTolerance() PxJoint::setConstraintFlag() PxConstraintFlag::ePROJECTION
+ +
+

+ +

+
+ + + + + + + + + +
virtual void PxFixedJoint::setProjectionLinearTolerance (PxReal  tolerance  )  [pure virtual]
+
+
+ +

+Set the linear tolerance threshold for projection. Projection is enabled if PxConstraintFlag::ePROJECTION is set for the joint. +

+If the joint separates by more than this distance along its locked degrees of freedom, the solver will move the bodies to close the distance.

+Setting a very small tolerance may result in simulation jitter or other artifacts.

+Sometimes it is not possible to project (for example when the joints form a cycle).

+Range: [0, PX_MAX_F32)
+ Default: 1e10f

+

Parameters:
+ + +
[in] tolerance the linear tolerance threshold
+
+
See also:
getProjectionLinearTolerance() PxJoint::setConstraintFlags() PxConstraintFlag::ePROJECTION
+ +
+

+

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