clock-clock-clock

The clock used in Three.js, except as a standalone.

Getting Started

Installation

yarn add clock-clock-clock

Usage

import Clock from "clock-clock-clock";

Clock

Object for keeping track of time. This uses performance.now()if it is available, otherwise it reverts to the less accurate Date.now().

Constructor Clock( autoStart : Boolean ) autoStart — (optional) whether to automatically start the clock. Default is true.

Properties

.autoStart : Boolean

If set, starts the clock automatically when the first update is called. Default is true.

.startTime : Float

Holds the time at which the clock's start method was last called.

.oldTime : Float

Holds the time at which the clock's start, getElapsedTime or getDelta methods were last called.

.elapsedTime : Float

Keeps track of the total time that the clock has been running.

.running : Boolean

Whether the clock is running or not.

Methods

.start() : null

Starts clock. Also sets the startTime and oldTime to the current time, sets elapsedTime to 0 and running to true.

.stop() : null

Stops clock and sets oldTime to the current time.

.getElapsedTime() : Float

Get the seconds passed since the clock started and sets oldTime to the current time. If autoStart is true and the clock is not running, also starts the clock.

.getDelta() : Float

Get the seconds passed since the time oldTime was set and sets oldTime to the current time. If autoStart is true and the clock is not running, also starts the clock.

Authors

• Original Author — alteredq
• Version/Repo Maintainer — John Mars

License

MIT © Three.js Authors