Merge pull request phaserjs#1221 from englercj/url-cache-map

Add ability to get a cached resource by url

Author: photonstorm

src/loader/Cache.js

@@ -5,9 +5,9 @@
 */
 
 /**
-* A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds 
+* A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds
 * and data files as a result of Loader calls. Cached items use string based keys for look-up.
-* 
+*
 * @class Phaser.Cache
 * @constructor
 * @param {Phaser.Game} game - A reference to the currently running game.
@@ -91,6 +91,24 @@ Phaser.Cache = function (game) {
     */
     this._bitmapFont = {};
 
+    /**
+    * @property {object} _urlMap - Maps URLs to resources.
+    * @private
+    */
+    this._urlMap = {};
+
+    /**
+    * @property {Image} _urlResolver - Used to resolve URLs to the absolute path.
+    * @private
+    */
+    this._urlResolver = new Image();
+
+    /**
+    * @property {string} _urlTemp - Temporary variable to hold a resolved url.
+    * @private
+    */
+    this._urlTemp = null;
+
     this.addDefaultImage();
     this.addMissingImage();
 
@@ -276,6 +294,8 @@ Phaser.Cache.prototype = {
 
         this._images[key].frameData = Phaser.AnimationParser.spriteSheet(this.game, key, frameWidth, frameHeight, frameMax, margin, spacing);
 
+        this._urlMap[this._resolveUrl(url)] = this._images[key];
+
     },
 
     /**
@@ -291,6 +311,8 @@ Phaser.Cache.prototype = {
 
         this._tilemaps[key] = { url: url, data: mapData, format: format };
 
+        this._urlMap[this._resolveUrl(url)] = this._tilemaps[key];
+
     },
 
     /**
@@ -323,6 +345,8 @@ Phaser.Cache.prototype = {
             this._images[key].frameData = Phaser.AnimationParser.XMLData(this.game, atlasData, key);
         }
 
+        this._urlMap[this._resolveUrl(url)] = this._images[key];
+
     },
 
     /**
@@ -347,6 +371,8 @@ Phaser.Cache.prototype = {
 
         this._bitmapFont[key] = PIXI.BitmapText.fonts[key];
 
+        this._urlMap[this._resolveUrl(url)] = this._bitmapFont[key];
+
     },
 
     /**
@@ -362,6 +388,8 @@ Phaser.Cache.prototype = {
 
         this._physics[key] = { url: url, data: JSONData, format: format };
 
+        this._urlMap[this._resolveUrl(url)] = this._physics[key];
+
     },
 
     /**
@@ -418,6 +446,8 @@ Phaser.Cache.prototype = {
 
         this._text[key] = { url: url, data: data };
 
+        this._urlMap[this._resolveUrl(url)] = this._text[key];
+
     },
 
     /**
@@ -432,6 +462,8 @@ Phaser.Cache.prototype = {
 
         this._json[key] = { url: url, data: data };
 
+        this._urlMap[this._resolveUrl(url)] = this._json[key];
+
     },
 
     /**
@@ -467,6 +499,8 @@ Phaser.Cache.prototype = {
         PIXI.BaseTextureCache[key] = new PIXI.BaseTexture(data);
         PIXI.TextureCache[key] = new PIXI.Texture(PIXI.BaseTextureCache[key]);
 
+        this._urlMap[this._resolveUrl(url)] = this._images[key];
+
     },
 
     /**
@@ -493,6 +527,8 @@ Phaser.Cache.prototype = {
 
         this._sounds[key] = { url: url, data: data, isDecoding: false, decoded: decoded, webAudio: webAudio, audioTag: audioTag, locked: this.game.sound.touchLocked };
 
+        this._urlMap[this._resolveUrl(url)] = this._sounds[key];
+
     },
 
     /**
@@ -667,7 +703,7 @@ Phaser.Cache.prototype = {
                         }
 
                     }
-                    
+
                     //  We did not find the requested fixture
                     console.warn('Phaser.Cache.getPhysicsData: Could not find given fixtureKey: "' + fixtureKey + ' in ' + key + '"');
                 }
@@ -861,6 +897,24 @@ Phaser.Cache.prototype = {
 
     },
 
+    /**
+    * Checks if the given URL has been loaded into the Cache.
+    *
+    * @method Phaser.Cache#checkUrl
+    * @param {string} url - The url to check for in the cache.
+    * @return {boolean} True if the url exists, otherwise false.
+    */
+    checkUrl: function (url) {
+
+        if (this._urlMap[this._resolveUrl(url)])
+        {
+            return true;
+        }
+
+        return false;
+
+    },
+
     /**
     * Get image data by key.
     *
@@ -1193,6 +1247,26 @@ Phaser.Cache.prototype = {
 
     },
 
+    /**
+    * Get a cached object by the URL.
+    *
+    * @method Phaser.Cache#getUrl
+    * @param {string} url - The url for the object loaded to get from the cache.
+    * @return {object} The cached object.
+    */
+    getUrl: function (url) {
+
+        if (this._urlMap[this._resolveUrl(url)])
+        {
+            return this._urlMap[this._resolveUrl(url)];
+        }
+        else
+        {
+            console.warn('Phaser.Cache.getUrl: Invalid url: "' + url  + '"');
+        }
+
+    },
+
     /**
     * Gets all keys used by the Cache for the given data type.
     *
@@ -1394,6 +1468,24 @@ Phaser.Cache.prototype = {
         delete this._bitmapFont[key];
     },
 
+    /**
+    * Resolves a url its absolute form.
+    *
+    * @method Phaser.Cache#_resolveUrl
+    * @param {string} url - The url to resolve.
+    * @private
+    */
+    _resolveUrl: function (url) {
+        this._urlResolver.src = this.game.load.baseUrl + url;
+
+        this._urlTemp = this._urlResolver.src;
+
+        // ensure no request is actually made
+        this._urlResolver.src = '';
+
+        return this._urlTemp;
+    },
+
     /**
     * Clears the cache. Removes every local cache object reference.
     *
@@ -1464,6 +1556,10 @@ Phaser.Cache.prototype = {
             delete this._bitmapFont[item];
         }
 
+        this._urlMap = null;
+        this._urlResolver = null;
+        this._urlTemp = null;
+
     }
 
 };