#include <b2DistanceJoint.h>

Inheritance diagram for b2DistanceJoint:

Public Member Functions
void	Dump ()
	Dump joint to dmLog. More...

b2Vec2	GetAnchorA () const
	Get the anchor point on bodyA in world coordinates. More...

b2Vec2	GetAnchorB () const
	Get the anchor point on bodyB in world coordinates. More...

float32	GetDampingRatio () const

float32	GetFrequency () const

float32	GetLength () const

const b2Vec2 &	GetLocalAnchorA () const
	The local anchor point relative to bodyA's origin. More...

const b2Vec2 &	GetLocalAnchorB () const
	The local anchor point relative to bodyB's origin. More...

b2Vec2	GetReactionForce (float32 inv_dt) const

float32	GetReactionTorque (float32 inv_dt) const

void	SetDampingRatio (float32 ratio)
	Set/get damping ratio. More...

void	SetFrequency (float32 hz)
	Set/get frequency in Hz. More...

void	SetLength (float32 length)

Public Member Functions inherited from b2Joint
b2Body *	GetBodyA ()
	Get the first body attached to this joint. More...

b2Body *	GetBodyB ()
	Get the second body attached to this joint. More...

bool	GetCollideConnected () const

b2Joint *	GetNext ()
	Get the next joint the world joint list. More...

const b2Joint *	GetNext () const

b2JointType	GetType () const
	Get the type of the concrete joint. More...

void *	GetUserData () const
	Get the user data pointer. More...

bool	IsActive () const
	Short-cut function to determine if either body is inactive. More...

void	SetUserData (void *data)
	Set the user data pointer. More...

virtual void	ShiftOrigin (const b2Vec2 &newOrigin)
	Shift the origin for any points stored in world coordinates. More...

Protected Member Functions
	b2DistanceJoint (const b2DistanceJointDef *data)

void	InitVelocityConstraints (const b2SolverData &data)

bool	SolvePositionConstraints (const b2SolverData &data)

void	SolveVelocityConstraints (const b2SolverData &data)

Protected Member Functions inherited from b2Joint
	b2Joint (const b2JointDef *def)

virtual	~b2Joint ()

Protected Attributes
float32	m_bias

float32	m_dampingRatio

float32	m_frequencyHz

float32	m_gamma

float32	m_impulse

int32	m_indexA

int32	m_indexB

float32	m_invIA

float32	m_invIB

float32	m_invMassA

float32	m_invMassB

float32	m_length

b2Vec2	m_localAnchorA

b2Vec2	m_localAnchorB

b2Vec2	m_localCenterA

b2Vec2	m_localCenterB

float32	m_mass

b2Vec2	m_rA

b2Vec2	m_rB

b2Vec2	m_u

Protected Attributes inherited from b2Joint
b2Body *	m_bodyA

b2Body *	m_bodyB

bool	m_collideConnected

b2JointEdge	m_edgeA

b2JointEdge	m_edgeB

int32	m_index

bool	m_islandFlag

b2Joint *	m_next

b2Joint *	m_prev

b2JointType	m_type

void *	m_userData

Friends
class	b2Joint

Additional Inherited Members
Static Protected Member Functions inherited from b2Joint
static b2Joint *	Create (const b2JointDef def, b2BlockAllocator allocator)

static void	Destroy (b2Joint joint, b2BlockAllocator allocator)

Detailed Description

A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a massless, rigid rod.

Definition at line 67 of file b2DistanceJoint.h.

Constructor & Destructor Documentation

b2DistanceJoint::b2DistanceJoint ( const b2DistanceJointDef * data )

protected

Definition at line 49 of file b2DistanceJoint.cpp.

Member Function Documentation

void b2DistanceJoint::Dump ( )

virtual

Dump joint to dmLog.

Reimplemented from b2Joint.

Definition at line 245 of file b2DistanceJoint.cpp.

b2Vec2 b2DistanceJoint::GetAnchorA ( ) const

virtual

Get the anchor point on bodyA in world coordinates.

Implements b2Joint.

Definition at line 223 of file b2DistanceJoint.cpp.

b2Vec2 b2DistanceJoint::GetAnchorB ( ) const

virtual

Get the anchor point on bodyB in world coordinates.

Implements b2Joint.

Definition at line 228 of file b2DistanceJoint.cpp.

float32 b2DistanceJoint::GetDampingRatio ( ) const

inline

Definition at line 164 of file b2DistanceJoint.h.

float32 b2DistanceJoint::GetFrequency ( ) const

inline

Definition at line 154 of file b2DistanceJoint.h.

float32 b2DistanceJoint::GetLength ( ) const

inline

Definition at line 144 of file b2DistanceJoint.h.

const b2Vec2& b2DistanceJoint::GetLocalAnchorA ( ) const

inline

The local anchor point relative to bodyA's origin.

Definition at line 83 of file b2DistanceJoint.h.

const b2Vec2& b2DistanceJoint::GetLocalAnchorB ( ) const

inline

The local anchor point relative to bodyB's origin.

Definition at line 86 of file b2DistanceJoint.h.

b2Vec2 b2DistanceJoint::GetReactionForce ( float32 inv_dt ) const

virtual

Get the reaction force given the inverse time step. Unit is N.

Implements b2Joint.

Definition at line 233 of file b2DistanceJoint.cpp.

float32 b2DistanceJoint::GetReactionTorque ( float32 inv_dt ) const

virtual

Get the reaction torque given the inverse time step. Unit is N*m. This is always zero for a distance joint.

Implements b2Joint.

Definition at line 239 of file b2DistanceJoint.cpp.

void b2DistanceJoint::InitVelocityConstraints ( const b2SolverData & data )

protectedvirtual

Implements b2Joint.

Definition at line 62 of file b2DistanceJoint.cpp.

void b2DistanceJoint::SetDampingRatio ( float32 ratio )

inline

Set/get damping ratio.

Definition at line 159 of file b2DistanceJoint.h.

void b2DistanceJoint::SetFrequency ( float32 hz )

inline

Set/get frequency in Hz.

Definition at line 149 of file b2DistanceJoint.h.

void b2DistanceJoint::SetLength ( float32 length )

inline

Set/get the natural length. Manipulating the length can lead to non-physical behavior when the frequency is zero.

Definition at line 139 of file b2DistanceJoint.h.

bool b2DistanceJoint::SolvePositionConstraints ( const b2SolverData & data )

protectedvirtual

Implements b2Joint.

Definition at line 184 of file b2DistanceJoint.cpp.

void b2DistanceJoint::SolveVelocityConstraints ( const b2SolverData & data )

protectedvirtual

Implements b2Joint.

Definition at line 157 of file b2DistanceJoint.cpp.

Friends And Related Function Documentation

friend class b2Joint

friend

Definition at line 106 of file b2DistanceJoint.h.

Member Data Documentation

float32 b2DistanceJoint::m_bias

protected

Definition at line 115 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_dampingRatio

protected

Definition at line 114 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_frequencyHz

protected

Definition at line 113 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_gamma

protected

Definition at line 120 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_impulse

protected

Definition at line 121 of file b2DistanceJoint.h.

int32 b2DistanceJoint::m_indexA

protected

Definition at line 125 of file b2DistanceJoint.h.

int32 b2DistanceJoint::m_indexB

protected

Definition at line 126 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_invIA

protected

Definition at line 134 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_invIB

protected

Definition at line 135 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_invMassA

protected

Definition at line 132 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_invMassB

protected

Definition at line 133 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_length

protected

Definition at line 122 of file b2DistanceJoint.h.

b2Vec2 b2DistanceJoint::m_localAnchorA

protected

Definition at line 118 of file b2DistanceJoint.h.

b2Vec2 b2DistanceJoint::m_localAnchorB

protected

Definition at line 119 of file b2DistanceJoint.h.

b2Vec2 b2DistanceJoint::m_localCenterA

protected

Definition at line 130 of file b2DistanceJoint.h.

b2Vec2 b2DistanceJoint::m_localCenterB

protected

Definition at line 131 of file b2DistanceJoint.h.

float32 b2DistanceJoint::m_mass

protected

Definition at line 136 of file b2DistanceJoint.h.

b2Vec2 b2DistanceJoint::m_rA

protected

Definition at line 128 of file b2DistanceJoint.h.

b2Vec2 b2DistanceJoint::m_rB

protected

Definition at line 129 of file b2DistanceJoint.h.

b2Vec2 b2DistanceJoint::m_u

protected

Definition at line 127 of file b2DistanceJoint.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation