babylonjs-loaders 7.23.0 → 7.23.1

package/babylonjs.loaders.d.ts

@@ -2,6 +2,13 @@
 declare module BABYLON {
 
 
+    /**
+     * Registers the async plugin factories for all built-in loaders.
+     * Loaders will be dynamically imported on demand, only when a SceneLoader load operation needs each respective loader.
+     */
+    export function registerBuiltInLoaders(): void;
+
+
 
 
     /**
@@ -34,7 +41,21 @@ declare module BABYLON {
     }
 
 
-    const PLUGIN_GLTF = "gltf";
+    export const GLTFMagicBase64Encoded = "Z2xURg";
+    export var GLTFFileLoaderMetadata: {
+        readonly name: "gltf";
+        readonly extensions: {
+            readonly ".gltf": {
+                readonly isBinary: false;
+            };
+            readonly ".glb": {
+                readonly isBinary: true;
+            };
+        };
+        readonly canDirectLoad: (data: string) => boolean;
+    };
+
+
     /**
      * Defines options for glTF loader extensions. This interface is extended by specific extensions.
      */
@@ -44,7 +65,7 @@ declare module BABYLON {
             /**
              * Defines options for the glTF loader.
              */
-            [PLUGIN_GLTF]: Partial<GLTFLoaderOptions>;
+            [GLTFFileLoaderMetadata.name]: Partial<GLTFLoaderOptions>;
         }
     /**
      * Mode that determines the coordinate system to use.
@@ -421,11 +442,10 @@ declare module BABYLON {
         private _state;
         private _progressCallback?;
         private _requests;
-        private static readonly _MagicBase64Encoded;
         /**
          * Name of the loader ("gltf")
          */
-        readonly name = "gltf";
+        readonly name: "gltf";
         /** @internal */
         readonly extensions: {
             readonly ".gltf": {
@@ -784,6 +804,37 @@ declare module BABYLON.GLTF2.Loader {
 
 
 
+}
+declare module BABYLON {
+
+
+}
+declare module BABYLON.GLTF2 {
+        interface IRegisteredGLTFExtension {
+        isGLTFExtension: boolean;
+        factory: GLTFExtensionFactory;
+    }
+    export type GLTFExtensionFactory = (loader: BABYLON.GLTF2.GLTFLoader) => BABYLON.GLTF2.IGLTFLoaderExtension | Promise<BABYLON.GLTF2.IGLTFLoaderExtension>;
+    /**
+     * All currently registered glTF 2.0 loader extensions.
+     */
+    export var registeredGLTFExtensions: ReadonlyMap<string, Readonly<IRegisteredGLTFExtension>>;
+    /**
+     * Registers a loader extension.
+     * @param name The name of the loader extension.
+     * @param isGLTFExtension If the loader extension is a glTF extension, then it will only be used for glTF files that use the corresponding glTF extension. Otherwise, it will be used for all loaded glTF files.
+     * @param factory The factory function that creates the loader extension.
+     */
+    export function registerGLTFExtension(name: string, isGLTFExtension: boolean, factory: GLTFExtensionFactory): void;
+    /**
+     * Unregisters a loader extension.
+     * @param name The name of the loader extension.
+     * @returns A boolean indicating whether the extension has been unregistered
+     */
+    export function unregisterGLTFExtension(name: string): boolean;
+
+
+
 }
 declare module BABYLON {
 
@@ -1056,7 +1107,6 @@ declare module BABYLON.GLTF2 {
         private _rootBabylonMesh;
         private _defaultBabylonMaterialData;
         private readonly _postSceneLoadActions;
-        private static _RegisteredExtensions;
         /**
          * The default glTF sampler.
          */
@@ -1065,12 +1115,14 @@ declare module BABYLON.GLTF2 {
          * Registers a loader extension.
          * @param name The name of the loader extension.
          * @param factory The factory function that creates the loader extension.
+         * @deprecated Please use registerGLTFExtension instead.
          */
-        static RegisterExtension(name: string, factory: (loader: GLTFLoader) => BABYLON.GLTF2.IGLTFLoaderExtension): void;
+        static RegisterExtension(name: string, factory: BABYLON.GLTF2.GLTFExtensionFactory): void;
         /**
          * Unregisters a loader extension.
          * @param name The name of the loader extension.
          * @returns A boolean indicating whether the extension has been unregistered
+         * @deprecated Please use unregisterGLTFExtension instead.
          */
         static UnregisterExtension(name: string): boolean;
         /**
@@ -1114,8 +1166,7 @@ declare module BABYLON.GLTF2 {
         private _loadAsync;
         private _loadData;
         private _setupData;
-        private _loadExtensions;
-        private _checkExtensions;
+        private _loadExtensionsAsync;
         private _createRootNode;
         /**
          * Loads a glTF scene.
@@ -1490,6 +1541,19 @@ declare module BABYLON.GLTF2.Loader.Extensions {
 
 
 
+}
+declare module BABYLON {
+
+
+}
+declare module BABYLON.GLTF2.Loader.Extensions {
+        /**
+     * Registers the built-in glTF 2.0 extension async factories, which dynamically imports and loads each glTF extension on demand (e.g. only when a glTF model uses the extension).
+     */
+    export function registerBuiltInGLTFExtensions(): void;
+
+
+
 }
 declare module BABYLON {
 
@@ -3899,12 +3963,21 @@ declare module BABYLON.GLTF1 {
 }
 declare module BABYLON {
 
-    const PLUGIN_STL = "stl";
+    export var STLFileLoaderMetadata: {
+        readonly name: "stl";
+        readonly extensions: {
+            readonly ".stl": {
+                readonly isBinary: true;
+            };
+        };
+    };
+
+
         interface SceneLoaderPluginOptions {
             /**
              * Defines options for the stl loader.
              */
-            [PLUGIN_STL]: {};
+            [STLFileLoaderMetadata.name]: {};
         }
     /**
      * STL file type loader.
@@ -3922,7 +3995,7 @@ declare module BABYLON {
         /**
          * Defines the name of the plugin.
          */
-        readonly name = "stl";
+        readonly name: "stl";
         /**
          * Defines the extensions the stl loader is able to load.
          * force data to come in as an ArrayBuffer
@@ -3973,12 +4046,35 @@ declare module BABYLON {
 
 
 
-    const PLUGIN_SPLAT = "splat";
+    /**
+     * Options for loading Gaussian Splatting and PLY files
+     */
+    export type SPLATLoadingOptions = {
+        /**
+         * Defines if buffers should be kept in memory for editing purposes
+         */
+        keepInRam?: boolean;
+    };
+
+
+    export var SPLATFileLoaderMetadata: {
+        readonly name: "splat";
+        readonly extensions: {
+            readonly ".splat": {
+                readonly isBinary: true;
+            };
+            readonly ".ply": {
+                readonly isBinary: true;
+            };
+        };
+    };
+
+
         interface SceneLoaderPluginOptions {
             /**
              * Defines options for the splat loader.
              */
-            [PLUGIN_SPLAT]: {};
+            [SPLATFileLoaderMetadata.name]: Partial<SPLATLoadingOptions>;
         }
     /**
      * @experimental
@@ -3989,7 +4085,9 @@ declare module BABYLON {
         /**
          * Defines the name of the plugin.
          */
-        readonly name = "splat";
+        readonly name: "splat";
+        private _assetContainer;
+        private readonly _loadingOptions;
         /**
          * Defines the extensions the splat loader is able to load.
          * force data to come in as an ArrayBuffer
@@ -4004,21 +4102,15 @@ declare module BABYLON {
         };
         /**
          * Creates loader for gaussian splatting files
+         * @param loadingOptions options for loading and parsing splat and PLY files.
          */
-        constructor();
-        /**
-         * Instantiates a gaussian splatting file loader plugin.
-         * @returns the created plugin
-         */
-        createPlugin(): ISceneLoaderPluginAsync | ISceneLoaderPlugin;
-        /**
-         * If the data string can be loaded directly.
-         * @returns if the data can be loaded directly
-         */
-        canDirectLoad(): boolean;
+        constructor(loadingOptions?: Partial<Readonly<SPLATLoadingOptions>>);
+        private static readonly _DefaultLoadingOptions;
+        /** @internal */
+        createPlugin(options: SceneLoaderPluginOptions): ISceneLoaderPluginAsync;
         /**
          * 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
@@ -4026,23 +4118,34 @@ declare module BABYLON {
          * @param fileName Defines the name of the file to load
          * @returns a promise containing the loaded meshes, particles, skeletons and animations
          */
-        importMeshAsync(_meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<ISceneLoaderAsyncResult>;
+        importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<ISceneLoaderAsyncResult>;
+        private static _BuildPointCloud;
+        private static _BuildMesh;
+        private _parse;
         /**
-         * Imports all objects from the loaded gaussian splatting data and adds them to the scene
+         * 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
+         * @returns The loaded asset container
+         */
+        loadAssetContainerAsync(scene: Scene, data: string, rootUrl: string): Promise<AssetContainer>;
+        /**
+         * Imports all objects from the loaded OBJ 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 data the OBJ data to load
+         * @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>;
+        loadAsync(scene: Scene, data: string, 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
-         * @returns The loaded asset container
+         * Code from https://github.com/dylanebert/gsplat.js/blob/main/src/loaders/PLYLoader.ts Under MIT license
+         * Converts a .ply data array buffer to splat
+         * if data array buffer is not ply, returns the original buffer
+         * @param data the .ply data to load
+         * @returns the loaded splat buffer
          */
-        loadAssetContainerAsync(_scene: Scene, _data: string, _rootUrl: string): Promise<AssetContainer>;
+        private static _ConvertPLYToSplat;
     }
 
 
@@ -4259,12 +4362,17 @@ declare module BABYLON {
     };
 
 
-    const PLUGIN_OBJ = "obj";
+    export var OBJFileLoaderMetadata: {
+        readonly name: "obj";
+        readonly extensions: ".obj";
+    };
+
+
         interface SceneLoaderPluginOptions {
             /**
              * Defines options for the obj loader.
              */
-            [PLUGIN_OBJ]: {};
+            [OBJFileLoaderMetadata.name]: {};
         }
     /**
      * OBJ file type loader.
@@ -4318,11 +4426,11 @@ declare module BABYLON {
         /**
          * Defines the name of the plugin.
          */
-        readonly name = "obj";
+        readonly name: "obj";
         /**
          * Defines the extension the plugin is able to load.
          */
-        readonly extensions = ".obj";
+        readonly extensions: ".obj";
         private _assetContainer;
         private _loadingOptions;
         /**