@babylonjs/loaders 5.0.0-rc.2 → 5.0.0-rc.5

package/glTF/glTFFileLoader.js

@@ -1,6 +1,6 @@
 import { Observable } from "@babylonjs/core/Misc/observable.js";
 import { Tools } from "@babylonjs/core/Misc/tools.js";
-import { SceneLoader } from "@babylonjs/core/Loading/sceneLoader.js";
+import { SceneLoader, } from "@babylonjs/core/Loading/sceneLoader.js";
 import { AssetContainer } from "@babylonjs/core/assetContainer.js";
 import { Logger } from "@babylonjs/core/Misc/logger.js";
 import { DataReader } from "@babylonjs/core/Misc/dataReader.js";
@@ -86,8 +86,8 @@ var GLTFFileLoader = /** @class */ (function () {
          */
         this.coordinateSystemMode = GLTFLoaderCoordinateSystemMode.AUTO;
         /**
-        * The animation start mode. Defaults to FIRST.
-        */
+         * The animation start mode. Defaults to FIRST.
+         */
         this.animationStartMode = GLTFLoaderAnimationStartMode.FIRST;
         /**
          * Defines if the loader should compile materials before raising the success callback. Defaults to false.
@@ -125,6 +125,14 @@ var GLTFFileLoader = /** @class */ (function () {
          * If true, load all materials defined in the file, even if not used by any mesh. Defaults to false.
          */
         this.loadAllMaterials = false;
+        /**
+         * If true, load only the materials defined in the file. Defaults to false.
+         */
+        this.loadOnlyMaterials = false;
+        /**
+         * If true, do not load any materials defined in the file. Defaults to false.
+         */
+        this.skipMaterials = false;
         /**
          * If true, load the color (gamma encoded) textures into sRGB buffers (if supported by the GPU), which will yield more accurate results when sampling the texture. Defaults to true.
          */
@@ -139,8 +147,9 @@ var GLTFFileLoader = /** @class */ (function () {
          */
         this.alwaysComputeSkeletonRootNode = false;
         /**
-        * Function called before loading a url referenced by the asset.
-        */
+         * Function called before loading a url referenced by the asset.
+         * @param url
+         */
         this.preprocessUrlAsync = function (url) { return Promise.resolve(url); };
         /**
          * Observable raised when the loader creates a mesh after parsing the glTF properties of the mesh.
@@ -196,7 +205,7 @@ var GLTFFileLoader = /** @class */ (function () {
         /** @hidden */
         this.extensions = {
             ".gltf": { isBinary: false },
-            ".glb": { isBinary: true }
+            ".glb": { isBinary: true },
         };
         /**
          * Observable raised when the loader state changes.
@@ -415,7 +424,15 @@ var GLTFFileLoader = /** @class */ (function () {
         this.onDisposeObservable.notifyObservers(undefined);
         this.onDisposeObservable.clear();
     };
-    /** @hidden */
+    /**
+     * @param scene
+     * @param fileOrUrl
+     * @param onSuccess
+     * @param onProgress
+     * @param useArrayBuffer
+     * @param onError
+     * @hidden
+     */
     GLTFFileLoader.prototype.loadFile = function (scene, fileOrUrl, onSuccess, onProgress, useArrayBuffer, onError) {
         var _this = this;
         this._progressCallback = onProgress;
@@ -428,7 +445,7 @@ var GLTFFileLoader = /** @class */ (function () {
                 }
                 var fileRequest_1 = {
                     abort: function () { },
-                    onCompleteObservable: new Observable()
+                    onCompleteObservable: new Observable(),
                 };
                 var dataBuffer = {
                     readAsync: function (byteOffset, byteLength) {
@@ -442,7 +459,7 @@ var GLTFFileLoader = /** @class */ (function () {
                             });
                         });
                     },
-                    byteLength: 0
+                    byteLength: 0,
                 };
                 this._unpackBinaryAsync(new DataReader(dataBuffer)).then(function (loaderData) {
                     fileRequest_1.onCompleteObservable.notifyObservers(fileRequest_1);
@@ -454,7 +471,7 @@ var GLTFFileLoader = /** @class */ (function () {
                 _this._validate(scene, data, rootUrl, fileName);
                 _this._unpackBinaryAsync(new DataReader({
                     readAsync: function (byteOffset, byteLength) { return readAsync(data, byteOffset, byteLength); },
-                    byteLength: data.byteLength
+                    byteLength: data.byteLength,
                 })).then(function (loaderData) {
                     onSuccess(loaderData);
                 }, onError ? function (error) { return onError(undefined, error); } : undefined);
@@ -465,7 +482,15 @@ var GLTFFileLoader = /** @class */ (function () {
             onSuccess({ json: _this._parseJson(data) });
         }, useArrayBuffer, onError);
     };
-    /** @hidden */
+    /**
+     * @param meshesNames
+     * @param scene
+     * @param data
+     * @param rootUrl
+     * @param onProgress
+     * @param fileName
+     * @hidden
+     */
     GLTFFileLoader.prototype.importMeshAsync = function (meshesNames, scene, data, rootUrl, onProgress, fileName) {
         var _this = this;
         return Promise.resolve().then(function () {
@@ -476,7 +501,14 @@ var GLTFFileLoader = /** @class */ (function () {
             return _this._loader.importMeshAsync(meshesNames, scene, null, data, rootUrl, onProgress, fileName);
         });
     };
-    /** @hidden */
+    /**
+     * @param scene
+     * @param data
+     * @param rootUrl
+     * @param onProgress
+     * @param fileName
+     * @hidden
+     */
     GLTFFileLoader.prototype.loadAsync = function (scene, data, rootUrl, onProgress, fileName) {
         var _this = this;
         return Promise.resolve().then(function () {
@@ -487,7 +519,14 @@ var GLTFFileLoader = /** @class */ (function () {
             return _this._loader.loadAsync(scene, data, rootUrl, onProgress, fileName);
         });
     };
-    /** @hidden */
+    /**
+     * @param scene
+     * @param data
+     * @param rootUrl
+     * @param onProgress
+     * @param fileName
+     * @hidden
+     */
     GLTFFileLoader.prototype.loadAssetContainerAsync = function (scene, data, rootUrl, onProgress, fileName) {
         var _this = this;
         return Promise.resolve().then(function () {
@@ -525,25 +564,32 @@ var GLTFFileLoader = /** @class */ (function () {
             });
         });
     };
-    /** @hidden */
+    /**
+     * @param data
+     * @hidden
+     */
     GLTFFileLoader.prototype.canDirectLoad = function (data) {
-        return (data.indexOf("asset") !== -1 && data.indexOf("version") !== -1)
-            || StringTools.StartsWith(data, "data:base64," + GLTFFileLoader.magicBase64Encoded) // this is technically incorrect, but will continue to support for backcompat.
-            || StringTools.StartsWith(data, "data:;base64," + GLTFFileLoader.magicBase64Encoded)
-            || StringTools.StartsWith(data, "data:application/octet-stream;base64," + GLTFFileLoader.magicBase64Encoded)
-            || StringTools.StartsWith(data, "data:model/gltf-binary;base64," + GLTFFileLoader.magicBase64Encoded);
+        return ((data.indexOf("asset") !== -1 && data.indexOf("version") !== -1) ||
+            StringTools.StartsWith(data, "data:base64," + GLTFFileLoader._MagicBase64Encoded) || // this is technically incorrect, but will continue to support for backcompat.
+            StringTools.StartsWith(data, "data:;base64," + GLTFFileLoader._MagicBase64Encoded) ||
+            StringTools.StartsWith(data, "data:application/octet-stream;base64," + GLTFFileLoader._MagicBase64Encoded) ||
+            StringTools.StartsWith(data, "data:model/gltf-binary;base64," + GLTFFileLoader._MagicBase64Encoded));
     };
-    /** @hidden */
+    /**
+     * @param scene
+     * @param data
+     * @hidden
+     */
     GLTFFileLoader.prototype.directLoad = function (scene, data) {
-        if (StringTools.StartsWith(data, "base64," + GLTFFileLoader.magicBase64Encoded) || // this is technically incorrect, but will continue to support for backcompat.
-            StringTools.StartsWith(data, ";base64," + GLTFFileLoader.magicBase64Encoded) ||
-            StringTools.StartsWith(data, "application/octet-stream;base64," + GLTFFileLoader.magicBase64Encoded) ||
-            StringTools.StartsWith(data, "model/gltf-binary;base64," + GLTFFileLoader.magicBase64Encoded)) {
+        if (StringTools.StartsWith(data, "base64," + GLTFFileLoader._MagicBase64Encoded) || // this is technically incorrect, but will continue to support for backcompat.
+            StringTools.StartsWith(data, ";base64," + GLTFFileLoader._MagicBase64Encoded) ||
+            StringTools.StartsWith(data, "application/octet-stream;base64," + GLTFFileLoader._MagicBase64Encoded) ||
+            StringTools.StartsWith(data, "model/gltf-binary;base64," + GLTFFileLoader._MagicBase64Encoded)) {
             var arrayBuffer_1 = DecodeBase64UrlToBinary(data);
             this._validate(scene, arrayBuffer_1);
             return this._unpackBinaryAsync(new DataReader({
                 readAsync: function (byteOffset, byteLength) { return readAsync(arrayBuffer_1, byteOffset, byteLength); },
-                byteLength: arrayBuffer_1.byteLength
+                byteLength: arrayBuffer_1.byteLength,
             }));
         }
         this._validate(scene, data);
@@ -578,7 +624,10 @@ var GLTFFileLoader = /** @class */ (function () {
             });
         });
     };
-    /** @hidden */
+    /**
+     * @param state
+     * @hidden
+     */
     GLTFFileLoader.prototype._setState = function (state) {
         if (this._state === state) {
             return;
@@ -587,7 +636,15 @@ var GLTFFileLoader = /** @class */ (function () {
         this.onLoaderStateChangedObservable.notifyObservers(this._state);
         this._log(GLTFLoaderState[this._state]);
     };
-    /** @hidden */
+    /**
+     * @param scene
+     * @param fileOrUrl
+     * @param onSuccess
+     * @param useArrayBuffer
+     * @param onError
+     * @param onOpened
+     * @hidden
+     */
     GLTFFileLoader.prototype._loadFile = function (scene, fileOrUrl, onSuccess, useArrayBuffer, onError, onOpened) {
         var _this = this;
         var request = scene._loadFile(fileOrUrl, onSuccess, function (event) {
@@ -621,7 +678,7 @@ var GLTFFileLoader = /** @class */ (function () {
         this._progressCallback({
             lengthComputable: lengthComputable,
             loaded: loaded,
-            total: lengthComputable ? total : 0
+            total: lengthComputable ? total : 0,
         });
     };
     GLTFFileLoader.prototype._validate = function (scene, data, rootUrl, fileName) {
@@ -664,7 +721,7 @@ var GLTFFileLoader = /** @class */ (function () {
         }
         var createLoaders = {
             1: GLTFFileLoader._CreateGLTF1Loader,
-            2: GLTFFileLoader._CreateGLTF2Loader
+            2: GLTFFileLoader._CreateGLTF2Loader,
         };
         var createLoader = createLoaders[version.major];
         if (!createLoader) {
@@ -685,7 +742,7 @@ var GLTFFileLoader = /** @class */ (function () {
         // Read magic + version + length + json length + json format
         return dataReader.loadAsync(20).then(function () {
             var Binary = {
-                Magic: 0x46546C67
+                Magic: 0x46546c67,
             };
             var magic = dataReader.readUint32();
             if (magic !== Binary.Magic) {
@@ -719,7 +776,7 @@ var GLTFFileLoader = /** @class */ (function () {
     };
     GLTFFileLoader.prototype._unpackBinaryV1Async = function (dataReader, length) {
         var ContentFormat = {
-            JSON: 0
+            JSON: 0,
         };
         var contentLength = dataReader.readUint32();
         var contentFormat = dataReader.readUint32();
@@ -732,7 +789,7 @@ var GLTFFileLoader = /** @class */ (function () {
             var startByteOffset_1 = dataReader.byteOffset;
             data.bin = {
                 readAsync: function (byteOffset, byteLength) { return dataReader.buffer.readAsync(startByteOffset_1 + byteOffset, byteLength); },
-                byteLength: bodyLength
+                byteLength: bodyLength,
             };
         }
         return Promise.resolve(data);
@@ -740,8 +797,8 @@ var GLTFFileLoader = /** @class */ (function () {
     GLTFFileLoader.prototype._unpackBinaryV2Async = function (dataReader, length) {
         var _this = this;
         var ChunkFormat = {
-            JSON: 0x4E4F534A,
-            BIN: 0x004E4942
+            JSON: 0x4e4f534a,
+            BIN: 0x004e4942,
         };
         // Read the JSON chunk header.
         var chunkLength = dataReader.readUint32();
@@ -769,7 +826,7 @@ var GLTFFileLoader = /** @class */ (function () {
                         var startByteOffset_2 = dataReader.byteOffset;
                         data.bin = {
                             readAsync: function (byteOffset, byteLength) { return dataReader.buffer.readAsync(startByteOffset_2 + byteOffset, byteLength); },
-                            byteLength: chunkLength
+                            byteLength: chunkLength,
                         };
                         dataReader.skipBytes(chunkLength);
                         break;
@@ -792,7 +849,7 @@ var GLTFFileLoader = /** @class */ (function () {
         if (version === "1.0" || version === "1.0.1") {
             return {
                 major: 1,
-                minor: 0
+                minor: 0,
             };
         }
         var match = (version + "").match(/^(\d+)\.(\d+)/);
@@ -801,7 +858,7 @@ var GLTFFileLoader = /** @class */ (function () {
         }
         return {
             major: parseInt(match[1]),
-            minor: parseInt(match[2])
+            minor: parseInt(match[2]),
         };
     };
     GLTFFileLoader._compareVersion = function (a, b) {
@@ -819,7 +876,10 @@ var GLTFFileLoader = /** @class */ (function () {
         }
         return 0;
     };
-    /** @hidden */
+    /**
+     * @param message
+     * @hidden
+     */
     GLTFFileLoader.prototype._logOpen = function (message) {
         this._log(message);
         this._logIndentLevel++;
@@ -832,18 +892,15 @@ var GLTFFileLoader = /** @class */ (function () {
         var spaces = GLTFFileLoader._logSpaces.substr(0, this._logIndentLevel * 2);
         Logger.Log("".concat(spaces).concat(message));
     };
-    GLTFFileLoader.prototype._logDisabled = function (message) {
-    };
+    GLTFFileLoader.prototype._logDisabled = function (message) { };
     GLTFFileLoader.prototype._startPerformanceCounterEnabled = function (counterName) {
         Tools.StartPerformanceCounter(counterName);
     };
-    GLTFFileLoader.prototype._startPerformanceCounterDisabled = function (counterName) {
-    };
+    GLTFFileLoader.prototype._startPerformanceCounterDisabled = function (counterName) { };
     GLTFFileLoader.prototype._endPerformanceCounterEnabled = function (counterName) {
         Tools.EndPerformanceCounter(counterName);
     };
-    GLTFFileLoader.prototype._endPerformanceCounterDisabled = function (counterName) {
-    };
+    GLTFFileLoader.prototype._endPerformanceCounterDisabled = function (counterName) { };
     // ----------
     // V1 options
     // ----------
@@ -860,7 +917,7 @@ var GLTFFileLoader = /** @class */ (function () {
      * @hidden
      */
     GLTFFileLoader.HomogeneousCoordinates = false;
-    GLTFFileLoader.magicBase64Encoded = "Z2xURg"; // "glTF" base64 encoded (without the quotes!)
+    GLTFFileLoader._MagicBase64Encoded = "Z2xURg"; // "glTF" base64 encoded (without the quotes!)
     GLTFFileLoader._logSpaces = "                                ";
     return GLTFFileLoader;
 }());