@three-tile/lib
    Preparing search index...

    Class Timer

    This class is an alternative to Clock with a different API design and behavior. The goal is to avoid the conceptual flaws that became apparent in Clock over time.

    • Timer has an update() method that updates its internal state. That makes it possible to call getDelta() and getElapsed() multiple times per simulation step without getting different values.
    • The class can make use of the Page Visibility API to avoid large time delta values when the app is inactive (e.g. tab switched or browser hidden).
    const timer = new Timer();
    timer.connect( document ); // use Page Visibility API
    Index

    Constructors

    Methods

    • Connect the timer to the given document.Calling this method is not mandatory to use the timer but enables the usage of the Page Visibility API to avoid large time delta values.

      Parameters

      • document: Document

        The document.

      Returns void

    • Disconnects the timer from the DOM and also disables the usage of the Page Visibility API.

      Returns void

    • Can be used to free all internal resources. Usually called when the timer instance isn't required anymore.

      Returns void

    • Returns the time delta in seconds.

      Returns number

      The time delta in second.

    • Returns the elapsed time in seconds.

      Returns number

      The elapsed time in second.

    • Returns the timescale.

      Returns number

      The timescale.

    • Resets the time computation for the current simulation step.

      Returns this

      A reference to this timer.

    • Sets the given timescale which scale the time delta computation in update().

      Parameters

      • timescale: number

        The timescale to set.

      Returns this

      A reference to this timer.

    • Updates the internal state of the timer. This method should be called once per simulation step and before you perform queries against the timer (e.g. via getDelta()).

      Parameters

      • Optionaltimestamp: number

        The current time in milliseconds. Can be obtained from the requestAnimationFrame callback argument. If not provided, the current time will be determined with performance.now.

      Returns this

      A reference to this timer.