babylonjs-loaders 7.19.1 → 7.20.1

package/babylonjs.loaders.module.d.ts

@@ -54,7 +54,8 @@ import { Camera } from "babylonjs/Cameras/camera";
 import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
 import { Material } from "babylonjs/Materials/material";
 import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
-import { ISceneLoaderPluginFactory, ISceneLoaderPluginAsync, ISceneLoaderProgressEvent, ISceneLoaderPluginExtensions, ISceneLoaderAsyncResult } from "babylonjs/Loading/sceneLoader";
+import { ISceneLoaderPluginFactory, ISceneLoaderPluginAsync, ISceneLoaderProgressEvent, ISceneLoaderAsyncResult } from "babylonjs/Loading/sceneLoader";
+import { SceneLoaderPluginOptions } from "babylonjs/Loading/sceneLoader";
 import { AssetContainer } from "babylonjs/assetContainer";
 import { Scene, IDisposable } from "babylonjs/scene";
 import { WebRequest } from "babylonjs/Misc/webRequest";
@@ -62,6 +63,20 @@ import { IFileRequest } from "babylonjs/Misc/fileRequest";
 import { IDataBuffer } from "babylonjs/Misc/dataReader";
 import { LoadFileError } from "babylonjs/Misc/fileTools";
 import { TransformNode } from "babylonjs/Meshes/transformNode";
+const PLUGIN_GLTF = "gltf";
+/**
+ * Defines options for glTF loader extensions. This interface is extended by specific extensions.
+ */
+export interface GLTFLoaderExtensionOptions extends Record<string, Record<string, unknown> | undefined> {
+}
+module "babylonjs/Loading/sceneLoader" {
+    interface SceneLoaderPluginOptions {
+        /**
+         * Defines options for the glTF loader.
+         */
+        [PLUGIN_GLTF]?: Partial<GLTFLoaderOptions>;
+    }
+}
 /**
  * Mode that determines the coordinate system to use.
  */
@@ -146,35 +161,16 @@ export interface IGLTFLoader extends IDisposable {
     loadAsync: (scene: Scene, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string) => Promise<void>;
 }
 /**
- * File loader for loading glTF files into a scene.
+ * Adds default/implicit options to extension specific options.
  */
-export class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISceneLoaderPluginFactory {
-    /** @internal */
-    static _CreateGLTF1Loader: (parent: GLTFFileLoader) => IGLTFLoader;
-    /** @internal */
-    static _CreateGLTF2Loader: (parent: GLTFFileLoader) => IGLTFLoader;
+type DefaultExtensionOptions<BaseExtensionOptions> = {
     /**
-     * Raised when the asset has been parsed
+     * Defines if the extension is enabled
      */
-    onParsedObservable: Observable<IGLTFLoaderData>;
-    private _onParsedObserver;
-    /**
-     * Raised when the asset has been parsed
-     */
-    set onParsed(callback: (loaderData: IGLTFLoaderData) => void);
-    /**
-     * Set this property to false to disable incremental loading which delays the loader from calling the success callback until after loading the meshes and shaders.
-     * Textures always loads asynchronously. For example, the success callback can compute the bounding information of the loaded meshes when incremental loading is disabled.
-     * Defaults to true.
-     * @internal
-     */
-    static IncrementalLoading: boolean;
-    /**
-     * Set this property to true in order to work with homogeneous coordinates, available with some converters and exporters.
-     * Defaults to false. See https://en.wikipedia.org/wiki/Homogeneous_coordinates.
-     * @internal
-     */
-    static HomogeneousCoordinates: boolean;
+    enabled?: boolean;
+} & BaseExtensionOptions;
+class GLTFLoaderOptions {
+    constructor(options?: Partial<Readonly<GLTFLoaderOptions>>);
     /**
      * The coordinate system mode. Defaults to AUTO.
      */
@@ -264,6 +260,45 @@ export class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISc
      * You can also pass null if you don't want a root node to be created.
      */
     customRootNode?: Nullable<TransformNode>;
+    /**
+     * Defines options for glTF extensions.
+     */
+    extensionOptions: {
+        [Extension in keyof GLTFLoaderExtensionOptions]: {
+            [Option in keyof DefaultExtensionOptions<GLTFLoaderExtensionOptions[Extension]>]: DefaultExtensionOptions<GLTFLoaderExtensionOptions[Extension]>[Option];
+        };
+    };
+}
+/**
+ * File loader for loading glTF files into a scene.
+ */
+export class GLTFFileLoader extends GLTFLoaderOptions implements IDisposable, ISceneLoaderPluginAsync, ISceneLoaderPluginFactory {
+    /** @internal */
+    static _CreateGLTF1Loader: (parent: GLTFFileLoader) => IGLTFLoader;
+    /** @internal */
+    static _CreateGLTF2Loader: (parent: GLTFFileLoader) => IGLTFLoader;
+    /**
+     * Raised when the asset has been parsed
+     */
+    onParsedObservable: Observable<IGLTFLoaderData>;
+    private _onParsedObserver;
+    /**
+     * Raised when the asset has been parsed
+     */
+    set onParsed(callback: (loaderData: IGLTFLoaderData) => void);
+    /**
+     * Set this property to false to disable incremental loading which delays the loader from calling the success callback until after loading the meshes and shaders.
+     * Textures always loads asynchronously. For example, the success callback can compute the bounding information of the loaded meshes when incremental loading is disabled.
+     * Defaults to true.
+     * @internal
+     */
+    static IncrementalLoading: boolean;
+    /**
+     * Set this property to true in order to work with homogeneous coordinates, available with some converters and exporters.
+     * Defaults to false. See https://en.wikipedia.org/wiki/Homogeneous_coordinates.
+     * @internal
+     */
+    static HomogeneousCoordinates: boolean;
     /**
      * Observable raised when the loader creates a mesh after parsing the glTF properties of the mesh.
      * Note that the observable is raised as soon as the mesh object is created, meaning some data may not have been setup yet for this mesh (vertex data, morph targets, material, ...)
@@ -380,13 +415,20 @@ export class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISc
     private _state;
     private _progressCallback?;
     private _requests;
-    private static _MagicBase64Encoded;
+    private static readonly _MagicBase64Encoded;
     /**
      * Name of the loader ("gltf")
      */
-    name: string;
+    readonly name: string;
     /** @internal */
-    extensions: ISceneLoaderPluginExtensions;
+    readonly extensions: {
+        readonly ".gltf": {
+            readonly isBinary: false;
+        };
+        readonly ".glb": {
+            readonly isBinary: true;
+        };
+    };
     /**
      * Disposes the loader, releases resources during load, and cancels any outstanding requests.
      */
@@ -424,7 +466,7 @@ export class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISc
      */
     rewriteRootURL?(rootUrl: string, responseURL?: string): string;
     /** @internal */
-    createPlugin(): ISceneLoaderPluginAsync;
+    createPlugin(options: SceneLoaderPluginOptions): ISceneLoaderPluginAsync;
     /**
      * The loader state or null if the loader is not active.
      */
@@ -478,6 +520,7 @@ export class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISc
     private _endPerformanceCounterEnabled;
     private _endPerformanceCounterDisabled;
 }
+export {};
 
 }
 declare module "babylonjs-loaders/glTF/2.0/index" {
@@ -1535,6 +1578,20 @@ import { INode, IMaterial, IBuffer, IScene } from "babylonjs-loaders/glTF/2.0/gl
 import { IGLTFLoaderExtension } from "babylonjs-loaders/glTF/2.0/glTFLoaderExtension";
 import { GLTFLoader } from "babylonjs-loaders/glTF/2.0/glTFLoader";
 import { IProperty } from "babylonjs-gltf2interface";
+const NAME = "MSFT_lod";
+module "babylonjs-loaders/glTF/glTFFileLoader" {
+    interface GLTFLoaderExtensionOptions {
+        /**
+         * Defines options for the MSFT_lod extension.
+         */
+        [NAME]?: Partial<{
+            /**
+             * Maximum number of LODs to load, starting from the lowest LOD.
+             */
+            maxLODsToLoad: number;
+        }>;
+    }
+}
 /**
  * [Specification](https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Vendor/MSFT_lod/README.md)
  */
@@ -1617,6 +1674,7 @@ export class MSFT_lod implements IGLTFLoaderExtension {
     private _disposeTransformNode;
     private _disposeMaterials;
 }
+export {};
 
 }
 declare module "babylonjs-loaders/glTF/2.0/Extensions/MSFT_audio_emitter" {
@@ -3693,9 +3751,18 @@ export class GLTFBinaryExtension extends GLTFLoaderExtension {
 declare module "babylonjs-loaders/STL/stlFileLoader" {
 import { Nullable } from "babylonjs/types";
 import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
-import { ISceneLoaderPlugin, ISceneLoaderPluginExtensions } from "babylonjs/Loading/sceneLoader";
+import { ISceneLoaderPlugin } from "babylonjs/Loading/sceneLoader";
 import { AssetContainer } from "babylonjs/assetContainer";
 import { Scene } from "babylonjs/scene";
+const PLUGIN_STL = "stl";
+module "babylonjs/Loading/sceneLoader" {
+    interface SceneLoaderPluginOptions {
+        /**
+         * Defines options for the stl loader.
+         */
+        [PLUGIN_STL]?: {};
+    }
+}
 /**
  * STL file type loader.
  * This is a babylon scene loader plugin.
@@ -3712,13 +3779,17 @@ export class STLFileLoader implements ISceneLoaderPlugin {
     /**
      * Defines the name of the plugin.
      */
-    name: string;
+    readonly name: string;
     /**
      * Defines the extensions the stl loader is able to load.
      * force data to come in as an ArrayBuffer
      * we'll convert to string if it looks like it's an ASCII .stl
      */
-    extensions: ISceneLoaderPluginExtensions;
+    readonly extensions: {
+        readonly ".stl": {
+            readonly isBinary: true;
+        };
+    };
     /**
      * Defines if Y and Z axes are swapped or not when loading an STL file.
      * The default is false to maintain backward compatibility. When set to
@@ -3755,6 +3826,7 @@ export class STLFileLoader implements ISceneLoaderPlugin {
     private _parseBinary;
     private _parseASCII;
 }
+export {};
 
 }
 declare module "babylonjs-loaders/STL/index" {
@@ -3762,9 +3834,18 @@ export * from "babylonjs-loaders/STL/stlFileLoader";
 
 }
 declare module "babylonjs-loaders/SPLAT/splatFileLoader" {
-import { ISceneLoaderPluginAsync, ISceneLoaderPluginFactory, ISceneLoaderPlugin, ISceneLoaderAsyncResult, ISceneLoaderPluginExtensions, ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
+import { ISceneLoaderPluginAsync, ISceneLoaderPluginFactory, ISceneLoaderPlugin, ISceneLoaderAsyncResult, ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
 import { AssetContainer } from "babylonjs/assetContainer";
 import { Scene } from "babylonjs/scene";
+const PLUGIN_SPLAT = "splat";
+module "babylonjs/Loading/sceneLoader" {
+    interface SceneLoaderPluginOptions {
+        /**
+         * Defines options for the splat loader.
+         */
+        [PLUGIN_SPLAT]?: {};
+    }
+}
 /**
  * @experimental
  * SPLAT file type loader.
@@ -3774,12 +3855,19 @@ export class SPLATFileLoader implements ISceneLoaderPluginAsync, ISceneLoaderPlu
     /**
      * Defines the name of the plugin.
      */
-    name: string;
+    readonly name: string;
     /**
      * Defines the extensions the splat loader is able to load.
      * force data to come in as an ArrayBuffer
      */
-    extensions: ISceneLoaderPluginExtensions;
+    readonly extensions: {
+        readonly ".splat": {
+            readonly isBinary: true;
+        };
+        readonly ".ply": {
+            readonly isBinary: true;
+        };
+    };
     /**
      * Creates loader for gaussian splatting files
      */
@@ -3822,6 +3910,7 @@ export class SPLATFileLoader implements ISceneLoaderPluginAsync, ISceneLoaderPlu
      */
     loadAssetContainerAsync(_scene: Scene, _data: string, _rootUrl: string): Promise<AssetContainer>;
 }
+export {};
 
 }
 declare module "babylonjs-loaders/SPLAT/index" {
@@ -4050,6 +4139,15 @@ import { ISceneLoaderPluginAsync, ISceneLoaderPluginFactory, ISceneLoaderPlugin,
 import { AssetContainer } from "babylonjs/assetContainer";
 import { Scene } from "babylonjs/scene";
 import { OBJLoadingOptions } from "babylonjs-loaders/OBJ/objLoadingOptions";
+const PLUGIN_OBJ = "obj";
+module "babylonjs/Loading/sceneLoader" {
+    interface SceneLoaderPluginOptions {
+        /**
+         * Defines options for the obj loader.
+         */
+        [PLUGIN_OBJ]?: {};
+    }
+}
 /**
  * OBJ file type loader.
  * This is a babylon scene loader plugin.
@@ -4102,11 +4200,11 @@ export class OBJFileLoader implements ISceneLoaderPluginAsync, ISceneLoaderPlugi
     /**
      * Defines the name of the plugin.
      */
-    name: string;
+    readonly name: string;
     /**
      * Defines the extension the plugin is able to load.
      */
-    extensions: string;
+    readonly extensions: string;
     private _assetContainer;
     private _loadingOptions;
     /**
@@ -4175,6 +4273,7 @@ export class OBJFileLoader implements ISceneLoaderPluginAsync, ISceneLoaderPlugi
      */
     private _parseSolid;
 }
+export {};
 
 }
 declare module "babylonjs-loaders/OBJ/mtlFileLoader" {
@@ -4317,6 +4416,18 @@ declare module BABYLON {
     }
 
 
+    const PLUGIN_GLTF = "gltf";
+    /**
+     * Defines options for glTF loader extensions. This interface is extended by specific extensions.
+     */
+    export interface GLTFLoaderExtensionOptions extends Record<string, Record<string, unknown> | undefined> {
+    }
+        interface SceneLoaderPluginOptions {
+            /**
+             * Defines options for the glTF loader.
+             */
+            [PLUGIN_GLTF]?: Partial<GLTFLoaderOptions>;
+        }
     /**
      * Mode that determines the coordinate system to use.
      */
@@ -4401,35 +4512,16 @@ declare module BABYLON {
         loadAsync: (scene: Scene, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string) => Promise<void>;
     }
     /**
-     * File loader for loading glTF files into a scene.
+     * Adds default/implicit options to extension specific options.
      */
-    export class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISceneLoaderPluginFactory {
-        /** @internal */
-        static _CreateGLTF1Loader: (parent: GLTFFileLoader) => IGLTFLoader;
-        /** @internal */
-        static _CreateGLTF2Loader: (parent: GLTFFileLoader) => IGLTFLoader;
-        /**
-         * Raised when the asset has been parsed
-         */
-        onParsedObservable: Observable<IGLTFLoaderData>;
-        private _onParsedObserver;
-        /**
-         * Raised when the asset has been parsed
-         */
-        set onParsed(callback: (loaderData: IGLTFLoaderData) => void);
-        /**
-         * Set this property to false to disable incremental loading which delays the loader from calling the success callback until after loading the meshes and shaders.
-         * Textures always loads asynchronously. For example, the success callback can compute the bounding information of the loaded meshes when incremental loading is disabled.
-         * Defaults to true.
-         * @internal
-         */
-        static IncrementalLoading: boolean;
+    type DefaultExtensionOptions<BaseExtensionOptions> = {
         /**
-         * Set this property to true in order to work with homogeneous coordinates, available with some converters and exporters.
-         * Defaults to false. See https://en.wikipedia.org/wiki/Homogeneous_coordinates.
-         * @internal
+         * Defines if the extension is enabled
          */
-        static HomogeneousCoordinates: boolean;
+        enabled?: boolean;
+    } & BaseExtensionOptions;
+    class GLTFLoaderOptions {
+        constructor(options?: Partial<Readonly<GLTFLoaderOptions>>);
         /**
          * The coordinate system mode. Defaults to AUTO.
          */
@@ -4519,6 +4611,45 @@ declare module BABYLON {
          * You can also pass null if you don't want a root node to be created.
          */
         customRootNode?: Nullable<TransformNode>;
+        /**
+         * Defines options for glTF extensions.
+         */
+        extensionOptions: {
+            [Extension in keyof GLTFLoaderExtensionOptions]: {
+                [Option in keyof DefaultExtensionOptions<GLTFLoaderExtensionOptions[Extension]>]: DefaultExtensionOptions<GLTFLoaderExtensionOptions[Extension]>[Option];
+            };
+        };
+    }
+    /**
+     * File loader for loading glTF files into a scene.
+     */
+    export class GLTFFileLoader extends GLTFLoaderOptions implements IDisposable, ISceneLoaderPluginAsync, ISceneLoaderPluginFactory {
+        /** @internal */
+        static _CreateGLTF1Loader: (parent: GLTFFileLoader) => IGLTFLoader;
+        /** @internal */
+        static _CreateGLTF2Loader: (parent: GLTFFileLoader) => IGLTFLoader;
+        /**
+         * Raised when the asset has been parsed
+         */
+        onParsedObservable: Observable<IGLTFLoaderData>;
+        private _onParsedObserver;
+        /**
+         * Raised when the asset has been parsed
+         */
+        set onParsed(callback: (loaderData: IGLTFLoaderData) => void);
+        /**
+         * Set this property to false to disable incremental loading which delays the loader from calling the success callback until after loading the meshes and shaders.
+         * Textures always loads asynchronously. For example, the success callback can compute the bounding information of the loaded meshes when incremental loading is disabled.
+         * Defaults to true.
+         * @internal
+         */
+        static IncrementalLoading: boolean;
+        /**
+         * Set this property to true in order to work with homogeneous coordinates, available with some converters and exporters.
+         * Defaults to false. See https://en.wikipedia.org/wiki/Homogeneous_coordinates.
+         * @internal
+         */
+        static HomogeneousCoordinates: boolean;
         /**
          * Observable raised when the loader creates a mesh after parsing the glTF properties of the mesh.
          * Note that the observable is raised as soon as the mesh object is created, meaning some data may not have been setup yet for this mesh (vertex data, morph targets, material, ...)
@@ -4635,13 +4766,20 @@ declare module BABYLON {
         private _state;
         private _progressCallback?;
         private _requests;
-        private static _MagicBase64Encoded;
+        private static readonly _MagicBase64Encoded;
         /**
          * Name of the loader ("gltf")
          */
-        name: string;
+        readonly name = "gltf";
         /** @internal */
-        extensions: ISceneLoaderPluginExtensions;
+        readonly extensions: {
+            readonly ".gltf": {
+                readonly isBinary: false;
+            };
+            readonly ".glb": {
+                readonly isBinary: true;
+            };
+        };
         /**
          * Disposes the loader, releases resources during load, and cancels any outstanding requests.
          */
@@ -4679,7 +4817,7 @@ declare module BABYLON {
          */
         rewriteRootURL?(rootUrl: string, responseURL?: string): string;
         /** @internal */
-        createPlugin(): ISceneLoaderPluginAsync;
+        createPlugin(options: SceneLoaderPluginOptions): ISceneLoaderPluginAsync;
         /**
          * The loader state or null if the loader is not active.
          */
@@ -5737,7 +5875,19 @@ declare module BABYLON {
 
 }
 declare module BABYLON.GLTF2.Loader.Extensions {
-        /**
+        const NAME = "MSFT_lod";
+        interface GLTFLoaderExtensionOptions {
+            /**
+             * Defines options for the MSFT_lod extension.
+             */
+            [NAME]?: Partial<{
+                /**
+                 * Maximum number of LODs to load, starting from the lowest LOD.
+                 */
+                maxLODsToLoad: number;
+            }>;
+        }
+    /**
      * [Specification](https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Vendor/MSFT_lod/README.md)
      */
     export class MSFT_lod implements BABYLON.GLTF2.IGLTFLoaderExtension {
@@ -7892,6 +8042,13 @@ declare module BABYLON.GLTF1 {
 
 }
 declare module BABYLON {
+    const PLUGIN_STL = "stl";
+        interface SceneLoaderPluginOptions {
+            /**
+             * Defines options for the stl loader.
+             */
+            [PLUGIN_STL]?: {};
+        }
     /**
      * STL file type loader.
      * This is a babylon scene loader plugin.
@@ -7908,13 +8065,17 @@ declare module BABYLON {
         /**
          * Defines the name of the plugin.
          */
-        name: string;
+        readonly name = "stl";
         /**
          * Defines the extensions the stl loader is able to load.
          * force data to come in as an ArrayBuffer
          * we'll convert to string if it looks like it's an ASCII .stl
          */
-        extensions: ISceneLoaderPluginExtensions;
+        readonly extensions: {
+            readonly ".stl": {
+                readonly isBinary: true;
+            };
+        };
         /**
          * Defines if Y and Z axes are swapped or not when loading an STL file.
          * The default is false to maintain backward compatibility. When set to
@@ -7955,6 +8116,13 @@ declare module BABYLON {
 
 
 
+    const PLUGIN_SPLAT = "splat";
+        interface SceneLoaderPluginOptions {
+            /**
+             * Defines options for the splat loader.
+             */
+            [PLUGIN_SPLAT]?: {};
+        }
     /**
      * @experimental
      * SPLAT file type loader.
@@ -7964,12 +8132,19 @@ declare module BABYLON {
         /**
          * Defines the name of the plugin.
          */
-        name: string;
+        readonly name = "splat";
         /**
          * Defines the extensions the splat loader is able to load.
          * force data to come in as an ArrayBuffer
          */
-        extensions: ISceneLoaderPluginExtensions;
+        readonly extensions: {
+            readonly ".splat": {
+                readonly isBinary: true;
+            };
+            readonly ".ply": {
+                readonly isBinary: true;
+            };
+        };
         /**
          * Creates loader for gaussian splatting files
          */
@@ -8224,6 +8399,13 @@ declare module BABYLON {
     };
 
 
+    const PLUGIN_OBJ = "obj";
+        interface SceneLoaderPluginOptions {
+            /**
+             * Defines options for the obj loader.
+             */
+            [PLUGIN_OBJ]?: {};
+        }
     /**
      * OBJ file type loader.
      * This is a babylon scene loader plugin.
@@ -8276,11 +8458,11 @@ declare module BABYLON {
         /**
          * Defines the name of the plugin.
          */
-        name: string;
+        readonly name = "obj";
         /**
          * Defines the extension the plugin is able to load.
          */
-        extensions: string;
+        readonly extensions = ".obj";
         private _assetContainer;
         private _loadingOptions;
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-loaders",
-    "version": "7.19.1",
+    "version": "7.20.1",
     "main": "babylonjs.loaders.js",
     "types": "babylonjs.loaders.module.d.ts",
     "files": [
@@ -15,8 +15,8 @@
         "test:escheck": "es-check es6 ./babylonjs.loaders.js"
     },
     "dependencies": {
-        "babylonjs": "^7.19.1",
-        "babylonjs-gltf2interface": "^7.19.1"
+        "babylonjs": "^7.20.1",
+        "babylonjs-gltf2interface": "^7.20.1"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",