New AtlasXML file type

src/loader/filetypes/AtlasXMLFile.js

@@ -0,0 +1,125 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2018 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+var Class = require('../../utils/Class');
+var FileTypesManager = require('../FileTypesManager');
+var GetFastValue = require('../../utils/object/GetFastValue');
+var ImageFile = require('./ImageFile.js');
+var IsPlainObject = require('../../utils/object/IsPlainObject');
+var LinkFile = require('../LinkFile.js');
+var XMLFile = require('./XMLFile.js');
+
+/**
+ * @classdesc
+ * An XML based Atlas File, such as those created with Shoebox, Starling or Flash.
+ *
+ * @class AtlasXMLFile
+ * @extends Phaser.Loader.LinkFile
+ * @memberOf Phaser.Loader.FileTypes
+ * @constructor
+ *
+ * @param {string} key - The key of the file within the loader.
+ * @param {string} textureURL - The url to load the texture file from.
+ * @param {string} atlasURL - The url to load the atlas file from.
+ * @param {XHRSettingsObject} [textureXhrSettings] - Optional texture file specific XHR settings.
+ * @param {XHRSettingsObject} [atlasXhrSettings] - Optional atlas file specific XHR settings.
+ */
+var AtlasXMLFile = new Class({
+
+    Extends: LinkFile,
+
+    initialize:
+
+    function AtlasXMLFile (loader, key, textureURL, atlasURL, textureXhrSettings, atlasXhrSettings)
+    {
+        if (IsPlainObject(key))
+        {
+            var config = key;
+
+            key = GetFastValue(config, 'key');
+            textureURL = GetFastValue(config, 'textureURL');
+            atlasURL = GetFastValue(config, 'atlasURL');
+            textureXhrSettings = GetFastValue(config, 'textureXhrSettings');
+            atlasXhrSettings = GetFastValue(config, 'atlasXhrSettings');
+        }
+
+        var image = new ImageFile(loader, key, textureURL, textureXhrSettings);
+        var data = new XMLFile(loader, key, atlasURL, atlasXhrSettings);
+
+        LinkFile.call(this, loader, 'atlasxml', key, [ image, data ]);
+    },
+
+    addToCache: function ()
+    {
+        if (this.failed === 0 && !this.complete)
+        {
+            var fileA = this.files[0];
+            var fileB = this.files[1];
+
+            if (fileA.type === 'image')
+            {
+                this.loader.textureManager.addAtlasXML(fileA.key, fileA.data, fileB.data);
+                fileB.addToCache();
+            }
+            else
+            {
+                this.loader.textureManager.addAtlasXML(fileB.key, fileB.data, fileA.data);
+                fileA.addToCache();
+            }
+
+            this.complete = true;
+        }
+    }
+
+});
+
+/**
+ * Adds an XML Texture Atlas file to the current load queue.
+ *
+ * Note: This method will only be available if the Atlas XML File type has been built into Phaser.
+ *
+ * The file is **not** loaded immediately after calling this method.
+ * Instead, the file is added to a queue within the Loader, which is processed automatically when the Loader starts.
+ *
+ * @method Phaser.Loader.LoaderPlugin#atlasXML
+ * @since 3.y.0
+ *
+ * @param {string} key - The key of the file within the loader.
+ * @param {string} textureURL - The url to load the texture file from.
+ * @param {string} atlasURL - The url to load the atlas file from.
+ * @param {XHRSettingsObject} [textureXhrSettings] - Optional texture file specific XHR settings.
+ * @param {XHRSettingsObject} [atlasXhrSettings] - Optional atlas file specific XHR settings.
+ *
+ * @return {Phaser.Loader.LoaderPlugin} The Loader.
+ */
+FileTypesManager.register('atlasXML', function (key, textureURL, atlasURL, textureXhrSettings, atlasXhrSettings)
+{
+    var linkfile;
+
+    //  Supports an Object file definition in the key argument
+    //  Or an array of objects in the key argument
+    //  Or a single entry where all arguments have been defined
+
+    if (Array.isArray(key))
+    {
+        for (var i = 0; i < key.length; i++)
+        {
+            linkfile = new AtlasXMLFile(this, key[i]);
+
+            this.addFile(linkfile.files);
+        }
+    }
+    else
+    {
+        linkfile = new AtlasXMLFile(this, key, textureURL, atlasURL, textureXhrSettings, atlasXhrSettings);
+
+        this.addFile(linkfile.files);
+    }
+
+    return this;
+});
+
+module.exports = AtlasXMLFile;

src/loader/filetypes/index.js

@@ -35,6 +35,7 @@ module.exports = {
 
     AnimationJSONFile: require('./AnimationJSONFile'),
     AtlasJSONFile: require('./AtlasJSONFile'),
+    AtlasXMLFile: require('./AtlasXMLFile'),
     AudioFile: require('./AudioFile'),
     AudioSpriteFile: require('./AudioSpriteFile'),
     BinaryFile: require('./BinaryFile'),