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

#include <PxContactJoint.h>

Inheritance diagram for PxContactJoint:

[legend]

Collaboration diagram for PxContactJoint:

[legend]

Public Member Functions
virtual void	setContact (const PxVec3 &contact)=0
	Set the current contact of the joint. More...

virtual void	setContactNormal (const PxVec3 &contactNormal)=0
	Set the current contact normal of the joint. More...

virtual void	setPenetration (const PxReal penetration)=0
	Set the current penetration of the joint. More...

virtual PxVec3	getContact () const =0
	Return the current contact of the joint. More...

virtual PxVec3	getContactNormal () const =0
	Return the current contact normal of the joint. More...

virtual PxReal	getPenetration () const =0
	Return the current penetration value of the joint. More...

virtual PxReal	getResititution () const =0

virtual void	setResititution (const PxReal resititution)=0

virtual PxReal	getBounceThreshold () const =0

virtual void	setBounceThreshold (const PxReal bounceThreshold)=0

virtual const char *	getConcreteTypeName () const
	Returns string name of PxContactJoint, used for serialization. More...

virtual void	computeJacobians (PxJacobianRow *jacobian) const =0

virtual PxU32	getNbJacobianRows () const =0

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 PxConstraint *	getConstraint () 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 PxScene *	getScene () 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	PxContactJoint (PxType concreteType, PxBaseFlags baseFlags)
	Constructor. More...

PX_INLINE	PxContactJoint (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: PxContactJointCreate PxJoint

Constructor & Destructor Documentation

◆ PxContactJoint() [1/2]

PX_INLINE PxContactJoint::PxContactJoint	(	PxType	concreteType,
		PxBaseFlags	baseFlags
	)

inlineprotected

Constructor.

◆ PxContactJoint() [2/2]

PX_INLINE PxContactJoint::PxContactJoint ( PxBaseFlags baseFlags )

inlineprotected

Deserialization constructor.

Member Function Documentation

◆ computeJacobians()

virtual void PxContactJoint::computeJacobians ( PxJacobianRow * jacobian ) const

pure virtual

◆ getBounceThreshold()

virtual PxReal PxContactJoint::getBounceThreshold ( ) const

pure virtual

◆ getConcreteTypeName()

virtual const char* PxContactJoint::getConcreteTypeName ( ) const

inlinevirtual

Returns string name of PxContactJoint, used for serialization.

Implements PxBase.

◆ getContact()

virtual PxVec3 PxContactJoint::getContact ( ) const

pure virtual

Return the current contact of the joint.

◆ getContactNormal()

virtual PxVec3 PxContactJoint::getContactNormal ( ) const

pure virtual

Return the current contact normal of the joint.

◆ getNbJacobianRows()

virtual PxU32 PxContactJoint::getNbJacobianRows ( ) const

pure virtual

◆ getPenetration()

virtual PxReal PxContactJoint::getPenetration ( ) const

pure virtual

Return the current penetration value of the joint.

◆ getResititution()

virtual PxReal PxContactJoint::getResititution ( ) const

pure virtual

◆ isKindOf()

virtual bool PxContactJoint::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().

◆ setBounceThreshold()

virtual void PxContactJoint::setBounceThreshold ( const PxReal bounceThreshold )

pure virtual

◆ setContact()

virtual void PxContactJoint::setContact ( const PxVec3 & contact )

pure virtual

Set the current contact of the joint.

◆ setContactNormal()

virtual void PxContactJoint::setContactNormal ( const PxVec3 & contactNormal )

pure virtual

Set the current contact normal of the joint.

◆ setPenetration()

virtual void PxContactJoint::setPenetration ( const PxReal penetration )

pure virtual

Set the current penetration of the joint.

◆ setResititution()

virtual void PxContactJoint::setResititution ( const PxReal resititution )

pure virtual

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

PxContactJoint.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PxContactJoint() [1/2]

◆ PxContactJoint() [2/2]

Member Function Documentation

◆ computeJacobians()

◆ getBounceThreshold()

◆ getConcreteTypeName()

◆ getContact()

◆ getContactNormal()

◆ getNbJacobianRows()

◆ getPenetration()

◆ getResititution()

◆ isKindOf()

◆ setBounceThreshold()

◆ setContact()

◆ setContactNormal()

◆ setPenetration()

◆ setResititution()