Class StdSystemClock

The SystemClock that gives real time and schedules callbacks. As opposed to the test/MockClock.MockClock that is used for testing.

Implements

SystemClock

Index

Methods

cancelAnimFrame cancelCallback requestAnimFrame scheduleCallback systemTime

Methods

cancelAnimFrame

cancelAnimFrame(requestID): void
cancels a request made with requestAnimFrame.
Parameters
- requestID: number
  the request ID
Returns void
Implementation of SystemClock.cancelAnimFrame
- Defined in lab/util/Clock.ts:83

cancelCallback

cancelCallback(timeoutID): void
cancels a pending scheduled callback.
Parameters
- timeoutID: number
  the ID of the scheduled callback
Returns void
Implementation of SystemClock.cancelCallback
- Defined in lab/util/Clock.ts:68

requestAnimFrame

requestAnimFrame(callback): number
requests that the callback be executed before the next repaint.
Parameters
- callback: (() => void)
  the function to be called
  - - (): void
    - Returns void
Returns number
the request ID
Implementation of SystemClock.requestAnimFrame
- Defined in lab/util/Clock.ts:78

scheduleCallback

scheduleCallback(callback, delay_ms): number
schedules a callback to be executed in the future.
Parameters
- callback: (() => void)
  the function to be called
  - - (): void
    - Returns void
- delay_ms: number
  number of milliseconds to wait before executing the callback
Returns number
the ID of the callback
Implementation of SystemClock.scheduleCallback
- Defined in lab/util/Clock.ts:73

systemTime

systemTime(): number
Returns the current time as given by the system clock, in seconds.

Returns number
the current time as given by the system clock, in seconds
Implementation of SystemClock.systemTime
- Defined in lab/util/Clock.ts:63

Generated using TypeDoc