b2GearJoint Class Reference

#include <b2GearJoint.h>

Inheritance diagram for b2GearJoint:

List of all members.

Public Member Functions
void	Dump ()
	Dump joint to dmLog.
b2Vec2	GetAnchorA () const
	Get the anchor point on bodyA in world coordinates.
b2Vec2	GetAnchorB () const
	Get the anchor point on bodyB in world coordinates.
b2Joint *	GetJoint1 ()
	Get the first joint.
b2Joint *	GetJoint2 ()
	Get the second joint.
float32	GetRatio () const
b2Vec2	GetReactionForce (float32 inv_dt) const
	Get the reaction force on bodyB at the joint anchor in Newtons.
float32	GetReactionTorque (float32 inv_dt) const
	Get the reaction torque on bodyB in N*m.
void	SetRatio (float32 ratio)
	Set/Get the gear ratio.
Protected Member Functions
	b2GearJoint (const b2GearJointDef *data)
void	InitVelocityConstraints (const b2SolverData &data)
bool	SolvePositionConstraints (const b2SolverData &data)
void	SolveVelocityConstraints (const b2SolverData &data)
Protected Attributes
b2Body *	m_bodyC
b2Body *	m_bodyD
float32	m_constant
float32	m_iA
float32	m_iB
float32	m_iC
float32	m_iD
float32	m_impulse
int32	m_indexA
int32	m_indexB
int32	m_indexC
int32	m_indexD
b2Joint *	m_joint1
b2Joint *	m_joint2
b2Vec2	m_JvAC
b2Vec2	m_JvBD
float32	m_JwA
float32	m_JwB
float32	m_JwC
float32	m_JwD
b2Vec2	m_lcA
b2Vec2	m_lcB
b2Vec2	m_lcC
b2Vec2	m_lcD
b2Vec2	m_localAnchorA
b2Vec2	m_localAnchorB
b2Vec2	m_localAnchorC
b2Vec2	m_localAnchorD
b2Vec2	m_localAxisC
b2Vec2	m_localAxisD
float32	m_mA
float32	m_mass
float32	m_mB
float32	m_mC
float32	m_mD
float32	m_ratio
float32	m_referenceAngleA
float32	m_referenceAngleB
b2JointType	m_typeA
b2JointType	m_typeB
Friends
class	b2Joint

---

Detailed Description

A gear joint is used to connect two joints together. Either joint can be a revolute or prismatic joint. You specify a gear ratio to bind the motions together: coordinate1 + ratio * coordinate2 = constant The ratio can be negative or positive. If one joint is a revolute joint and the other joint is a prismatic joint, then the ratio will have units of length or units of 1/length.

Warning:

You have to manually destroy the gear joint if joint1 or joint2 is destroyed.

Definition at line 56 of file b2GearJoint.h.

---

Constructor & Destructor Documentation

b2GearJoint::b2GearJoint

(

const b2GearJointDef *

data

)

[protected]

Definition at line 44 of file b2GearJoint.cpp.

---

Member Function Documentation

void b2GearJoint::Dump

(

)

[virtual]

Dump joint to dmLog.

Reimplemented from b2Joint.

Definition at line 403 of file b2GearJoint.cpp.

b2Vec2 b2GearJoint::GetAnchorA

(

)

const [virtual]

Get the anchor point on bodyA in world coordinates.

Implements b2Joint.

Definition at line 370 of file b2GearJoint.cpp.

b2Vec2 b2GearJoint::GetAnchorB

(

)

const [virtual]

Get the anchor point on bodyB in world coordinates.

Implements b2Joint.

Definition at line 375 of file b2GearJoint.cpp.

b2Joint* b2GearJoint::GetJoint1

(

)

[inline]

Get the first joint.

Definition at line 66 of file b2GearJoint.h.

b2Joint* b2GearJoint::GetJoint2

(

)

[inline]

Get the second joint.

Definition at line 69 of file b2GearJoint.h.

float32 b2GearJoint::GetRatio

(

)

const

Definition at line 398 of file b2GearJoint.cpp.

b2Vec2 b2GearJoint::GetReactionForce

(

float32

inv_dt

)

const [virtual]

Get the reaction force on bodyB at the joint anchor in Newtons.

Implements b2Joint.

Definition at line 380 of file b2GearJoint.cpp.

float32 b2GearJoint::GetReactionTorque

(

float32

inv_dt

)

const [virtual]

Get the reaction torque on bodyB in N*m.

Implements b2Joint.

Definition at line 386 of file b2GearJoint.cpp.

void b2GearJoint::InitVelocityConstraints

(

const b2SolverData &

data

)

[protected, virtual]

Implements b2Joint.

Definition at line 131 of file b2GearJoint.cpp.

void b2GearJoint::SetRatio

(

float32

ratio

)

Set/Get the gear ratio.

Definition at line 392 of file b2GearJoint.cpp.

bool b2GearJoint::SolvePositionConstraints

(

const b2SolverData &

data

)

[protected, virtual]

Implements b2Joint.

Definition at line 271 of file b2GearJoint.cpp.

void b2GearJoint::SolveVelocityConstraints

(

const b2SolverData &

data

)

[protected, virtual]

Implements b2Joint.

Definition at line 235 of file b2GearJoint.cpp.

---

Friends And Related Function Documentation

friend class b2Joint [friend]

Definition at line 80 of file b2GearJoint.h.

---

Member Data Documentation

b2Body* b2GearJoint::m_bodyC [protected]

Definition at line 95 of file b2GearJoint.h.

b2Body* b2GearJoint::m_bodyD [protected]

Definition at line 96 of file b2GearJoint.h.

float32 b2GearJoint::m_constant [protected]

Definition at line 110 of file b2GearJoint.h.

float32 b2GearJoint::m_iA [protected]

Definition at line 119 of file b2GearJoint.h.

float32 b2GearJoint::m_iB [protected]

Definition at line 119 of file b2GearJoint.h.

float32 b2GearJoint::m_iC [protected]

Definition at line 119 of file b2GearJoint.h.

float32 b2GearJoint::m_iD [protected]

Definition at line 119 of file b2GearJoint.h.

float32 b2GearJoint::m_impulse [protected]

Definition at line 113 of file b2GearJoint.h.

int32 b2GearJoint::m_indexA [protected]

Definition at line 116 of file b2GearJoint.h.

int32 b2GearJoint::m_indexB [protected]

Definition at line 116 of file b2GearJoint.h.

int32 b2GearJoint::m_indexC [protected]

Definition at line 116 of file b2GearJoint.h.

int32 b2GearJoint::m_indexD [protected]

Definition at line 116 of file b2GearJoint.h.

b2Joint* b2GearJoint::m_joint1 [protected]

Definition at line 87 of file b2GearJoint.h.

b2Joint* b2GearJoint::m_joint2 [protected]

Definition at line 88 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_JvAC [protected]

Definition at line 120 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_JvBD [protected]

Definition at line 120 of file b2GearJoint.h.

float32 b2GearJoint::m_JwA [protected]

Definition at line 121 of file b2GearJoint.h.

float32 b2GearJoint::m_JwB [protected]

Definition at line 121 of file b2GearJoint.h.

float32 b2GearJoint::m_JwC [protected]

Definition at line 121 of file b2GearJoint.h.

float32 b2GearJoint::m_JwD [protected]

Definition at line 121 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_lcA [protected]

Definition at line 117 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_lcB [protected]

Definition at line 117 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_lcC [protected]

Definition at line 117 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_lcD [protected]

Definition at line 117 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_localAnchorA [protected]

Definition at line 99 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_localAnchorB [protected]

Definition at line 100 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_localAnchorC [protected]

Definition at line 101 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_localAnchorD [protected]

Definition at line 102 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_localAxisC [protected]

Definition at line 104 of file b2GearJoint.h.

b2Vec2 b2GearJoint::m_localAxisD [protected]

Definition at line 105 of file b2GearJoint.h.

float32 b2GearJoint::m_mA [protected]

Definition at line 118 of file b2GearJoint.h.

float32 b2GearJoint::m_mass [protected]

Definition at line 122 of file b2GearJoint.h.

float32 b2GearJoint::m_mB [protected]

Definition at line 118 of file b2GearJoint.h.

float32 b2GearJoint::m_mC [protected]

Definition at line 118 of file b2GearJoint.h.

float32 b2GearJoint::m_mD [protected]

Definition at line 118 of file b2GearJoint.h.

float32 b2GearJoint::m_ratio [protected]

Definition at line 111 of file b2GearJoint.h.

float32 b2GearJoint::m_referenceAngleA [protected]

Definition at line 107 of file b2GearJoint.h.

float32 b2GearJoint::m_referenceAngleB [protected]

Definition at line 108 of file b2GearJoint.h.

b2JointType b2GearJoint::m_typeA [protected]

Definition at line 90 of file b2GearJoint.h.

b2JointType b2GearJoint::m_typeB [protected]

Definition at line 91 of file b2GearJoint.h.

---

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

• b2GearJoint.h
• b2GearJoint.cpp