Class RevoluteConstraint

Connects two bodies at given offset points, letting them rotate relative to each other around this point.

Example

// This will create a revolute constraint between two bodies with pivot point in between them.
    var bodyA = new Body({ mass: 1, position: [-1, 0] });
    world.addBody(bodyA);

    var bodyB = new Body({ mass: 1, position: [1, 0] });
    world.addBody(bodyB);

    var constraint = new RevoluteConstraint(bodyA, bodyB, {
        worldPivot: [0, 0]
    });
    world.addConstraint(constraint);

    // Using body-local pivot points, the constraint could have been constructed like this:
    var constraint = new RevoluteConstraint(bodyA, bodyB, {
        localPivotA: [1, 0],
        localPivotB: [-1, 0]
    });

Hierarchy

Constructors

constructor

Properties

angle bodyA bodyB collideConnected equations lowerLimit lowerLimitEnabled lowerLimitEquation maxForce motorEquation pivotA pivotB type upperLimit upperLimitEnabled upperLimitEquation DISTANCE GEAR LOCK OTHER PRISMATIC REVOLUTE

Accessors

motorEnabled motorMaxForce motorSpeed

Methods

disableMotor enableMotor getMotorSpeed motorIsEnabled setLimits setMaxBias setMotorSpeed setRelaxation setStiffness update

Constructors

constructor

Properties

angle

angle: number

The constraint position.

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

lowerLimit

lowerLimit: number

The lower limit on the constraint angle.

lowerLimitEnabled

lowerLimitEnabled: boolean

Set to true to enable lower limit

lowerLimitEquation

lowerLimitEquation: RotationalLockEquation

maxForce

maxForce: number

motorEquation

motorEquation: RotationalVelocityEquation

pivotA

pivotA: Vec2

pivotB

pivotB: Vec2

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.

upperLimit

upperLimit: number

The upper limit on the constraint angle.

upperLimitEnabled

upperLimitEnabled: boolean

Set to true to enable upper limit

upperLimitEquation

upperLimitEquation: RotationalLockEquation

Static DISTANCE

DISTANCE: 1 = ...

Static GEAR

GEAR: 2 = ...

Static LOCK

LOCK: 3 = ...

Static OTHER

OTHER: -1 = ...

Static PRISMATIC

PRISMATIC: 4 = ...

Static REVOLUTE

REVOLUTE: 5 = ...

Accessors

motorEnabled

  • get motorEnabled(): boolean

  • Returns boolean

  • set motorEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

motorMaxForce

  • get motorMaxForce(): number

  • Returns number

  • set motorMaxForce(value): void

  • Parameters

    • value: number

    Returns void

motorSpeed

  • get motorSpeed(): number

  • Returns number

  • set motorSpeed(value): void

  • Parameters

    • value: number

    Returns void

Methods

disableMotor

  • Disable the rotational motor

    Returns void

    Deprecated

    Use motorEnabled instead

enableMotor

  • Enable the rotational motor

    Returns void

    Deprecated

    Use motorEnabled instead

getMotorSpeed

  • Get the speed of the rotational constraint motor

    Returns number

    Deprecated

    Use .motorSpeed instead

motorIsEnabled

  • Check if the motor is enabled.

    Returns boolean

    Deprecated

    Use motorEnabled instead

setLimits

  • Set the constraint angle limits, and enable them.

    Parameters

    • lower: number

      the lower limit

    • upper: number

      the upper limit

    Returns void

setMaxBias

  • Set max bias for this constraint.

    Parameters

    • maxBias: number

    Returns void

setMotorSpeed

  • Set the speed of the rotational constraint motor

    Parameters

    • speed: number

    Returns void

    Deprecated

    Use .motorSpeed instead

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