babylonjs-loaders 6.39.0 → 6.41.0

package/babylonjs.loaders.module.d.ts

@@ -89,6 +89,7 @@ export abstract class GLTFLoaderExtension {
      * @param rootUrl
      * @param onSuccess
      * @param onError
+     * @returns true to stop further extensions from loading the runtime
      */
     loadRuntimeAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onSuccess?: (gltfRuntime: IGLTFRuntime) => void, onError?: (message: string) => void): boolean;
     /**
@@ -97,6 +98,7 @@ export abstract class GLTFLoaderExtension {
      * @param gltfRuntime
      * @param onSuccess
      * @param onError
+     * @returns true to stop further extensions from creating the runtime
      */
     loadRuntimeExtensionsAsync(gltfRuntime: IGLTFRuntime, onSuccess: () => void, onError?: (message: string) => void): boolean;
     /**
@@ -107,6 +109,7 @@ export abstract class GLTFLoaderExtension {
      * @param onSuccess
      * @param onError
      * @param onProgress
+     * @returns true to stop further extensions from loading this buffer
      */
     loadBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void, onProgress?: () => void): boolean;
     /**
@@ -116,6 +119,7 @@ export abstract class GLTFLoaderExtension {
      * @param id
      * @param onSuccess
      * @param onError
+     * @returns true to stop further extensions from loading this texture data
      */
     loadTextureBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void): boolean;
     /**
@@ -126,6 +130,7 @@ export abstract class GLTFLoaderExtension {
      * @param buffer
      * @param onSuccess
      * @param onError
+     * @returns true to stop further extensions from loading this texture
      */
     createTextureAsync(gltfRuntime: IGLTFRuntime, id: string, buffer: ArrayBufferView, onSuccess: (texture: Texture) => void, onError: (message: string) => void): boolean;
     /**
@@ -135,6 +140,7 @@ export abstract class GLTFLoaderExtension {
      * @param id
      * @param onSuccess
      * @param onError
+     * @returns true to stop further extensions from loading this shader data
      */
     loadShaderStringAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (shaderString: string) => void, onError: (message: string) => void): boolean;
     /**
@@ -144,6 +150,7 @@ export abstract class GLTFLoaderExtension {
      * @param id
      * @param onSuccess
      * @param onError
+     * @returns true to stop further extensions from loading this material
      */
     loadMaterialAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (material: Material) => void, onError: (message: string) => void): boolean;
     static LoadRuntimeAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onSuccess?: (gltfRuntime: IGLTFRuntime) => void, onError?: (message: string) => void): void;
@@ -601,16 +608,19 @@ export class GLTFUtils {
      * @param uniform the name of the shader's uniform
      * @param value the value of the uniform
      * @param type the uniform's type (EParameterType FLOAT, VEC2, VEC3 or VEC4)
+     * @returns true if set, else false
      */
     static SetUniform(shaderMaterial: ShaderMaterial | Effect, uniform: string, value: any, type: number): boolean;
     /**
      * Returns the wrap mode of the texture
      * @param mode the mode value
+     * @returns the wrap mode (TEXTURE_WRAP_ADDRESSMODE, MIRROR_ADDRESSMODE or CLAMP_ADDRESSMODE)
      */
     static GetWrapMode(mode: number): number;
     /**
      * Returns the byte stride giving an accessor
      * @param accessor the GLTF accessor objet
+     * @returns the byte stride
      */
     static GetByteStrideFromType(accessor: IGLTFAccessor): number;
     /**
@@ -624,17 +634,20 @@ export class GLTFUtils {
      * Returns a buffer from its accessor
      * @param gltfRuntime the GLTF runtime
      * @param accessor the GLTF accessor
+     * @returns an array buffer view
      */
     static GetBufferFromAccessor(gltfRuntime: IGLTFRuntime, accessor: IGLTFAccessor): any;
     /**
      * Decodes a buffer view into a string
      * @param view the buffer view
+     * @returns a string
      */
     static DecodeBufferToText(view: ArrayBufferView): string;
     /**
      * Returns the default material of gltf. Related to
      * https://github.com/KhronosGroup/glTF/tree/master/specification/1.0#appendix-a-default-material
      * @param scene the Babylon.js scene
+     * @returns the default Babylon material
      */
     static GetDefaultMaterial(scene: Scene): ShaderMaterial;
     private static _DefaultMaterial;
@@ -876,6 +889,9 @@ export class GLTFPathToObjectConverter<T> implements IPathToObjectConverter<T> {
      *  - "/materials/2/emissiveFactor"
      *  - "/materials/2/pbrMetallicRoughness/baseColorFactor"
      *  - "/materials/2/extensions/KHR_materials_emissive_strength/emissiveStrength"
+     *
+     * @param path The path to convert
+     * @returns The object and info associated with the path
      */
     convert(path: string): IObjectInfo<T>;
 }
@@ -2062,7 +2078,7 @@ export class MSFT_lod implements IGLTFLoaderExtension {
     loadBufferAsync(context: string, buffer: IBuffer, byteOffset: number, byteLength: number): Nullable<Promise<ArrayBufferView>>;
     private _loadBufferLOD;
     /**
-     * Gets an array of LOD properties from lowest to highest.
+     * @returns an array of LOD properties from lowest to highest.
      * @param context
      * @param property
      * @param array
@@ -2238,9 +2254,9 @@ export class GLTFLoader implements IGLTFLoader {
      */
     get babylonScene(): Scene;
     /**
-     * The root Babylon mesh when loading the asset.
+     * The root Babylon node when loading the asset.
      */
-    get rootBabylonMesh(): Nullable<Mesh>;
+    get rootBabylonMesh(): Nullable<TransformNode>;
     /**
      * The root url when loading the asset.
      */
@@ -3210,9 +3226,15 @@ export class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISc
     alwaysComputeSkeletonRootNode: boolean;
     /**
      * Function called before loading a url referenced by the asset.
-     * @param url
+     * @param url url referenced by the asset
+     * @returns Async url to load
      */
     preprocessUrlAsync: (url: string) => Promise<string>;
+    /**
+     * 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>;
     /**
      * 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, ...)
@@ -3906,11 +3928,13 @@ export class SPLATFileLoader implements ISceneLoaderPluginAsync, ISceneLoaderPlu
      * Code from https://github.com/dylanebert/gsplat.js/blob/main/src/loaders/PLYLoader.ts Under MIT license
      * Loads a .ply from data array buffer
      * if data array buffer is not ply, returns the original buffer
+     * @param data the data to load
+     * @returns the loaded buffer
      */
     private _loadPLY;
     /**
      * Imports  from the loaded gaussian splatting data and adds them to the scene
-     * @param meshesNames a string or array of strings of the mesh names that should be loaded from the file
+     * @param _meshesNames a string or array of strings of the mesh names that should be loaded from the file
      * @param scene the scene the meshes should be added to
      * @param data the gaussian splatting data to load
      * @param rootUrl root url to load from
@@ -3921,15 +3945,15 @@ export class SPLATFileLoader implements ISceneLoaderPluginAsync, ISceneLoaderPlu
      * Imports all objects from the loaded gaussian splatting data and adds them to the scene
      * @param scene the scene the objects should be added to
      * @param data the gaussian splatting data to load
-     * @param rootUrl root url to load from
+     * @param _rootUrl root url to load from
      * @returns a promise which completes when objects have been loaded to the scene
      */
     loadAsync(scene: Scene, data: any, _rootUrl: string): Promise<void>;
     /**
      * Load into an asset container.
-     * @param scene The scene to load into
-     * @param data The data to import
-     * @param rootUrl The root url for scene and resources
+     * @param _scene The scene to load into
+     * @param _data The data to import
+     * @param _rootUrl The root url for scene and resources
      * @returns The loaded asset container
      */
     loadAssetContainerAsync(_scene: Scene, _data: string, _rootUrl: string): Promise<AssetContainer>;
@@ -4147,6 +4171,7 @@ declare module BABYLON.GLTF1 {
          * @param rootUrl
          * @param onSuccess
          * @param onError
+         * @returns true to stop further extensions from loading the runtime
          */
         loadRuntimeAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onSuccess?: (gltfRuntime: BABYLON.GLTF1.IGLTFRuntime) => void, onError?: (message: string) => void): boolean;
         /**
@@ -4155,6 +4180,7 @@ declare module BABYLON.GLTF1 {
          * @param gltfRuntime
          * @param onSuccess
          * @param onError
+         * @returns true to stop further extensions from creating the runtime
          */
         loadRuntimeExtensionsAsync(gltfRuntime: BABYLON.GLTF1.IGLTFRuntime, onSuccess: () => void, onError?: (message: string) => void): boolean;
         /**
@@ -4165,6 +4191,7 @@ declare module BABYLON.GLTF1 {
          * @param onSuccess
          * @param onError
          * @param onProgress
+         * @returns true to stop further extensions from loading this buffer
          */
         loadBufferAsync(gltfRuntime: BABYLON.GLTF1.IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void, onProgress?: () => void): boolean;
         /**
@@ -4174,6 +4201,7 @@ declare module BABYLON.GLTF1 {
          * @param id
          * @param onSuccess
          * @param onError
+         * @returns true to stop further extensions from loading this texture data
          */
         loadTextureBufferAsync(gltfRuntime: BABYLON.GLTF1.IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void): boolean;
         /**
@@ -4184,6 +4212,7 @@ declare module BABYLON.GLTF1 {
          * @param buffer
          * @param onSuccess
          * @param onError
+         * @returns true to stop further extensions from loading this texture
          */
         createTextureAsync(gltfRuntime: BABYLON.GLTF1.IGLTFRuntime, id: string, buffer: ArrayBufferView, onSuccess: (texture: Texture) => void, onError: (message: string) => void): boolean;
         /**
@@ -4193,6 +4222,7 @@ declare module BABYLON.GLTF1 {
          * @param id
          * @param onSuccess
          * @param onError
+         * @returns true to stop further extensions from loading this shader data
          */
         loadShaderStringAsync(gltfRuntime: BABYLON.GLTF1.IGLTFRuntime, id: string, onSuccess: (shaderString: string) => void, onError: (message: string) => void): boolean;
         /**
@@ -4202,6 +4232,7 @@ declare module BABYLON.GLTF1 {
          * @param id
          * @param onSuccess
          * @param onError
+         * @returns true to stop further extensions from loading this material
          */
         loadMaterialAsync(gltfRuntime: BABYLON.GLTF1.IGLTFRuntime, id: string, onSuccess: (material: Material) => void, onError: (message: string) => void): boolean;
         static LoadRuntimeAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onSuccess?: (gltfRuntime: BABYLON.GLTF1.IGLTFRuntime) => void, onError?: (message: string) => void): void;
@@ -4656,16 +4687,19 @@ declare module BABYLON.GLTF1 {
          * @param uniform the name of the shader's uniform
          * @param value the value of the uniform
          * @param type the uniform's type (EParameterType FLOAT, VEC2, VEC3 or VEC4)
+         * @returns true if set, else false
          */
         static SetUniform(shaderMaterial: ShaderMaterial | Effect, uniform: string, value: any, type: number): boolean;
         /**
          * Returns the wrap mode of the texture
          * @param mode the mode value
+         * @returns the wrap mode (TEXTURE_WRAP_ADDRESSMODE, MIRROR_ADDRESSMODE or CLAMP_ADDRESSMODE)
          */
         static GetWrapMode(mode: number): number;
         /**
          * Returns the byte stride giving an accessor
          * @param accessor the GLTF accessor objet
+         * @returns the byte stride
          */
         static GetByteStrideFromType(accessor: BABYLON.GLTF1.IGLTFAccessor): number;
         /**
@@ -4679,17 +4713,20 @@ declare module BABYLON.GLTF1 {
          * Returns a buffer from its accessor
          * @param gltfRuntime the GLTF runtime
          * @param accessor the GLTF accessor
+         * @returns an array buffer view
          */
         static GetBufferFromAccessor(gltfRuntime: BABYLON.GLTF1.IGLTFRuntime, accessor: BABYLON.GLTF1.IGLTFAccessor): any;
         /**
          * Decodes a buffer view into a string
          * @param view the buffer view
+         * @returns a string
          */
         static DecodeBufferToText(view: ArrayBufferView): string;
         /**
          * Returns the default material of gltf. Related to
          * https://github.com/KhronosGroup/glTF/tree/master/specification/1.0#appendix-a-default-material
          * @param scene the Babylon.js scene
+         * @returns the default Babylon material
          */
         static GetDefaultMaterial(scene: Scene): ShaderMaterial;
         private static _DefaultMaterial;
@@ -4932,6 +4969,9 @@ declare module BABYLON.GLTF2.Loader.Extensions {
          *  - "/materials/2/emissiveFactor"
          *  - "/materials/2/pbrMetallicRoughness/baseColorFactor"
          *  - "/materials/2/extensions/KHR_materials_emissive_strength/emissiveStrength"
+         *
+         * @param path The path to convert
+         * @returns The object and info associated with the path
          */
         convert(path: string): IObjectInfo<T>;
     }
@@ -6102,7 +6142,7 @@ declare module BABYLON.GLTF2.Loader.Extensions {
         loadBufferAsync(context: string, buffer: BABYLON.GLTF2.Loader.IBuffer, byteOffset: number, byteLength: number): Nullable<Promise<ArrayBufferView>>;
         private _loadBufferLOD;
         /**
-         * Gets an array of LOD properties from lowest to highest.
+         * @returns an array of LOD properties from lowest to highest.
          * @param context
          * @param property
          * @param array
@@ -6260,9 +6300,9 @@ declare module BABYLON.GLTF2 {
          */
         get babylonScene(): Scene;
         /**
-         * The root Babylon mesh when loading the asset.
+         * The root Babylon node when loading the asset.
          */
-        get rootBabylonMesh(): Nullable<Mesh>;
+        get rootBabylonMesh(): Nullable<TransformNode>;
         /**
          * The root url when loading the asset.
          */
@@ -7205,9 +7245,15 @@ declare module BABYLON {
         alwaysComputeSkeletonRootNode: boolean;
         /**
          * Function called before loading a url referenced by the asset.
-         * @param url
+         * @param url url referenced by the asset
+         * @returns Async url to load
          */
         preprocessUrlAsync: (url: string) => Promise<string>;
+        /**
+         * 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>;
         /**
          * 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, ...)
@@ -7858,11 +7904,13 @@ declare module BABYLON {
          * Code from https://github.com/dylanebert/gsplat.js/blob/main/src/loaders/PLYLoader.ts Under MIT license
          * Loads a .ply from data array buffer
          * if data array buffer is not ply, returns the original buffer
+         * @param data the data to load
+         * @returns the loaded buffer
          */
         private _loadPLY;
         /**
          * Imports  from the loaded gaussian splatting data and adds them to the scene
-         * @param meshesNames a string or array of strings of the mesh names that should be loaded from the file
+         * @param _meshesNames a string or array of strings of the mesh names that should be loaded from the file
          * @param scene the scene the meshes should be added to
          * @param data the gaussian splatting data to load
          * @param rootUrl root url to load from
@@ -7873,15 +7921,15 @@ declare module BABYLON {
          * Imports all objects from the loaded gaussian splatting data and adds them to the scene
          * @param scene the scene the objects should be added to
          * @param data the gaussian splatting data to load
-         * @param rootUrl root url to load from
+         * @param _rootUrl root url to load from
          * @returns a promise which completes when objects have been loaded to the scene
          */
         loadAsync(scene: Scene, data: any, _rootUrl: string): Promise<void>;
         /**
          * Load into an asset container.
-         * @param scene The scene to load into
-         * @param data The data to import
-         * @param rootUrl The root url for scene and resources
+         * @param _scene The scene to load into
+         * @param _data The data to import
+         * @param _rootUrl The root url for scene and resources
          * @returns The loaded asset container
          */
         loadAssetContainerAsync(_scene: Scene, _data: string, _rootUrl: string): Promise<AssetContainer>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-loaders",
-    "version": "6.39.0",
+    "version": "6.41.0",
     "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": "^6.39.0",
-        "babylonjs-gltf2interface": "^6.39.0"
+        "babylonjs": "^6.41.0",
+        "babylonjs-gltf2interface": "^6.41.0"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",