Box2D: b2GearJoint Class Reference

Box2D

b2GearJoint Class Reference

A gear joint is used to connect two joints together. More...

Inheritance diagram for b2GearJoint:

b2Joint

List of all members.

Public Member Functions

b2Vec2 GetAnchor1 () const
 Get the anchor point on body1 in world coordinates.
b2Vec2 GetAnchor2 () const
 Get the anchor point on body2 in world coordinates.
b2Vec2 GetReactionForce () const
 Get the reaction force on body2 at the joint anchor.
float32 GetReactionTorque () const
 Get the reaction torque on body2.
float32 GetRatio () const
 Get the gear ratio.

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:
The revolute and prismatic joints must be attached to fixed bodies (which must be body1 on those joints).

The documentation for this class was generated from the following files:
  • b2GearJoint.h
  • b2GearJoint.cpp

Generated on Sun Apr 13 15:21:27 2008 for Box2D by  doxygen 1.5.4