PxArticulationMimicJoint

Defined in include/PxArticulationMimicJoint.h

class PxArticulationMimicJoint : public PxBase

A mimic joint enforces a linear relationship between the positions of two joints of the same articulation instance.

See also

PxArticulationReducedCoodinate::createMimicJoint()

Public Functions

virtual void release() = 0

Releases the mimic joint.

Note

Releasing a mimic joint is not allowed while the articulation is in a scene. In order to release a mimic joint, remove and then re-add the articulation to the scene.

virtual PxArticulationReducedCoordinate &getArticulation() const = 0

Returns the articulation that this mimic joint is part of.

Returns

A reference to the articulation.

virtual PxReal getGearRatio() const = 0

Get the gear of a mimic joint.

Returns

The gear ratio.

virtual void setGearRatio(PxReal gearRatio) = 0

Set the gear ratio of a mimic joint.

Parameters

gearRatio – [in] is the new gear ratio to be used in the next simulation step.

virtual PxReal getOffset() const = 0

Get the offset of a mimic joint.

Returns

The offset.

virtual void setOffset(PxReal offset) = 0

Set the offset of a mimic joint.

Parameters

offset – [in] is the new offset to be used in the next simulation step.

virtual PxReal getNaturalFrequency() const = 0

Get the natural frequency of a mimic joint.

Returns

The natural frequency.

virtual void setNaturalFrequency(PxReal naturalFrequency) = 0

Set the natural frequency of a mimic joint.

Parameters

naturalFrequency – [in] is the new natural frequency to be used in the next simulation step.

virtual PxReal getDampingRatio() const = 0

Get the damping ratio of a mimic joint.

Returns

The damping ratio.

virtual void setDampingRatio(PxReal dampingRatio) = 0

Set the damping ratio of a mimic joint.

Parameters

dampingRatio – [in] is the new damping ratio to be used in the next simulation step.

virtual PxArticulationJointReducedCoordinate &getJointA() const = 0

Return the jointA specified in PxArticulationReducedCoordinate::createMimicJoint()

See also

PxArticulationReducedCoordinate::createMimicJoint()

Returns

The jointA specified in PxArticulationReducedCoordinate::createMimicJoint()

virtual PxArticulationJointReducedCoordinate &getJointB() const = 0

Return the jointB specified in PxArticulationReducedCoordinate::createMimicJoint()

See also

PxArticulationReducedCoordinate::createMimicJoint()

Returns

The jointB specified in PxArticulationReducedCoordinate::createMimicJoint()

virtual PxArticulationAxis::Enum getAxisA() const = 0

Return the axisA specified in PxArticulationReducedCoordinate::createMimicJoint()

See also

PxArticulationReducedCoordinate::createMimicJoint()

Returns

The axisA specified in PxArticulationReducedCoordinate::createMimicJoint()

virtual PxArticulationAxis::Enum getAxisB() const = 0

Return the axisB specified in PxArticulationReducedCoordinate::createMimicJoint()

See also

PxArticulationReducedCoordinate::createMimicJoint()

Returns

The axisB specified in PxArticulationReducedCoordinate::createMimicJoint()

inline virtual const char *getConcreteTypeName() const final override

Returns the string name of the dynamic type.

Returns

The string name.

inline virtual ~PxArticulationMimicJoint()
template<class T>
inline T *is()
template<class T>
inline const T *is() const
inline PxType getConcreteType() const

Returns concrete type of object.

See also

PxConcreteType

Returns

PxConcreteType::Enum of serialized object

inline void setBaseFlag(PxBaseFlag::Enum flag, bool value)

Set PxBaseFlag

Parameters

  • flag – [in] The flag to be set

  • value – [in] The flags new value

inline void setBaseFlags(PxBaseFlags inFlags)

Set PxBaseFlags

See also

PxBaseFlags

Parameters

inFlags – [in] The flags to be set

inline PxBaseFlags getBaseFlags() const

Returns PxBaseFlags.

See also

PxBaseFlags

Returns

PxBaseFlags

inline virtual bool isReleasable() const

Whether the object is subordinate.

A class is subordinate, if it can only be instantiated in the context of another class.

See also

PxSerialization::isSerializable

Returns

Whether the class is subordinate

Public Members

void *userData

user can assign this to whatever, usually to create a 1:1 relationship with a user object.

Protected Functions

inline PxArticulationMimicJoint(PxType concreteType, PxBaseFlags baseFlags)
inline PxArticulationMimicJoint(PxBaseFlags baseFlags)
inline virtual bool isKindOf(const char *superClass) const

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

template<class T>
inline bool typeMatch() const

Protected Attributes

PxType mConcreteType
PxBaseFlags mBaseFlags
PxU32 mBuiltInRefCount