babylonjs-loaders 8.26.0 → 8.26.2

package/babylonjs.loaders.module.d.ts

@@ -195,12 +195,15 @@ type DefaultExtensionOptions<BaseExtensionOptions> = {
      */
     enabled?: boolean;
 } & BaseExtensionOptions;
-abstract class GLTFLoaderOptions {
-    protected copyFrom(options?: Partial<Readonly<GLTFLoaderOptions>>): void;
-    /**
-     * Raised when the asset has been parsed
-     */
-    abstract onParsed?: ((loaderData: IGLTFLoaderData) => void) | undefined;
+/**
+ * This class contains all the concrete (not abstract) glTF options, excluding callbacks.
+ * The purpose of this class is to make it easy to provide a way to mutate the default
+ * loader options (see the GLTFLoaderDefaultOptions instance below) without duplicating
+ * all the options in yet another object. Since this class is instantiated for the default
+ * options object, abstract properties and callbacks are not included, it's more just
+ * flag-type options.
+ */
+class GLTFLoaderBaseOptions {
     /**
      * Defines if the loader should always compute the bounding boxes of meshes and not use the min/max values from the position accessor. Defaults to false.
      */
@@ -214,10 +217,6 @@ abstract class GLTFLoaderOptions {
      * The animation start mode. Defaults to FIRST.
      */
     animationStartMode: GLTFLoaderAnimationStartMode;
-    /**
-     * Defines if the loader should capture performance counters.
-     */
-    abstract capturePerformanceCounters: boolean;
     /**
      * Defines if the loader should compile materials before raising the success callback. Defaults to false.
      */
@@ -234,19 +233,6 @@ abstract class GLTFLoaderOptions {
      * Defines if the loader should create instances when multiple glTF nodes point to the same glTF mesh. Defaults to true.
      */
     createInstances: boolean;
-    /**
-     * Defines the node to use as the root of the hierarchy when loading the scene (default: undefined). If not defined, a root node will be automatically created.
-     * 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];
-        };
-    };
     /**
      * If true, load all materials defined in the file, even if not used by any mesh. Defaults to false.
      */
@@ -268,42 +254,6 @@ abstract class GLTFLoaderOptions {
      * Defines if the loader should load skins. Defaults to true.
      */
     loadSkins: boolean;
-    /**
-     * If true, enable logging for the loader. Defaults to false.
-     */
-    abstract loggingEnabled: boolean;
-    /**
-     * Callback raised when the loader creates a camera after parsing the glTF properties of the camera.
-     */
-    abstract onCameraLoaded?: (camera: Camera) => void;
-    /**
-     * Callback raised when the loader creates a material after parsing the glTF properties of the material.
-     */
-    abstract onMaterialLoaded?: (material: Material) => void;
-    /**
-     * Callback raised when the loader creates a mesh after parsing the glTF properties of the mesh.
-     * Note that the callback is called 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, ...)
-     */
-    abstract onMeshLoaded?: (mesh: AbstractMesh) => void;
-    /**
-     * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
-     * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
-     */
-    abstract onSkinLoaded?: (node: TransformNode, skinnedNode: TransformNode) => void;
-    /**
-     * Callback raised when the loader creates a texture after parsing the glTF properties of the texture.
-     */
-    abstract onTextureLoaded?: (texture: BaseTexture) => void;
-    /**
-     * Callback raised after the asset is validated.
-     */
-    abstract onValidated?: (results: GLTF2.IGLTFValidationResults) => void;
-    /**
-     * Function called before loading a url referenced by the asset.
-     * @param url url referenced by the asset
-     * @returns Async url to load
-     */
-    preprocessUrlAsync: (url: string) => Promise<string>;
     /**
      * If true, do not load any materials defined in the file. Defaults to false.
      */
@@ -342,6 +292,72 @@ abstract class GLTFLoaderOptions {
      */
     validate: boolean;
 }
+/**
+ * The default GLTF loader options.
+ * Override the properties of this object to globally change the default loader options.
+ * To specify options for a specific load call, pass those options into the associated load function.
+ */
+export const GLTFLoaderDefaultOptions: GLTFLoaderBaseOptions;
+abstract class GLTFLoaderOptions extends GLTFLoaderBaseOptions {
+    protected copyFrom(options?: Partial<Readonly<GLTFLoaderOptions>>): void;
+    /**
+     * Raised when the asset has been parsed
+     */
+    abstract onParsed?: ((loaderData: IGLTFLoaderData) => void) | undefined;
+    /**
+     * Defines if the loader should capture performance counters.
+     */
+    abstract capturePerformanceCounters: boolean;
+    /**
+     * Defines the node to use as the root of the hierarchy when loading the scene (default: undefined). If not defined, a root node will be automatically created.
+     * 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];
+        };
+    };
+    /**
+     * If true, enable logging for the loader. Defaults to false.
+     */
+    abstract loggingEnabled: boolean;
+    /**
+     * Callback raised when the loader creates a camera after parsing the glTF properties of the camera.
+     */
+    abstract onCameraLoaded?: (camera: Camera) => void;
+    /**
+     * Callback raised when the loader creates a material after parsing the glTF properties of the material.
+     */
+    abstract onMaterialLoaded?: (material: Material) => void;
+    /**
+     * Callback raised when the loader creates a mesh after parsing the glTF properties of the mesh.
+     * Note that the callback is called 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, ...)
+     */
+    abstract onMeshLoaded?: (mesh: AbstractMesh) => void;
+    /**
+     * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
+     */
+    abstract onSkinLoaded?: (node: TransformNode, skinnedNode: TransformNode) => void;
+    /**
+     * Callback raised when the loader creates a texture after parsing the glTF properties of the texture.
+     */
+    abstract onTextureLoaded?: (texture: BaseTexture) => void;
+    /**
+     * Callback raised after the asset is validated.
+     */
+    abstract onValidated?: (results: GLTF2.IGLTFValidationResults) => void;
+    /**
+     * Function called before loading a url referenced by the asset.
+     * @param url url referenced by the asset
+     * @returns Async url to load
+     */
+    preprocessUrlAsync: (url: string) => Promise<string>;
+}
 /**
  * File loader for loading glTF files into a scene.
  */
@@ -5794,12 +5810,15 @@ declare module BABYLON {
          */
         enabled?: boolean;
     } & BaseExtensionOptions;
-    abstract class GLTFLoaderOptions {
-        protected copyFrom(options?: Partial<Readonly<GLTFLoaderOptions>>): void;
-        /**
-         * Raised when the asset has been parsed
-         */
-        abstract onParsed?: ((loaderData: IGLTFLoaderData) => void) | undefined;
+    /**
+     * This class contains all the concrete (not abstract) glTF options, excluding callbacks.
+     * The purpose of this class is to make it easy to provide a way to mutate the default
+     * loader options (see the GLTFLoaderDefaultOptions instance below) without duplicating
+     * all the options in yet another object. Since this class is instantiated for the default
+     * options object, abstract properties and callbacks are not included, it's more just
+     * flag-type options.
+     */
+    class GLTFLoaderBaseOptions {
         /**
          * Defines if the loader should always compute the bounding boxes of meshes and not use the min/max values from the position accessor. Defaults to false.
          */
@@ -5813,10 +5832,6 @@ declare module BABYLON {
          * The animation start mode. Defaults to FIRST.
          */
         animationStartMode: GLTFLoaderAnimationStartMode;
-        /**
-         * Defines if the loader should capture performance counters.
-         */
-        abstract capturePerformanceCounters: boolean;
         /**
          * Defines if the loader should compile materials before raising the success callback. Defaults to false.
          */
@@ -5833,19 +5848,6 @@ declare module BABYLON {
          * Defines if the loader should create instances when multiple glTF nodes point to the same glTF mesh. Defaults to true.
          */
         createInstances: boolean;
-        /**
-         * Defines the node to use as the root of the hierarchy when loading the scene (default: undefined). If not defined, a root node will be automatically created.
-         * 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];
-            };
-        };
         /**
          * If true, load all materials defined in the file, even if not used by any mesh. Defaults to false.
          */
@@ -5867,42 +5869,6 @@ declare module BABYLON {
          * Defines if the loader should load skins. Defaults to true.
          */
         loadSkins: boolean;
-        /**
-         * If true, enable logging for the loader. Defaults to false.
-         */
-        abstract loggingEnabled: boolean;
-        /**
-         * Callback raised when the loader creates a camera after parsing the glTF properties of the camera.
-         */
-        abstract onCameraLoaded?: (camera: Camera) => void;
-        /**
-         * Callback raised when the loader creates a material after parsing the glTF properties of the material.
-         */
-        abstract onMaterialLoaded?: (material: Material) => void;
-        /**
-         * Callback raised when the loader creates a mesh after parsing the glTF properties of the mesh.
-         * Note that the callback is called 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, ...)
-         */
-        abstract onMeshLoaded?: (mesh: AbstractMesh) => void;
-        /**
-         * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
-         * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
-         */
-        abstract onSkinLoaded?: (node: TransformNode, skinnedNode: TransformNode) => void;
-        /**
-         * Callback raised when the loader creates a texture after parsing the glTF properties of the texture.
-         */
-        abstract onTextureLoaded?: (texture: BaseTexture) => void;
-        /**
-         * Callback raised after the asset is validated.
-         */
-        abstract onValidated?: (results: GLTF2.IGLTFValidationResults) => void;
-        /**
-         * Function called before loading a url referenced by the asset.
-         * @param url url referenced by the asset
-         * @returns Async url to load
-         */
-        preprocessUrlAsync: (url: string) => Promise<string>;
         /**
          * If true, do not load any materials defined in the file. Defaults to false.
          */
@@ -5941,6 +5907,72 @@ declare module BABYLON {
          */
         validate: boolean;
     }
+    /**
+     * The default GLTF loader options.
+     * Override the properties of this object to globally change the default loader options.
+     * To specify options for a specific load call, pass those options into the associated load function.
+     */
+    export var GLTFLoaderDefaultOptions: GLTFLoaderBaseOptions;
+    abstract class GLTFLoaderOptions extends GLTFLoaderBaseOptions {
+        protected copyFrom(options?: Partial<Readonly<GLTFLoaderOptions>>): void;
+        /**
+         * Raised when the asset has been parsed
+         */
+        abstract onParsed?: ((loaderData: IGLTFLoaderData) => void) | undefined;
+        /**
+         * Defines if the loader should capture performance counters.
+         */
+        abstract capturePerformanceCounters: boolean;
+        /**
+         * Defines the node to use as the root of the hierarchy when loading the scene (default: undefined). If not defined, a root node will be automatically created.
+         * 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];
+            };
+        };
+        /**
+         * If true, enable logging for the loader. Defaults to false.
+         */
+        abstract loggingEnabled: boolean;
+        /**
+         * Callback raised when the loader creates a camera after parsing the glTF properties of the camera.
+         */
+        abstract onCameraLoaded?: (camera: Camera) => void;
+        /**
+         * Callback raised when the loader creates a material after parsing the glTF properties of the material.
+         */
+        abstract onMaterialLoaded?: (material: Material) => void;
+        /**
+         * Callback raised when the loader creates a mesh after parsing the glTF properties of the mesh.
+         * Note that the callback is called 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, ...)
+         */
+        abstract onMeshLoaded?: (mesh: AbstractMesh) => void;
+        /**
+         * Callback raised when the loader creates a skin after parsing the glTF properties of the skin node.
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/glTF/glTFSkinning#ignoring-the-transform-of-the-skinned-mesh
+         */
+        abstract onSkinLoaded?: (node: TransformNode, skinnedNode: TransformNode) => void;
+        /**
+         * Callback raised when the loader creates a texture after parsing the glTF properties of the texture.
+         */
+        abstract onTextureLoaded?: (texture: BaseTexture) => void;
+        /**
+         * Callback raised after the asset is validated.
+         */
+        abstract onValidated?: (results: GLTF2.IGLTFValidationResults) => void;
+        /**
+         * Function called before loading a url referenced by the asset.
+         * @param url url referenced by the asset
+         * @returns Async url to load
+         */
+        preprocessUrlAsync: (url: string) => Promise<string>;
+    }
     /**
      * File loader for loading glTF files into a scene.
      */

package/package.json

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