Class default

The Matter.Engine module contains methods for creating and manipulating engines. An engine is a controller that manages updating the simulation of the world. See Matter.Runner for an optional game loop utility.

See the included usage examples.

Hierarchy

  • default

Constructors

constructor

Properties

run

Methods

_bodiesApplyGravity _bodiesClearForces _bodiesUpdate _bodiesUpdateVelocities clear create merge update

Constructors

constructor

Properties

Static run

run: ((target, engine?) => IRunner) = Runner.run

Type declaration

Methods

Static Protected _bodiesApplyGravity

  • _bodiesApplyGravity(bodies, gravity): void

  • Applies gravitational acceleration to all bodies. This models a uniform gravitational field, similar to near the surface of a planet.

    Parameters

    Returns void

    Method

    _bodiesApplyGravity

Static Protected _bodiesClearForces

  • _bodiesClearForces(bodies): void

  • Zeroes the body.force and body.torque force buffers.

    Parameters

    Returns void

    Method

    _bodiesClearForces

Static Protected _bodiesUpdate

  • _bodiesUpdate(bodies, delta): void

  • Applies Body.update to all given bodies.

    Parameters

    • bodies: IBody[]
    • delta: number

      The amount of time elapsed between updates

    Returns void

    Method

    _bodiesUpdate

Static Protected _bodiesUpdateVelocities

  • _bodiesUpdateVelocities(bodies): void

  • Applies Body.updateVelocities to all given bodies.

    Parameters

    Returns void

    Method

    _bodiesUpdateVelocities

Static clear

Static create

  • Creates a new engine. The options parameter is an object that specifies any properties you wish to override the defaults. All properties have default values, and many are pre-calculated automatically based on other properties. See the properties section below for detailed information on what you can pass via the options object.

    Parameters

    Returns IEngine

    engine

    Method

    create

Static merge

  • Merges two engines by keeping the configuration of engineA but replacing the world with the one from engineB.

    Parameters

    Returns void

    Method

    merge

Static update

  • Moves the simulation forward in time by delta milliseconds. Triggers beforeUpdate, beforeSolve and afterUpdate events. Triggers collisionStart, collisionActive and collisionEnd events.

    Parameters

    • engine: IEngine
    • delta: number = Common._baseDelta

    Returns IEngine

    Method

    update

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc