phaser/Phaser/system/RequestAnimationFrame.ts

/// <reference path="../Game.ts" />

/**
 *  RequestAnimationFrame
 *
 *  @desc       Abstracts away the use of RAF or setTimeOut for the core game update loop. The callback can be re-mapped on the fly.
 *
 *	@version 	0.3 - 15th October 2012
 *	@author 	Richard Davey
 */

/**
*   Phaser
*/

module Phaser {

    export class RequestAnimationFrame {

        /** 
        * Constructor
        * @param {Any} callback
        * @return {RequestAnimationFrame} This object.
        */
        constructor(callback, callbackContext) {

            this._callback = callback;
            this._callbackContext = callbackContext;

            var vendors = ['ms', 'moz', 'webkit', 'o'];

            for (var x = 0; x < vendors.length && !window.requestAnimationFrame; x++)
            {
                window.requestAnimationFrame = window[vendors[x] + 'RequestAnimationFrame'];
                window.cancelAnimationFrame = window[vendors[x] + 'CancelAnimationFrame'];
            }

            this.start();

        }

        /**
        * 
        * @property _callback
        * @type Any
        * @private
        **/
        private _callback;
        private _callbackContext;

        /**
        * 
        * @method callback
        * @param {Any} callback
        **/
        public setCallback(callback) {

            this._callback = callback;

        }

        /**
        * 
        * @property _timeOutID
        * @type Any
        * @private
        **/
        private _timeOutID;

        /**
        * 
        * @property _isSetTimeOut
        * @type Boolean
        * @private
        **/
        private _isSetTimeOut: bool = false;

        /**
        * 
        * @method usingSetTimeOut
        * @return Boolean
        **/
        public isUsingSetTimeOut(): bool {

            return this._isSetTimeOut;

        }

        /**
        * 
        * @method usingRAF
        * @return Boolean
        **/
        public isUsingRAF(): bool {

            if (this._isSetTimeOut === true)
            {
                return false;
            }
            else
            {
                return true;
            }
        }

        /**
        * 
        * @property lastTime
        * @type Number
        **/
        public lastTime: number = 0;

        /**
        * 
        * @property currentTime
        * @type Number
        **/
        public currentTime: number = 0;

        /**
        * 
        * @property isRunning
        * @type Boolean
        **/
        public isRunning: bool = false;

        /**
        * 
        * @method start
        * @param {Any} [callback] 
        **/
        public start(callback? = null) {

            if (callback)
            {
                this._callback = callback;
            }

            if (!window.requestAnimationFrame)
            {
                this._isSetTimeOut = true;
                this._timeOutID = window.setTimeout(() => this.SetTimeoutUpdate(), 0);
            }
            else
            {
                this._isSetTimeOut = false;
                window.requestAnimationFrame(() => this.RAFUpdate());
            }

            this.isRunning = true;

        }

        /**
        * 
        * @method stop 
        **/
        public stop() {

            if (this._isSetTimeOut)
            {
                clearTimeout(this._timeOutID);
            }
            else
            {
                window.cancelAnimationFrame;
            }

            this.isRunning = false;

        }

        public RAFUpdate() {

            //  Not in IE8 (but neither is RAF) also doesn't use a high performance timer (window.performance.now)
            this.currentTime = Date.now();

            if (this._callback)
            {
                this._callback.call(this._callbackContext);
            }

            var timeToCall: number = Math.max(0, 16 - (this.currentTime - this.lastTime));

            window.requestAnimationFrame(() => this.RAFUpdate());

            this.lastTime = this.currentTime + timeToCall;

        }

        /**
        * 
        * @method SetTimeoutUpdate 
        **/
        public SetTimeoutUpdate() {

            //  Not in IE8
            this.currentTime = Date.now();

            if (this._callback)
            {
                this._callback.call(this._callbackContext);
            }

            var timeToCall: number = Math.max(0, 16 - (this.currentTime - this.lastTime));

            this._timeOutID = window.setTimeout(() => this.SetTimeoutUpdate(), timeToCall);

            this.lastTime = this.currentTime + timeToCall;

        }

    }

}