#include <b2_gear_joint.h>

Inheritance diagram for b2GearJoint:

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

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

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

b2Joint *	GetJoint1 ()
	Get the first joint. More...

b2Joint *	GetJoint2 ()
	Get the second joint. More...

float	GetRatio () const

b2Vec2	GetReactionForce (float inv_dt) const override
	Get the reaction force on bodyB at the joint anchor in Newtons. More...

float	GetReactionTorque (float inv_dt) const override
	Get the reaction torque on bodyB in N*m. More...

void	SetRatio (float ratio)
	Set/Get the gear ratio. More...

Public Member Functions inherited from b2Joint
virtual void	Draw (b2Draw *draw) const
	Debug draw this joint. More...

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...

b2JointUserData &	GetUserData ()
	Get the user data pointer. More...

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

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

Protected Member Functions
	b2GearJoint (const b2GearJointDef *data)

void	InitVelocityConstraints (const b2SolverData &data) override

bool	SolvePositionConstraints (const b2SolverData &data) override

void	SolveVelocityConstraints (const b2SolverData &data) override

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

virtual	~b2Joint ()

Protected Attributes
b2Body *	m_bodyC

b2Body *	m_bodyD

float	m_constant

float	m_iA

float	m_iB

float	m_iC

float	m_iD

float	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

float	m_JwA

float	m_JwB

float	m_JwC

float	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

float	m_mA

float	m_mass

float	m_mB

float	m_mC

float	m_mD

float	m_ratio

float	m_referenceAngleA

float	m_referenceAngleB

b2JointType	m_typeA

b2JointType	m_typeB

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

b2JointUserData	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 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 61 of file b2_gear_joint.h.

Constructor & Destructor Documentation

◆ b2GearJoint()

b2GearJoint::b2GearJoint ( const b2GearJointDef * data )

protected

Definition at line 48 of file b2_gear_joint.cpp.

Member Function Documentation

◆ Dump()

void b2GearJoint::Dump ( )

overridevirtual

Dump joint to dmLog.

Reimplemented from b2Joint.

Definition at line 413 of file b2_gear_joint.cpp.

◆ GetAnchorA()

b2Vec2 b2GearJoint::GetAnchorA ( ) const

overridevirtual

Get the anchor point on bodyA in world coordinates.

Implements b2Joint.

Definition at line 380 of file b2_gear_joint.cpp.

◆ GetAnchorB()

b2Vec2 b2GearJoint::GetAnchorB ( ) const

overridevirtual

Get the anchor point on bodyB in world coordinates.

Implements b2Joint.

Definition at line 385 of file b2_gear_joint.cpp.

◆ GetJoint1()

b2Joint* b2GearJoint::GetJoint1 ( )

inline

Get the first joint.

Definition at line 71 of file b2_gear_joint.h.

◆ GetJoint2()

b2Joint* b2GearJoint::GetJoint2 ( )

inline

Get the second joint.

Definition at line 74 of file b2_gear_joint.h.

◆ GetRatio()

float b2GearJoint::GetRatio ( ) const

Definition at line 408 of file b2_gear_joint.cpp.

◆ GetReactionForce()

b2Vec2 b2GearJoint::GetReactionForce ( float inv_dt ) const

overridevirtual

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

Implements b2Joint.

Definition at line 390 of file b2_gear_joint.cpp.

◆ GetReactionTorque()

float b2GearJoint::GetReactionTorque ( float inv_dt ) const

overridevirtual

Get the reaction torque on bodyB in N*m.

Implements b2Joint.

Definition at line 396 of file b2_gear_joint.cpp.

◆ InitVelocityConstraints()

void b2GearJoint::InitVelocityConstraints ( const b2SolverData & data )

overrideprotectedvirtual

Implements b2Joint.

Definition at line 141 of file b2_gear_joint.cpp.

◆ SetRatio()

void b2GearJoint::SetRatio ( float ratio )

Set/Get the gear ratio.

Definition at line 402 of file b2_gear_joint.cpp.

◆ SolvePositionConstraints()

bool b2GearJoint::SolvePositionConstraints ( const b2SolverData & data )

overrideprotectedvirtual

Implements b2Joint.

Definition at line 281 of file b2_gear_joint.cpp.

◆ SolveVelocityConstraints()

void b2GearJoint::SolveVelocityConstraints ( const b2SolverData & data )

overrideprotectedvirtual

Implements b2Joint.

Definition at line 245 of file b2_gear_joint.cpp.

Friends And Related Function Documentation

◆ b2Joint

friend class b2Joint

friend

Definition at line 85 of file b2_gear_joint.h.

Member Data Documentation

◆ m_bodyC

b2Body* b2GearJoint::m_bodyC

protected

Definition at line 100 of file b2_gear_joint.h.

◆ m_bodyD

b2Body* b2GearJoint::m_bodyD

protected

Definition at line 101 of file b2_gear_joint.h.

◆ m_constant

float b2GearJoint::m_constant

protected

Definition at line 115 of file b2_gear_joint.h.

◆ m_iA

float b2GearJoint::m_iA

protected

Definition at line 124 of file b2_gear_joint.h.

◆ m_iB

float b2GearJoint::m_iB

protected

Definition at line 124 of file b2_gear_joint.h.

◆ m_iC

float b2GearJoint::m_iC

protected

Definition at line 124 of file b2_gear_joint.h.

◆ m_iD

float b2GearJoint::m_iD

protected

Definition at line 124 of file b2_gear_joint.h.

◆ m_impulse

float b2GearJoint::m_impulse

protected

Definition at line 118 of file b2_gear_joint.h.

◆ m_indexA

int32 b2GearJoint::m_indexA

protected

Definition at line 121 of file b2_gear_joint.h.

◆ m_indexB

int32 b2GearJoint::m_indexB

protected

Definition at line 121 of file b2_gear_joint.h.

◆ m_indexC

int32 b2GearJoint::m_indexC

protected

Definition at line 121 of file b2_gear_joint.h.

◆ m_indexD

int32 b2GearJoint::m_indexD

protected

Definition at line 121 of file b2_gear_joint.h.

◆ m_joint1

b2Joint* b2GearJoint::m_joint1

protected

Definition at line 92 of file b2_gear_joint.h.

◆ m_joint2

b2Joint* b2GearJoint::m_joint2

protected

Definition at line 93 of file b2_gear_joint.h.

◆ m_JvAC

b2Vec2 b2GearJoint::m_JvAC

protected

Definition at line 125 of file b2_gear_joint.h.

◆ m_JvBD

b2Vec2 b2GearJoint::m_JvBD

protected

Definition at line 125 of file b2_gear_joint.h.

◆ m_JwA

float b2GearJoint::m_JwA

protected

Definition at line 126 of file b2_gear_joint.h.

◆ m_JwB

float b2GearJoint::m_JwB

protected

Definition at line 126 of file b2_gear_joint.h.

◆ m_JwC

float b2GearJoint::m_JwC

protected

Definition at line 126 of file b2_gear_joint.h.

◆ m_JwD

float b2GearJoint::m_JwD

protected

Definition at line 126 of file b2_gear_joint.h.

◆ m_lcA

b2Vec2 b2GearJoint::m_lcA

protected

Definition at line 122 of file b2_gear_joint.h.

◆ m_lcB

b2Vec2 b2GearJoint::m_lcB

protected

Definition at line 122 of file b2_gear_joint.h.

◆ m_lcC

b2Vec2 b2GearJoint::m_lcC

protected

Definition at line 122 of file b2_gear_joint.h.

◆ m_lcD

b2Vec2 b2GearJoint::m_lcD

protected

Definition at line 122 of file b2_gear_joint.h.

◆ m_localAnchorA

b2Vec2 b2GearJoint::m_localAnchorA

protected

Definition at line 104 of file b2_gear_joint.h.

◆ m_localAnchorB

b2Vec2 b2GearJoint::m_localAnchorB

protected

Definition at line 105 of file b2_gear_joint.h.

◆ m_localAnchorC

b2Vec2 b2GearJoint::m_localAnchorC

protected

Definition at line 106 of file b2_gear_joint.h.

◆ m_localAnchorD

b2Vec2 b2GearJoint::m_localAnchorD

protected

Definition at line 107 of file b2_gear_joint.h.

◆ m_localAxisC

b2Vec2 b2GearJoint::m_localAxisC

protected

Definition at line 109 of file b2_gear_joint.h.

◆ m_localAxisD

b2Vec2 b2GearJoint::m_localAxisD

protected

Definition at line 110 of file b2_gear_joint.h.

◆ m_mA

float b2GearJoint::m_mA

protected

Definition at line 123 of file b2_gear_joint.h.

◆ m_mass

float b2GearJoint::m_mass

protected

Definition at line 127 of file b2_gear_joint.h.

◆ m_mB

float b2GearJoint::m_mB

protected

Definition at line 123 of file b2_gear_joint.h.

◆ m_mC

float b2GearJoint::m_mC

protected

Definition at line 123 of file b2_gear_joint.h.

◆ m_mD

float b2GearJoint::m_mD

protected

Definition at line 123 of file b2_gear_joint.h.

◆ m_ratio

float b2GearJoint::m_ratio

protected

Definition at line 116 of file b2_gear_joint.h.

◆ m_referenceAngleA

float b2GearJoint::m_referenceAngleA

protected

Definition at line 112 of file b2_gear_joint.h.

◆ m_referenceAngleB

float b2GearJoint::m_referenceAngleB

protected

Definition at line 113 of file b2_gear_joint.h.

◆ m_typeA

b2JointType b2GearJoint::m_typeA

protected

Definition at line 95 of file b2_gear_joint.h.

◆ m_typeB

b2JointType b2GearJoint::m_typeB

protected

Definition at line 96 of file b2_gear_joint.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

◆ b2GearJoint()

Member Function Documentation

◆ Dump()

◆ GetAnchorA()

◆ GetAnchorB()

◆ GetJoint1()

◆ GetJoint2()

◆ GetRatio()

◆ GetReactionForce()

◆ GetReactionTorque()

◆ InitVelocityConstraints()

◆ SetRatio()

◆ SolvePositionConstraints()

◆ SolveVelocityConstraints()

Friends And Related Function Documentation

◆ b2Joint

Member Data Documentation

◆ m_bodyC

◆ m_bodyD

◆ m_constant

◆ m_iA

◆ m_iB

◆ m_iC

◆ m_iD

◆ m_impulse

◆ m_indexA

◆ m_indexB

◆ m_indexC

◆ m_indexD

◆ m_joint1

◆ m_joint2

◆ m_JvAC

◆ m_JvBD

◆ m_JwA

◆ m_JwB

◆ m_JwC

◆ m_JwD

◆ m_lcA

◆ m_lcB

◆ m_lcC

◆ m_lcD

◆ m_localAnchorA

◆ m_localAnchorB

◆ m_localAnchorC

◆ m_localAnchorD

◆ m_localAxisC

◆ m_localAxisD

◆ m_mA

◆ m_mass

◆ m_mB

◆ m_mC

◆ m_mD

◆ m_ratio

◆ m_referenceAngleA

◆ m_referenceAngleB

◆ m_typeA

◆ m_typeB