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:

[legend]

Collaboration diagram for PxFixedJoint:

[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.

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:

• PxFixedJoint.h