PxDistanceJoint Class Referenceabstract

a joint that maintains an upper or lower bound (or both) on the distance between two points on different objects More...

#include <PxDistanceJoint.h>

Inheritance diagram for PxDistanceJoint:
Collaboration diagram for PxDistanceJoint:

Public Member Functions

virtual PxReal getDistance () const =0
 Return the current distance of the joint. More...
 
virtual void setMinDistance (PxReal distance)=0
 Set the allowed minimum distance for the joint. More...
 
virtual PxReal getMinDistance () const =0
 Get the allowed minimum distance for the joint. More...
 
virtual void setMaxDistance (PxReal distance)=0
 Set the allowed maximum distance for the joint. More...
 
virtual PxReal getMaxDistance () const =0
 Get the allowed maximum distance for the joint. More...
 
virtual void setTolerance (PxReal tolerance)=0
 Set the error tolerance of the joint. More...
 
virtual PxReal getTolerance () const =0
 Get the error tolerance of the joint. More...
 
virtual void setStiffness (PxReal stiffness)=0
 Set the strength of the joint spring. More...
 
virtual PxReal getStiffness () const =0
 Get the strength of the joint spring. More...
 
virtual void setDamping (PxReal damping)=0
 Set the damping of the joint spring. More...
 
virtual PxReal getDamping () const =0
 Get the damping of the joint spring. More...
 
virtual void setDistanceJointFlags (PxDistanceJointFlags flags)=0
 Set the flags specific to the Distance Joint. More...
 
virtual void setDistanceJointFlag (PxDistanceJointFlag::Enum flag, bool value)=0
 Set a single flag specific to a Distance Joint to true or false. More...
 
virtual PxDistanceJointFlags getDistanceJointFlags () const =0
 Get the flags specific to the Distance Joint. More...
 
virtual const char * getConcreteTypeName () const
 Returns string name of PxDistanceJoint, used for serialization. More...
 
- Public Member Functions inherited from PxJoint
virtual void setActors (PxRigidActor *actor0, PxRigidActor *actor1)=0
 Set the actors for this joint. More...
 
virtual void getActors (PxRigidActor *&actor0, PxRigidActor *&actor1) const =0
 Get the actors for this joint. More...
 
virtual void setLocalPose (PxJointActorIndex::Enum actor, const PxTransform &localPose)=0
 Set the joint local pose for an actor. More...
 
virtual PxTransform getLocalPose (PxJointActorIndex::Enum actor) const =0
 get the joint local pose for an actor. More...
 
virtual PxTransform getRelativeTransform () const =0
 get the relative pose for this joint More...
 
virtual PxVec3 getRelativeLinearVelocity () const =0
 get the relative linear velocity of the joint More...
 
virtual PxVec3 getRelativeAngularVelocity () const =0
 get the relative angular velocity of the joint More...
 
virtual void setBreakForce (PxReal force, PxReal torque)=0
 set the break force for this joint. More...
 
virtual void getBreakForce (PxReal &force, PxReal &torque) const =0
 get the break force for this joint. More...
 
virtual void setConstraintFlags (PxConstraintFlags flags)=0
 set the constraint flags for this joint. More...
 
virtual void setConstraintFlag (PxConstraintFlag::Enum flag, bool value)=0
 set a constraint flags for this joint to a specified value. More...
 
virtual PxConstraintFlags getConstraintFlags () const =0
 get the constraint flags for this joint. More...
 
virtual void setInvMassScale0 (PxReal invMassScale)=0
 set the inverse mass scale for actor0. More...
 
virtual PxReal getInvMassScale0 () const =0
 get the inverse mass scale for actor0. More...
 
virtual void setInvInertiaScale0 (PxReal invInertiaScale)=0
 set the inverse inertia scale for actor0. More...
 
virtual PxReal getInvInertiaScale0 () const =0
 get the inverse inertia scale for actor0. More...
 
virtual void setInvMassScale1 (PxReal invMassScale)=0
 set the inverse mass scale for actor1. More...
 
virtual PxReal getInvMassScale1 () const =0
 get the inverse mass scale for actor1. More...
 
virtual void setInvInertiaScale1 (PxReal invInertiaScale)=0
 set the inverse inertia scale for actor1. More...
 
virtual PxReal getInvInertiaScale1 () const =0
 get the inverse inertia scale for actor1. More...
 
virtual PxConstraintgetConstraint () const =0
 Retrieves the PxConstraint corresponding to this joint. More...
 
virtual void setName (const char *name)=0
 Sets a name string for the object that can be retrieved with getName(). More...
 
virtual const char * getName () const =0
 Retrieves the name string set with setName(). More...
 
virtual void release ()=0
 Deletes the joint. More...
 
virtual PxScenegetScene () const =0
 Retrieves the scene which this joint belongs to. More...
 
- Public Member Functions inherited from PxBase
template<class T >
T * is ()
 
template<class T >
const T * is () const
 
PX_FORCE_INLINE PxType getConcreteType () const
 Returns concrete type of object. More...
 
PX_FORCE_INLINE void setBaseFlag (PxBaseFlag::Enum flag, bool value)
 Set PxBaseFlag. More...
 
PX_FORCE_INLINE void setBaseFlags (PxBaseFlags inFlags)
 Set PxBaseFlags. More...
 
PX_FORCE_INLINE PxBaseFlags getBaseFlags () const
 Returns PxBaseFlags. More...
 
virtual bool isReleasable () const
 Whether the object is subordinate. More...
 

Protected Member Functions

PX_INLINE PxDistanceJoint (PxType concreteType, PxBaseFlags baseFlags)
 Constructor. More...
 
PX_INLINE PxDistanceJoint (PxBaseFlags baseFlags)
 Deserialization constructor. More...
 
virtual bool isKindOf (const char *name) const
 Returns whether a given type name matches with the type of this instance. More...
 
- Protected Member Functions inherited from PxJoint
virtual ~PxJoint ()
 
PX_INLINE PxJoint (PxType concreteType, PxBaseFlags baseFlags)
 Constructor. More...
 
PX_INLINE PxJoint (PxBaseFlags baseFlags)
 Deserialization constructor. More...
 
- Protected Member Functions inherited from PxBase
PX_INLINE PxBase (PxType concreteType, PxBaseFlags baseFlags)
 Constructor setting concrete type and base flags. More...
 
PX_INLINE PxBase (PxBaseFlags baseFlags)
 Deserialization constructor setting base flags. More...
 
virtual ~PxBase ()
 Destructor. More...
 
template<class T >
bool typeMatch () const
 

Additional Inherited Members

- Static Public Member Functions inherited from PxJoint
static void getBinaryMetaData (PxOutputStream &stream)
 Put class meta data in stream, used for serialization. More...
 
- Public Attributes inherited from PxJoint
void * userData
 user can assign this to whatever, usually to create a 1:1 relationship with a user object. More...
 
- Protected Attributes inherited from PxBase
PxType mConcreteType
 
PxBaseFlags mBaseFlags
 

Detailed Description

a joint that maintains an upper or lower bound (or both) on the distance between two points on different objects

See also
PxDistanceJointCreate PxJoint

Constructor & Destructor Documentation

◆ PxDistanceJoint() [1/2]

PX_INLINE PxDistanceJoint::PxDistanceJoint ( PxType  concreteType,
PxBaseFlags  baseFlags 
)
inlineprotected

Constructor.

◆ PxDistanceJoint() [2/2]

PX_INLINE PxDistanceJoint::PxDistanceJoint ( PxBaseFlags  baseFlags)
inlineprotected

Deserialization constructor.

Member Function Documentation

◆ getConcreteTypeName()

virtual const char* PxDistanceJoint::getConcreteTypeName ( ) const
inlinevirtual

Returns string name of PxDistanceJoint, used for serialization.

Implements PxBase.

◆ getDamping()

virtual PxReal PxDistanceJoint::getDamping ( ) const
pure virtual

Get the damping of the joint spring.

Returns
the degree of damping of the joint spring of the joint
See also
PxDistanceJointFlag::eSPRING_ENABLED setDamping()

◆ getDistance()

virtual PxReal PxDistanceJoint::getDistance ( ) const
pure virtual

Return the current distance of the joint.

◆ getDistanceJointFlags()

virtual PxDistanceJointFlags PxDistanceJoint::getDistanceJointFlags ( ) const
pure virtual

Get the flags specific to the Distance Joint.

Returns
the joint flags
See also
PxDistanceJoint::flags, PxDistanceJointFlag setFlag() setFlags()

◆ getMaxDistance()

virtual PxReal PxDistanceJoint::getMaxDistance ( ) const
pure virtual

Get the allowed maximum distance for the joint.

Returns
the allowed maximum distance
See also
PxDistanceJoint::maxDistance, PxDistanceJointFlag::eMAX_DISTANCE_ENABLED setMaxDistance()

◆ getMinDistance()

virtual PxReal PxDistanceJoint::getMinDistance ( ) const
pure virtual

Get the allowed minimum distance for the joint.

Returns
the allowed minimum distance
See also
PxDistanceJoint::minDistance, PxDistanceJointFlag::eMIN_DISTANCE_ENABLED setMinDistance()

◆ getStiffness()

virtual PxReal PxDistanceJoint::getStiffness ( ) const
pure virtual

Get the strength of the joint spring.

Returns
stiffness the spring strength of the joint
See also
PxDistanceJointFlag::eSPRING_ENABLED setStiffness()

◆ getTolerance()

virtual PxReal PxDistanceJoint::getTolerance ( ) const
pure virtual

Get the error tolerance of the joint.

the distance beyond the joint's [min, max] range before the joint becomes active.

Default 0.25f * PxTolerancesScale::length Range (0, PX_MAX_F32)

This value should be used to ensure that if the minimum distance is zero and the spring function is in use, the rest length of the spring is non-zero.

See also
PxDistanceJoint::tolerance, setTolerance()

◆ isKindOf()

virtual bool PxDistanceJoint::isKindOf ( const char *  name) const
inlineprotectedvirtual

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

Reimplemented from PxJoint.

References PxJoint::isKindOf().

◆ setDamping()

virtual void PxDistanceJoint::setDamping ( PxReal  damping)
pure virtual

Set the damping of the joint spring.

The spring is used if enabled, and the distance exceeds the range [min-error, max+error].

Default 0.0f Range [0, PX_MAX_F32)

Parameters
[in]dampingthe degree of damping of the joint spring of the joint
See also
PxDistanceJointFlag::eSPRING_ENABLED setDamping()

◆ setDistanceJointFlag()

virtual void PxDistanceJoint::setDistanceJointFlag ( PxDistanceJointFlag::Enum  flag,
bool  value 
)
pure virtual

Set a single flag specific to a Distance Joint to true or false.

Parameters
[in]flagThe flag to set or clear.
[in]valuethe value to which to set the flag
See also
PxDistanceJointFlag, getFlags() setFlags()

◆ setDistanceJointFlags()

virtual void PxDistanceJoint::setDistanceJointFlags ( PxDistanceJointFlags  flags)
pure virtual

Set the flags specific to the Distance Joint.

Default PxDistanceJointFlag::eMAX_DISTANCE_ENABLED

Parameters
[in]flagsThe joint flags.
See also
PxDistanceJointFlag setFlag() getFlags()

◆ setMaxDistance()

virtual void PxDistanceJoint::setMaxDistance ( PxReal  distance)
pure virtual

Set the allowed maximum distance for the joint.

The maximum distance must be no less than the minimum distance.

Default 0.0f Range [0, PX_MAX_F32)

Parameters
[in]distancethe maximum distance
See also
PxDistanceJoint::maxDistance, PxDistanceJointFlag::eMAX_DISTANCE_ENABLED getMinDistance()

◆ setMinDistance()

virtual void PxDistanceJoint::setMinDistance ( PxReal  distance)
pure virtual

Set the allowed minimum distance for the joint.

The minimum distance must be no more than the maximum distance

Default 0.0f Range [0, PX_MAX_F32)

Parameters
[in]distancethe minimum distance
See also
PxDistanceJoint::minDistance, PxDistanceJointFlag::eMIN_DISTANCE_ENABLED getMinDistance()

◆ setStiffness()

virtual void PxDistanceJoint::setStiffness ( PxReal  stiffness)
pure virtual

Set the strength of the joint spring.

The spring is used if enabled, and the distance exceeds the range [min-error, max+error].

Default 0.0f Range [0, PX_MAX_F32)

Parameters
[in]stiffnessthe spring strength of the joint
See also
PxDistanceJointFlag::eSPRING_ENABLED getStiffness()

◆ setTolerance()

virtual void PxDistanceJoint::setTolerance ( PxReal  tolerance)
pure virtual

Set the error tolerance of the joint.

Parameters
[in]tolerancethe distance beyond the allowed range at which the joint becomes active
See also
PxDistanceJoint::tolerance, getTolerance()

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