physx::PxContactJoint Class Reference

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 physx::PxContactJoint:

Collaboration diagram for physx::PxContactJoint:

Public Member Functions
virtual void	setContact (const PxVec3 &contact)=0
	Set the current contact of the joint.
virtual void	setContactNormal (const PxVec3 &contactNormal)=0
	Set the current contact normal of the joint.
virtual void	setPenetration (const PxReal penetration)=0
	Set the current penetration of the joint.
virtual PxVec3	getContact () const =0
	Return the current contact of the joint.
virtual PxVec3	getContactNormal () const =0
	Return the current contact normal of the joint.
virtual PxReal	getPenetration () const =0
	Return the current penetration value of the joint.
virtual PxReal	getRestitution () const =0
virtual void	setRestitution (const PxReal restitution)=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.
virtual void	computeJacobians (PxJacobianRow *jacobian) const =0
virtual PxU32	getNbJacobianRows () const =0
Public Member Functions inherited from physx::PxJoint
virtual void	setActors (PxRigidActor *actor0, PxRigidActor *actor1)=0
	Set the actors for this joint.
virtual void	getActors (PxRigidActor *&actor0, PxRigidActor *&actor1) const =0
	Get the actors for this joint.
virtual void	setLocalPose (PxJointActorIndex::Enum actor, const PxTransform &localPose)=0
	Set the joint local pose for an actor.
virtual PxTransform	getLocalPose (PxJointActorIndex::Enum actor) const =0
	get the joint local pose for an actor.
virtual PxTransform	getRelativeTransform () const =0
	get the relative pose for this joint
virtual PxVec3	getRelativeLinearVelocity () const =0
	get the relative linear velocity of the joint
virtual PxVec3	getRelativeAngularVelocity () const =0
	get the relative angular velocity of the joint
virtual void	setBreakForce (PxReal force, PxReal torque)=0
	set the break force for this joint.
virtual void	getBreakForce (PxReal &force, PxReal &torque) const =0
	get the break force for this joint.
virtual void	setConstraintFlags (PxConstraintFlags flags)=0
	set the constraint flags for this joint.
virtual void	setConstraintFlag (PxConstraintFlag::Enum flag, bool value)=0
	set a constraint flags for this joint to a specified value.
virtual PxConstraintFlags	getConstraintFlags () const =0
	get the constraint flags for this joint.
virtual void	setInvMassScale0 (PxReal invMassScale)=0
	set the inverse mass scale for actor0.
virtual PxReal	getInvMassScale0 () const =0
	get the inverse mass scale for actor0.
virtual void	setInvInertiaScale0 (PxReal invInertiaScale)=0
	set the inverse inertia scale for actor0.
virtual PxReal	getInvInertiaScale0 () const =0
	get the inverse inertia scale for actor0.
virtual void	setInvMassScale1 (PxReal invMassScale)=0
	set the inverse mass scale for actor1.
virtual PxReal	getInvMassScale1 () const =0
	get the inverse mass scale for actor1.
virtual void	setInvInertiaScale1 (PxReal invInertiaScale)=0
	set the inverse inertia scale for actor1.
virtual PxReal	getInvInertiaScale1 () const =0
	get the inverse inertia scale for actor1.
virtual PxConstraint *	getConstraint () const =0
	Retrieves the PxConstraint corresponding to this joint.
virtual void	setName (const char *name)=0
	Sets a name string for the object that can be retrieved with getName().
virtual const char *	getName () const =0
	Retrieves the name string set with setName().
virtual void	release ()=0
	Deletes the joint.
virtual PxScene *	getScene () const =0
	Retrieves the scene which this joint belongs to.
Public Member Functions inherited from physx::PxBase
template<class T >
T *	is ()
template<class T >
const T *	is () const
PX_FORCE_INLINE PxType	getConcreteType () const
	Returns concrete type of object.
PX_FORCE_INLINE void	setBaseFlag (PxBaseFlag::Enum flag, bool value)
	Set PxBaseFlag
PX_FORCE_INLINE void	setBaseFlags (PxBaseFlags inFlags)
	Set PxBaseFlags
PX_FORCE_INLINE PxBaseFlags	getBaseFlags () const
	Returns PxBaseFlags.
virtual bool	isReleasable () const
	Whether the object is subordinate.

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

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

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

Member Function Documentation

getConcreteTypeName()

virtual const char * physx::PxContactJoint::getConcreteTypeName ( ) const

inlinevirtual

Returns string name of PxContactJoint, used for serialization.

Implements physx::PxBase.

isKindOf()

virtual bool physx::PxContactJoint::isKindOf ( const char *  name ) const

inlineprotectedvirtual

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

Reimplemented from physx::PxJoint.

---

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

• RavEngine/deps/physx/physx/include/extensions/PxContactJoint.h