import { Observable } from "../Misc/observable.js"; /** * The current state of the timer */ export var TimerState; (function (TimerState) { /** * Timer initialized, not yet started */ TimerState[TimerState["INIT"] = 0] = "INIT"; /** * Timer started and counting */ TimerState[TimerState["STARTED"] = 1] = "STARTED"; /** * Timer ended (whether aborted or time reached) */ TimerState[TimerState["ENDED"] = 2] = "ENDED"; })(TimerState || (TimerState = {})); /** * A simple version of the timer. Will take options and start the timer immediately after calling it * * @param options options with which to initialize this timer * @returns an observer that can be used to stop the timer */ export function setAndStartTimer(options) { let timer = 0; const startTime = Date.now(); options.observableParameters = options.observableParameters ?? {}; const observer = options.contextObservable.add((payload) => { const now = Date.now(); timer = now - startTime; const data = { startTime, currentTime: now, deltaTime: timer, completeRate: timer / options.timeout, payload, }; options.onTick && options.onTick(data); if (options.breakCondition && options.breakCondition()) { options.contextObservable.remove(observer); options.onAborted && options.onAborted(data); } if (timer >= options.timeout) { options.contextObservable.remove(observer); options.onEnded && options.onEnded(data); } }, options.observableParameters.mask, options.observableParameters.insertFirst, options.observableParameters.scope); return observer; } /** * An advanced implementation of a timer class */ export class AdvancedTimer { /** * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called. * @param options construction options for this advanced timer */ constructor(options) { /** * Will notify each time the timer calculates the remaining time */ this.onEachCountObservable = new Observable(); /** * Will trigger when the timer was aborted due to the break condition */ this.onTimerAbortedObservable = new Observable(); /** * Will trigger when the timer ended successfully */ this.onTimerEndedObservable = new Observable(); /** * Will trigger when the timer state has changed */ this.onStateChangedObservable = new Observable(); this._observer = null; this._breakOnNextTick = false; this._tick = (payload) => { const now = Date.now(); this._timer = now - this._startTime; const data = { startTime: this._startTime, currentTime: now, deltaTime: this._timer, completeRate: this._timer / this._timeToEnd, payload, }; const shouldBreak = this._breakOnNextTick || this._breakCondition(data); if (shouldBreak || this._timer >= this._timeToEnd) { this._stop(data, shouldBreak); } else { this.onEachCountObservable.notifyObservers(data); } }; this._setState(TimerState.INIT); this._contextObservable = options.contextObservable; this._observableParameters = options.observableParameters ?? {}; this._breakCondition = options.breakCondition ?? (() => false); this._timeToEnd = options.timeout; if (options.onEnded) { this.onTimerEndedObservable.add(options.onEnded); } if (options.onTick) { this.onEachCountObservable.add(options.onTick); } if (options.onAborted) { this.onTimerAbortedObservable.add(options.onAborted); } } /** * set a breaking condition for this timer. Default is to never break during count * @param predicate the new break condition. Returns true to break, false otherwise */ set breakCondition(predicate) { this._breakCondition = predicate; } /** * Reset ALL associated observables in this advanced timer */ clearObservables() { this.onEachCountObservable.clear(); this.onTimerAbortedObservable.clear(); this.onTimerEndedObservable.clear(); this.onStateChangedObservable.clear(); } /** * Will start a new iteration of this timer. Only one instance of this timer can run at a time. * * @param timeToEnd how much time to measure until timer ended */ start(timeToEnd = this._timeToEnd) { if (this._state === TimerState.STARTED) { throw new Error("Timer already started. Please stop it before starting again"); } this._timeToEnd = timeToEnd; this._startTime = Date.now(); this._timer = 0; this._observer = this._contextObservable.add(this._tick, this._observableParameters.mask, this._observableParameters.insertFirst, this._observableParameters.scope); this._setState(TimerState.STARTED); } /** * Will force a stop on the next tick. */ stop() { if (this._state !== TimerState.STARTED) { return; } this._breakOnNextTick = true; } /** * Dispose this timer, clearing all resources */ dispose() { if (this._observer) { this._contextObservable.remove(this._observer); } this.clearObservables(); } _setState(newState) { this._state = newState; this.onStateChangedObservable.notifyObservers(this._state); } _stop(data, aborted = false) { this._contextObservable.remove(this._observer); this._setState(TimerState.ENDED); if (aborted) { this.onTimerAbortedObservable.notifyObservers(data); } else { this.onTimerEndedObservable.notifyObservers(data); } } } //# sourceMappingURL=timer.js.map