API Docs for: 0.7.1
Show:

GearConstraint Class

Extends Constraint
Defined in: src/constraints/GearConstraint.js:8

Constrains the angle of two bodies to each other to be equal. If a gear ratio is not one, the angle of bodyA must be a multiple of the angle of bodyB.

Constructor

GearConstraint

(
  • bodyA
  • bodyB
  • [options]
)

Defined in src/constraints/GearConstraint.js:8

Parameters:

  • bodyA Body
  • bodyB Body
  • [options] Object optional
    • [angle=0] Number optional

      Relative angle between the bodies. Will be set to the current angle between the bodies (the gear ratio is accounted for).

    • [ratio=1] Number optional

      Gear ratio.

    • [maxTorque] Number optional

      Maximum torque to apply.

Example:

var constraint = new GearConstraint(bodyA, bodyB);
        world.addConstraint(constraint);
        
var constraint = new GearConstraint(bodyA, bodyB, {
            ratio: 2,
            maxTorque: 1000
        });
        world.addConstraint(constraint);

Methods

getMaxTorque

() Number

Defined in src/constraints/GearConstraint.js:84

Get the max torque for the constraint.

Returns:

Number:

setMaxTorque

(
  • torque
)

Defined in src/constraints/GearConstraint.js:75

Set the max torque for the constraint.

Parameters:

  • torque Number

setRelaxation

(
  • relaxation
)

Inherited from Constraint: src/constraints/Constraint.js:123

Set relaxation for this constraint.

Parameters:

  • relaxation Number

setStiffness

(
  • stiffness
)

Inherited from Constraint: src/constraints/Constraint.js:109

Set stiffness for this constraint.

Parameters:

  • stiffness Number

update

()

Inherited from Constraint: src/constraints/Constraint.js:71

Updates the internal constraint parameters before solve.

Properties

angle

Number

Defined in src/constraints/GearConstraint.js:44

The relative angle

bodyA

Body

Inherited from Constraint: src/constraints/Constraint.js:38

First body participating in the constraint.

bodyB

Body

Inherited from Constraint: src/constraints/Constraint.js:45

Second body participating in the constraint.

collideConnected

Boolean

Inherited from Constraint: src/constraints/Constraint.js:52

Set to true if you want the connected bodies to collide.

Default: true

equations

Array

Inherited from Constraint: src/constraints/Constraint.js:30

Equations to be solved in this constraint

ratio

Number

Defined in src/constraints/GearConstraint.js:37

The gear ratio.

type

Number

Inherited from Constraint: src/constraints/Constraint.js:19

The type of constraint. May be one of Constraint.DISTANCE, Constraint.GEAR, Constraint.LOCK, Constraint.PRISMATIC or Constraint.REVOLUTE.