phaser/TS Source/tweens/TweenManager.ts

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

/**
* Phaser - TweenManager
*
* The Game has a single instance of the TweenManager through which all Tween objects are created and updated.
* Tweens are hooked into the game clock and pause system, adjusting based on the game state.
* TweenManager is based heavily on tween.js by sole (http://soledadpenades.com).
* I converted it to TypeScript, swapped the callbacks for signals and patched a few issues with regard
* to properties and completion errors. Please see https://github.com/sole/tween.js for a full list of contributors.
*/

module Phaser {

    export class TweenManager {

        /**
         * TweenManager constructor
         * @param game {Game} A reference to the current Game.
         */
        constructor(game: Phaser.Game) {

            this.game = game;

            this._tweens = [];

            this.game.onPause.add(this.pauseAll, this);
            this.game.onResume.add(this.resumeAll, this);

        }

        /**
         * Local reference to Game
         */
        public game: Phaser.Game;

        /**
         * Local private array which is the container of all tween objects.
         */
        private _tweens: Phaser.Tween[];

        /**
         * Get all the tween objects in an array.
         * @return {Phaser.Tween[]} Array with all tween objects.
         */
        public getAll() {

            return this._tweens;

        }

        /**
         * Remove all tween objects.
         */
        public removeAll() {

            this._tweens.length = 0;

        }

        /**
         * Create a tween object for a specific object. The object can be any JavaScript object or Phaser object such as Sprite.
         *
         * @param obj {object} Object the tween will be run on.
         * @param [localReference] {bool} If true the tween will be stored in the object.tween property so long as it exists. If already set it'll be over-written.
         * @return {Phaser.Tween} The newly created tween object.
         */
        public create(object, localReference:bool = false): Phaser.Tween {

            if (localReference)
            {
                object['tween'] = new Phaser.Tween(object, this.game);
                return object['tween'];
            }
            else
            {
                return new Phaser.Tween(object, this.game);
            }

        }

        /**
         * Add a new tween into the TweenManager.
         *
         * @param tween {Phaser.Tween} The tween object you want to add.
         * @return {Phaser.Tween} The tween object you added to the manager.
         */
        public add(tween: Phaser.Tween) {

            tween.parent = this.game;

            this._tweens.push(tween);

            return tween;

        }

        /**
         * Remove a tween from this manager.
         *
         * @param tween {Phaser.Tween} The tween object you want to remove.
         */
        public remove(tween: Phaser.Tween) {

            var i = this._tweens.indexOf(tween);

            if (i !== -1)
            {
                this._tweens.splice(i, 1);
            }

        }

        /**
         * Update all the tween objects you added to this manager.
         *
         * @return {bool} Return false if there's no tween to update, otherwise return true.
         */
        public update() {

            if (this._tweens.length === 0)
            {
                return false;
            }

            var i = 0;
            var numTweens = this._tweens.length;

            while (i < numTweens)
            {
                if (this._tweens[i].update(this.game.time.now))
                {
                    i++;
                }
                else
                {
                    this._tweens.splice(i, 1);
                    numTweens--;
                }
            }

            return true;

        }

        public pauseAll() {

            if (this._tweens.length === 0)
            {
                return false;
            }

            var i = 0;
            var numTweens = this._tweens.length;

            while (i < numTweens)
            {
                this._tweens[i].pause();
                i++;
            }

        }

        public resumeAll() {

            if (this._tweens.length === 0)
            {
                return false;
            }

            var i = 0;
            var numTweens = this._tweens.length;

            while (i < numTweens)
            {
                this._tweens[i].resume();
                i++;
            }

        }

    }
}