Class GearConstraint

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.

Example

var constraint = new GearConstraint(bodyA, bodyB);
    world.addConstraint(constraint);

Example

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

Hierarchy

Constructors

constructor

Properties

angle bodyA bodyB collideConnected equations ratio type DISTANCE GEAR LOCK OTHER PRISMATIC REVOLUTE

Methods

getMaxTorque setMaxBias setMaxTorque setRelaxation setStiffness update

Constructors

constructor

Properties

angle

angle: number

bodyA

bodyA: Body

First body participating in the constraint.

bodyB

bodyB: Body

Second body participating in the constraint.

collideConnected

collideConnected: boolean

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

Default

true

equations

equations: Equation[]

Equations to be solved in this constraint

ratio

ratio: number

type

type: 2 | 1 | -1 | 3 | 4 | 5

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

Static DISTANCE

DISTANCE: 1 = 1

Static GEAR

GEAR: 2 = 2

Static LOCK

LOCK: 3 = 3

Static OTHER

OTHER: -1 = -1

Static PRISMATIC

PRISMATIC: 4 = 4

Static REVOLUTE

REVOLUTE: 5 = 5

Methods

getMaxTorque

  • Get the max torque for the constraint.

    Returns number

setMaxBias

  • Set max bias for this constraint.

    Parameters

    • maxBias: number

    Returns void

setMaxTorque

  • Set the max torque for the constraint.

    Parameters

    • torque: number

    Returns void

setRelaxation

  • Set relaxation for this constraint.

    Parameters

    • relaxation: number

    Returns void

setStiffness

  • Set stiffness for this constraint.

    Parameters

    • stiffness: number

    Returns void

update

  • Updates the internal constraint parameters before solve.

    Returns void

Settings

Member Visibility

Theme

On This Page