Added Group.bringToTop and updated Input component to use sprite getXY handler.

Author: photonstorm

Phaser/components/sprite/Input.ts

@@ -48,6 +48,11 @@ module Phaser.Components.Sprite {
          */
 		public priorityID:number = 0;
 
+        /**
+         * The index of this Input component entry in the Game.Input manager.
+         */
+		public indexID:number = 0;
+
         private _dragPoint: Point;
         private _draggedPointerID: number;
         public dragOffset: Point;
@@ -58,6 +63,7 @@ module Phaser.Components.Sprite {
 
         public allowHorizontalDrag: bool = true;
         public allowVerticalDrag: bool = true;
+        public bringToTop: bool = false;
 
         public snapOnDrag: bool = false;
         public snapOnRelease: bool = false;
@@ -245,11 +251,26 @@ module Phaser.Components.Sprite {
 		    {
                 //  De-register, etc
 		        this.enabled = false;
-		        this.game.input.removeGameObject(this.sprite);
+		        this.game.input.removeGameObject(this.indexID);
 		    }
 
 		}
 
+        /**
+         * Clean up memory.
+         */
+        public destroy() {
+
+		    if (this.enabled)
+		    {
+		        this.game.input.removeGameObject(this.indexID);
+		    }
+
+        }
+
+        /**
+         * Checks if the given pointer is over this Sprite. All checks are done in world coordinates.
+         */
 		public checkPointerOver(pointer: Phaser.Pointer): bool {
 
 		    if (this.enabled == false || this.sprite.visible == false)
@@ -258,7 +279,7 @@ module Phaser.Components.Sprite {
 		    }
 		    else
 		    {
-		        return RectangleUtils.contains(this.sprite.worldView, pointer.worldX(), pointer.worldY());
+                return SpriteUtils.overlapsXY(this.sprite, pointer.worldX(), pointer.worldY());
 		    }
 
 		}
@@ -279,7 +300,7 @@ module Phaser.Components.Sprite {
             }
             else if (this._pointerData[pointer.id].isOver == true)
             {
-                if (RectangleUtils.contains(this.sprite.worldView, pointer.worldX(), pointer.worldY()))
+                if (SpriteUtils.overlapsXY(this.sprite, pointer.worldX(), pointer.worldY()))
                 {
                     this._pointerData[pointer.id].x = pointer.x - this.sprite.x;
                     this._pointerData[pointer.id].y = pointer.y - this.sprite.y;
@@ -350,6 +371,11 @@ module Phaser.Components.Sprite {
                     this.startDrag(pointer);
                 }
 
+                if (this.bringToTop)
+                {
+                    this.sprite.group.bringToTop(this.sprite);
+                }
+
             }
 
             //  Consume the event?
@@ -493,16 +519,18 @@ module Phaser.Components.Sprite {
 		 * Make this Sprite draggable by the mouse. You can also optionally set mouseStartDragCallback and mouseStopDragCallback
 		 * 
 		 * @param	lockCenter			If false the Sprite will drag from where you click it minus the dragOffset. If true it will center itself to the tip of the mouse pointer.
+		 * @param	bringToTop			If true the Sprite will be bought to the top of the rendering list in its current Group.
 		 * @param	pixelPerfect		If true it will use a pixel perfect test to see if you clicked the Sprite. False uses the bounding box.
 		 * @param	alphaThreshold		If using pixel perfect collision this specifies the alpha level from 0 to 255 above which a collision is processed (default 255)
 		 * @param	boundsRect			If you want to restrict the drag of this sprite to a specific FlxRect, pass the FlxRect here, otherwise it's free to drag anywhere
 		 * @param	boundsSprite		If you want to restrict the drag of this sprite to within the bounding box of another sprite, pass it here
 		 */
-		public enableDrag(lockCenter:bool = false, pixelPerfect:bool = false, alphaThreshold:number = 255, boundsRect:Rectangle = null, boundsSprite:Phaser.Sprite = null):void
+		public enableDrag(lockCenter:bool = false, bringToTop:bool = false, pixelPerfect:bool = false, alphaThreshold:number = 255, boundsRect:Rectangle = null, boundsSprite:Phaser.Sprite = null):void
 		{
             this._dragPoint = new Point;
 
 			this.draggable = true;
+			this.bringToTop = bringToTop;
 
             this.dragOffset = new Point;
 			this.dragFromCenter = lockCenter;
@@ -559,6 +587,11 @@ module Phaser.Components.Sprite {
 
             this.updateDrag(pointer);
 
+            if (this.bringToTop)
+            {
+                this.sprite.group.bringToTop(this.sprite);
+            }
+
 		}
 
 		/**

Phaser/core/Group.ts

@@ -583,6 +583,14 @@ module Phaser {
 
         }
 
+        /**
+         * Swaps two existing game object in this Group with each other.
+         *
+         * @param {Basic} child1 The first object to swap.
+         * @param {Basic} child2 The second object to swap.
+         *
+         * @return {Basic} True if the two objects successfully swapped position.
+         */
         public swap(child1, child2, sort?: bool = true): bool {
 
             if (child1.group.ID != this.ID || child2.group.ID != this.ID || child1 === child2)
@@ -604,6 +612,43 @@ module Phaser {
 
         }
 
+        public bringToTop(child): bool {
+
+            //  If child not in this group, or is already at the top of the group, return false
+            if (child.group.ID != this.ID || child.z == this._zCounter)
+            {
+                return false;
+            }
+
+            this.sort();
+
+            //  What's the z index of the top most child?
+            var tempZ: number = child.z;
+            var childIndex: number = this._zCounter;
+
+            this._i = 0;
+
+            while (this._i < this.length)
+            {
+                this._member = this.members[this._i++];
+
+                if (this._i > childIndex)
+                {
+                    this._member.z--;
+                }
+                else if (this._member.z == child.z)
+                {
+                    childIndex = this._i;
+                    this._member.z = this._zCounter;
+                }
+            }
+
+            this.sort();
+
+            return true;
+
+        }
+
         /**
          * Call this function to sort the group according to a particular value and order.
          * For example, to sort game objects for Zelda-style overlaps you might call

Phaser/gameobjects/Sprite.ts

@@ -40,7 +40,6 @@ module Phaser {
             this.z = -1;
             this.group = null;
 
-            //  No dependencies
             this.animations = new Phaser.Components.AnimationManager(this);
             this.input = new Phaser.Components.Sprite.Input(this);
             this.events = new Phaser.Components.Sprite.Events(this);
@@ -74,6 +73,11 @@ module Phaser {
 
             this.transform.setCache();
 
+            //  Handy proxies
+            this.scale = this.transform.scale;
+            this.alpha = this.texture.alpha;
+            this.origin = this.transform.origin;
+
         }
 
         /**
@@ -194,6 +198,23 @@ module Phaser {
             this.transform.rotation = this.game.math.wrap(value, 360, 0);
         }
 
+        /**
+        * The scale of the Sprite. A value of 1 is original scale. 0.5 is half size. 2 is double the size.
+        * This is a reference to Sprite.transform.scale
+        */
+        public scale: Phaser.Vec2;
+
+        /**
+        * The alpha of the Sprite between 0 and 1, a value of 1 being fully opaque.
+        */
+        public alpha: number;
+
+        /**
+        * The origin of the Sprite around which rotation and positioning takes place.
+        * This is a reference to Sprite.transform.origin
+        */
+        public origin: Phaser.Vec2;
+
         /**
         * Set the animation frame by frame number.
         */
@@ -318,8 +339,7 @@ module Phaser {
          */
         public destroy() {
 
-            //this.input.destroy();
-
+            this.input.destroy();
 
         }
 

Phaser/input/Input.ts

@@ -455,21 +455,45 @@ module Phaser {
         public inputObjects = [];
         public totalTrackedObjects: number = 0;
 
-        //  Add Input Enabled array + add/remove methods and then iterate and update them during the main update
-        //  Clear down this array on State swap??? Maybe removed from it when Sprite is destroyed
-
+        /**
+        * Adds a new game object to be tracked by the Input Manager. Called by the Sprite.Input component, should not usually be called directly.
+        * @method addGameObject
+        **/
         public addGameObject(object) {
 
-            //  Lots more checks here
+            //  Find a spare slot
+            for (var i = 0; i < this.inputObjects.length; i++)
+            {
+                if (this.inputObjects[i] == null)
+                {
+                    this.inputObjects[i] = object;
+                    object.input.indexID = i;
+                    this.totalTrackedObjects++;
+                    return;
+                }
+            }
+
+            //  If we got this far we need to push a new entry into the array
+            object.input.indexID = this.inputObjects.length;
+
             this.inputObjects.push(object);
+
             this.totalTrackedObjects++;
-        }
 
-        public removeGameObject(object) {
-            //  TODO
         }
 
+        /**
+        * Removes a game object from the Input Manager. Called by the Sprite.Input component, should not usually be called directly.
+        * @method removeGameObject
+        **/
+        public removeGameObject(index: number) {
 
+            if (this.inputObjects[index])
+            {
+                this.inputObjects[index] = null;
+            }
+
+        }
 
         /**
         * Updates the Input Manager. Called by the core Game loop.
@@ -521,7 +545,7 @@ module Phaser {
             if (this.pointer10) { this.pointer10.reset(); }
 
             this.currentPointers = 0;
-            
+
             this._game.stage.canvas.style.cursor = "default";
 
             if (hard == true)
@@ -618,7 +642,7 @@ module Phaser {
         * @param {Any} event The event data from the Touch event
         * @return {Pointer} The Pointer object that was started or null if no Pointer object is available
         **/
-        public startPointer(event):Pointer {
+        public startPointer(event): Pointer {
 
             if (this.maxPointers < 10 && this.totalActivePointers == this.maxPointers)
             {
@@ -677,7 +701,7 @@ module Phaser {
         * @param {Any} event The event data from the Touch event
         * @return {Pointer} The Pointer object that was updated or null if no Pointer object is available
         **/
-        public updatePointer(event):Pointer {
+        public updatePointer(event): Pointer {
 
             //  Unrolled for speed
             if (this.pointer1.active == true && this.pointer1.identifier == event.identifier)
@@ -731,7 +755,7 @@ module Phaser {
         * @param {Any} event The event data from the Touch event
         * @return {Pointer} The Pointer object that was stopped or null if no Pointer object is available
         **/
-        public stopPointer(event):Pointer {
+        public stopPointer(event): Pointer {
 
             //  Unrolled for speed
             if (this.pointer1.active == true && this.pointer1.identifier == event.identifier)

Phaser/input/Pointer.ts

@@ -422,7 +422,7 @@ module Phaser {
 
                 for (var i = 0; i < this.game.input.totalTrackedObjects; i++)
                 {
-                    if (this.game.input.inputObjects[i].input.checkPointerOver(this) && this.game.input.inputObjects[i].renderOrderID > _highestRenderID)
+                    if (this.game.input.inputObjects[i] !== null && this.game.input.inputObjects[i].input.checkPointerOver(this) && this.game.input.inputObjects[i].renderOrderID > _highestRenderID)
                     {
                         _highestRenderID = this.game.input.inputObjects[i].renderOrderID;
                         _highestRenderObject = i;
@@ -510,7 +510,7 @@ module Phaser {
 
             for (var i = 0; i < this.game.input.totalTrackedObjects; i++)
             {
-                if (this.game.input.inputObjects[i].input.enabled)
+                if (this.game.input.inputObjects[i] !== null && this.game.input.inputObjects[i].input.enabled)
                 {
                     this.game.input.inputObjects[i].input._releasedHandler(this);
                 }

Phaser/loader/Cache.ts

@@ -261,6 +261,57 @@ module Phaser {
 
         }
 
+        /**
+         * Returns an array containing all of the keys of Images in the Cache.
+         * @return {Array} The string based keys in the Cache.
+         */
+        public getImageKeys() {
+
+            var output = [];
+
+            for (var item in this._images)
+            {
+                output.push(item);
+            }
+
+            return output;
+
+        }
+
+        /**
+         * Returns an array containing all of the keys of Sounds in the Cache.
+         * @return {Array} The string based keys in the Cache.
+         */
+        public getSoundKeys() {
+
+            var output = [];
+
+            for (var item in this._sounds)
+            {
+                output.push(item);
+            }
+
+            return output;
+
+        }
+
+        /**
+         * Returns an array containing all of the keys of Text Files in the Cache.
+         * @return {Array} The string based keys in the Cache.
+         */
+        public getTextKeys() {
+
+            var output = [];
+
+            for (var item in this._text)
+            {
+                output.push(item);
+            }
+
+            return output;
+
+        }
+
         /**
          * Clean up cache memory.
          */