Class LinearSpring

A spring, connecting two bodies.

The Spring explicitly adds force and angularForce to the bodies.

Example

var spring = new LinearSpring(bodyA, bodyB, {
        stiffness: 100,
        damping: 1,
        localAnchorA: [0,0], // center of bodyA
        localAnchorB: [0,0] // center of bodyB
    });
    world.addSpring(spring);

Hierarchy

Constructors

constructor

Properties

bodyA bodyB damping localAnchorA localAnchorB restLength stiffness

Methods

applyForce getWorldAnchorA getWorldAnchorB setWorldAnchorA setWorldAnchorB

Constructors

constructor

Properties

bodyA

bodyA: Body

First connected body.

bodyB

bodyB: Body

Second connected body.

damping

damping: number

Damping of the spring.

localAnchorA

localAnchorA: Vec2

Anchor for bodyA in local bodyA coordinates.

localAnchorB

localAnchorB: Vec2

Anchor for bodyB in local bodyB coordinates.

restLength

restLength: number

Rest length of the spring. Can be set dynamically.

stiffness

stiffness: number

Stiffness of the spring.

Methods

applyForce

  • Apply the spring force to the connected bodies

    Returns void

getWorldAnchorA

  • Get the anchor point on body A, in world coordinates.

    Parameters

    Returns void

getWorldAnchorB

  • Set the anchor point on body B, using world coordinates.

    Parameters

    Returns void

setWorldAnchorA

  • Set the anchor point on body A, using world coordinates.

    Parameters

    • worldAnchorA: Vec2

    Returns void

setWorldAnchorB

  • Set the anchor point on body B, using world coordinates.

    Parameters

    • worldAnchorB: Vec2

    Returns void

Settings

Member Visibility

Theme

On This Page