@babylonjs/core 7.33.0 → 7.34.1

package/Loading/sceneLoader.d.ts

@@ -81,6 +81,7 @@ export interface ISceneLoaderPluginExtensions {
      */
     readonly [extension: string]: {
         readonly isBinary: boolean;
+        readonly mimeType?: string;
     };
 }
 /**
@@ -259,6 +260,7 @@ interface IRegisteredPlugin {
      * Defines if the plugin supports binary data
      */
     isBinary: boolean;
+    mimeType?: string;
 }
 /**
  * Defines options for SceneLoader plugins. This interface is extended by specific plugins.
@@ -463,9 +465,9 @@ export declare class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the name of the file, if the data is binary
-     * @returns The loaded plugin
+     * @deprecated Please use ImportMeshAsync instead
      */
-    static ImportMesh(meshNames: string | readonly string[] | null | undefined, rootUrl: string, sceneFilename?: SceneSource, scene?: Nullable<Scene>, onSuccess?: Nullable<SceneLoaderSuccessCallback>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
+    static ImportMesh(meshNames: string | readonly string[] | null | undefined, rootUrl: string, sceneFilename?: SceneSource, scene?: Nullable<Scene>, onSuccess?: Nullable<SceneLoaderSuccessCallback>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): void;
     /**
      * Import meshes into a scene
      * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
@@ -488,9 +490,9 @@ export declare class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
-     * @returns The loaded plugin
+     * @deprecated Please use LoadAsync instead
      */
-    static Load(rootUrl: string, sceneFilename?: SceneSource, engine?: Nullable<AbstractEngine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
+    static Load(rootUrl: string, sceneFilename?: SceneSource, engine?: Nullable<AbstractEngine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): void;
     /**
      * Load a scene
      * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
@@ -512,9 +514,9 @@ export declare class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the name of the file, if the data is binary
-     * @returns The loaded plugin
+     * @deprecated Please use AppendAsync instead
      */
-    static Append(rootUrl: string, sceneFilename?: SceneSource, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
+    static Append(rootUrl: string, sceneFilename?: SceneSource, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): void;
     /**
      * Append a scene
      * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
@@ -536,9 +538,9 @@ export declare class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
-     * @returns The loaded plugin
+     * @deprecated Please use LoadAssetContainerAsync instead
      */
-    static LoadAssetContainer(rootUrl: string, sceneFilename?: SceneSource, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
+    static LoadAssetContainer(rootUrl: string, sceneFilename?: SceneSource, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): void;
     /**
      * Load a scene into an asset container
      * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
@@ -563,6 +565,7 @@ export declare class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
+     * @deprecated Please use ImportAnimationsAsync instead
      */
     static ImportAnimations(rootUrl: string, sceneFilename?: SceneSource, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>, name?: string): void;
     /**

package/Loading/sceneLoader.js

@@ -9,6 +9,7 @@ import { IsBase64DataUrl } from "../Misc/fileTools.js";
 import { RuntimeError, ErrorCodes } from "../Misc/error.js";
 import { RandomGUID } from "../Misc/guid.js";
 import { AbstractEngine } from "../Engines/abstractEngine.js";
+import { _FetchAsync } from "../Misc/webRequest.fetch.js";
 /**
  * Mode that determines how to handle old animation groups before loading new ones.
  */
@@ -43,7 +44,16 @@ let showingLoadingScreen = false;
 function getDefaultPlugin() {
     return registeredPlugins[".babylon"];
 }
-function getPluginForExtension(extension) {
+function getPluginForMimeType(mimeType) {
+    for (const registeredPluginKey in registeredPlugins) {
+        const registeredPlugin = registeredPlugins[registeredPluginKey];
+        if (registeredPlugin.mimeType === mimeType) {
+            return registeredPlugin;
+        }
+    }
+    return undefined;
+}
+function getPluginForExtension(extension, returnDefault) {
     const registeredPlugin = registeredPlugins[extension];
     if (registeredPlugin) {
         return registeredPlugin;
@@ -51,7 +61,7 @@ function getPluginForExtension(extension) {
     Logger.Warn("Unable to find a plugin to load " +
         extension +
         " files. Trying to use .babylon default plugin. To load from a specific filetype (eg. gltf) see: https://doc.babylonjs.com/features/featuresDeepDive/importers/loadingFileTypes");
-    return getDefaultPlugin();
+    return returnDefault ? getDefaultPlugin() : undefined;
 }
 function isPluginForExtensionAvailable(extension) {
     return !!registeredPlugins[extension];
@@ -65,14 +75,13 @@ function getPluginForDirectLoad(data) {
     }
     return getDefaultPlugin();
 }
-function getPluginForFilename(sceneFilename) {
+function getFilenameExtension(sceneFilename) {
     const queryStringPosition = sceneFilename.indexOf("?");
     if (queryStringPosition !== -1) {
         sceneFilename = sceneFilename.substring(0, queryStringPosition);
     }
     const dotPosition = sceneFilename.lastIndexOf(".");
-    const extension = sceneFilename.substring(dotPosition, sceneFilename.length).toLowerCase();
-    return getPluginForExtension(extension);
+    return sceneFilename.substring(dotPosition, sceneFilename.length).toLowerCase();
 }
 function getDirectLoad(sceneFilename) {
     if (sceneFilename.substring(0, 5) === "data:") {
@@ -91,13 +100,31 @@ function formatErrorMessage(fileInfo, message, exception) {
     }
     return errorMessage;
 }
-function loadData(fileInfo, scene, onSuccess, onProgress, onError, onDispose, pluginExtension, name, pluginOptions) {
+async function loadDataAsync(fileInfo, scene, onSuccess, onProgress, onError, onDispose, pluginExtension, name, pluginOptions) {
     const directLoad = getDirectLoad(fileInfo.url);
     if (fileInfo.rawData && !pluginExtension) {
         // eslint-disable-next-line no-throw-literal
         throw "When using ArrayBufferView to load data the file extension must be provided.";
     }
-    const registeredPlugin = pluginExtension ? getPluginForExtension(pluginExtension) : directLoad ? getPluginForDirectLoad(fileInfo.url) : getPluginForFilename(fileInfo.url);
+    const fileExtension = !directLoad && !pluginExtension ? getFilenameExtension(fileInfo.url) : "";
+    let registeredPlugin = pluginExtension
+        ? getPluginForExtension(pluginExtension, true)
+        : directLoad
+            ? getPluginForDirectLoad(fileInfo.url)
+            : getPluginForExtension(fileExtension, false);
+    if (!registeredPlugin && fileExtension) {
+        if (fileInfo.url && !fileInfo.url.startsWith("blob:")) {
+            // Fetching head content to get the mime type
+            const response = await _FetchAsync(fileInfo.url, { method: "HEAD", responseHeaders: ["Content-Type"] });
+            const mimeType = response.headerValues ? response.headerValues["Content-Type"] : "";
+            if (mimeType) {
+                registeredPlugin = getPluginForMimeType(mimeType);
+            }
+        }
+        if (!registeredPlugin) {
+            registeredPlugin = getDefaultPlugin();
+        }
+    }
     if (!registeredPlugin) {
         throw new Error(`No plugin or fallback for ${pluginExtension ?? fileInfo.url}`);
     }
@@ -217,7 +244,7 @@ function loadData(fileInfo, scene, onSuccess, onProgress, onError, onDispose, pl
         }
     });
 }
-function getFileInfo(rootUrl, sceneSource) {
+function _getFileInfo(rootUrl, sceneSource) {
     let url;
     let name;
     let file = null;
@@ -281,16 +308,17 @@ export function registerSceneLoaderPlugin(plugin) {
             registeredPlugins[extension.toLowerCase()] = {
                 plugin: plugin,
                 isBinary: extensions[extension].isBinary,
+                mimeType: extensions[extension].mimeType,
             };
         });
     }
 }
-function importMesh(meshNames, rootUrl, sceneFilename = "", scene = EngineStore.LastCreatedScene, onSuccess = null, onProgress = null, onError = null, pluginExtension = null, name = "", pluginOptions = {}) {
+async function importMeshAsync(meshNames, rootUrl, sceneFilename = "", scene = EngineStore.LastCreatedScene, onSuccess = null, onProgress = null, onError = null, pluginExtension = null, name = "", pluginOptions = {}) {
     if (!scene) {
         Logger.Error("No scene available to import mesh to");
         return null;
     }
-    const fileInfo = getFileInfo(rootUrl, sceneFilename);
+    const fileInfo = _getFileInfo(rootUrl, sceneFilename);
     if (!fileInfo) {
         return null;
     }
@@ -332,7 +360,7 @@ function importMesh(meshNames, rootUrl, sceneFilename = "", scene = EngineStore.
         }
         scene.removePendingData(loadingToken);
     };
-    return loadData(fileInfo, scene, (plugin, data, responseURL) => {
+    return await loadDataAsync(fileInfo, scene, (plugin, data, responseURL) => {
         if (plugin.rewriteRootURL) {
             fileInfo.rootUrl = plugin.rewriteRootURL(fileInfo.rootUrl, responseURL);
         }
@@ -363,7 +391,7 @@ function importMesh(meshNames, rootUrl, sceneFilename = "", scene = EngineStore.
 }
 function importMeshAsyncCore(meshNames, rootUrl, sceneFilename, scene, onProgress, pluginExtension, name, pluginOptions) {
     return new Promise((resolve, reject) => {
-        importMesh(meshNames, rootUrl, sceneFilename, scene, (meshes, particleSystems, skeletons, animationGroups, transformNodes, geometries, lights, spriteManagers) => {
+        importMeshAsync(meshNames, rootUrl, sceneFilename, scene, (meshes, particleSystems, skeletons, animationGroups, transformNodes, geometries, lights, spriteManagers) => {
             resolve({
                 meshes: meshes,
                 particleSystems: particleSystems,
@@ -382,9 +410,9 @@ function importMeshAsyncCore(meshNames, rootUrl, sceneFilename, scene, onProgres
 function loadScene(rootUrl, sceneFilename = "", engine = EngineStore.LastCreatedEngine, onSuccess = null, onProgress = null, onError = null, pluginExtension = null, name = "", pluginOptions = {}) {
     if (!engine) {
         Tools.Error("No engine available");
-        return null;
+        return;
     }
-    return append(rootUrl, sceneFilename, new Scene(engine), onSuccess, onProgress, onError, pluginExtension, name, pluginOptions);
+    appendAsync(rootUrl, sceneFilename, new Scene(engine), onSuccess, onProgress, onError, pluginExtension, name, pluginOptions);
 }
 /**
  * Load a scene
@@ -407,12 +435,12 @@ function loadSceneAsyncCore(rootUrl, sceneFilename, engine, onProgress, pluginEx
         }, pluginExtension, name, pluginOptions);
     });
 }
-function append(rootUrl, sceneFilename = "", scene = EngineStore.LastCreatedScene, onSuccess = null, onProgress = null, onError = null, pluginExtension = null, name = "", pluginOptions = {}) {
+async function appendAsync(rootUrl, sceneFilename = "", scene = EngineStore.LastCreatedScene, onSuccess = null, onProgress = null, onError = null, pluginExtension = null, name = "", pluginOptions = {}) {
     if (!scene) {
         Logger.Error("No scene available to append to");
         return null;
     }
-    const fileInfo = getFileInfo(rootUrl, sceneFilename);
+    const fileInfo = _getFileInfo(rootUrl, sceneFilename);
     if (!fileInfo) {
         return null;
     }
@@ -461,7 +489,7 @@ function append(rootUrl, sceneFilename = "", scene = EngineStore.LastCreatedScen
         }
         scene.removePendingData(loadingToken);
     };
-    return loadData(fileInfo, scene, (plugin, data) => {
+    return await loadDataAsync(fileInfo, scene, (plugin, data) => {
         if (plugin.load) {
             const syncedPlugin = plugin;
             if (!syncedPlugin.load(scene, data, fileInfo.rootUrl, errorHandler)) {
@@ -497,19 +525,19 @@ export async function appendSceneAsync(source, scene, options) {
 }
 function appendSceneAsyncCore(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name, pluginOptions) {
     return new Promise((resolve, reject) => {
-        append(rootUrl, sceneFilename, scene, (scene) => {
+        appendAsync(rootUrl, sceneFilename, scene, (scene) => {
             resolve(scene);
         }, onProgress, (scene, message, exception) => {
             reject(exception || new Error(message));
         }, pluginExtension, name, pluginOptions);
     });
 }
-function loadAssetContainer(rootUrl, sceneFilename = "", scene = EngineStore.LastCreatedScene, onSuccess = null, onProgress = null, onError = null, pluginExtension = null, name = "", pluginOptions = {}) {
+async function loadAssetContainerCoreAsync(rootUrl, sceneFilename = "", scene = EngineStore.LastCreatedScene, onSuccess = null, onProgress = null, onError = null, pluginExtension = null, name = "", pluginOptions = {}) {
     if (!scene) {
         Logger.Error("No scene available to load asset container to");
         return null;
     }
-    const fileInfo = getFileInfo(rootUrl, sceneFilename);
+    const fileInfo = _getFileInfo(rootUrl, sceneFilename);
     if (!fileInfo) {
         return null;
     }
@@ -550,7 +578,7 @@ function loadAssetContainer(rootUrl, sceneFilename = "", scene = EngineStore.Las
         }
         scene.removePendingData(loadingToken);
     };
-    return loadData(fileInfo, scene, (plugin, data) => {
+    return await loadDataAsync(fileInfo, scene, (plugin, data) => {
         if (plugin.loadAssetContainer) {
             const syncedPlugin = plugin;
             const assetContainer = syncedPlugin.loadAssetContainer(scene, data, fileInfo.rootUrl, errorHandler);
@@ -589,11 +617,11 @@ function loadAssetContainer(rootUrl, sceneFilename = "", scene = EngineStore.Las
  */
 export function loadAssetContainerAsync(source, scene, options) {
     const { rootUrl = "", onProgress, pluginExtension, name, pluginOptions } = options ?? {};
-    return loadAssetContainerAsyncCore(rootUrl, source, scene, onProgress, pluginExtension, name, pluginOptions);
+    return internalLoadAssetContainerAsync(rootUrl, source, scene, onProgress, pluginExtension, name, pluginOptions);
 }
-function loadAssetContainerAsyncCore(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name, pluginOptions) {
+function internalLoadAssetContainerAsync(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name, pluginOptions) {
     return new Promise((resolve, reject) => {
-        loadAssetContainer(rootUrl, sceneFilename, scene, (assets) => {
+        loadAssetContainerCoreAsync(rootUrl, sceneFilename, scene, (assets) => {
             resolve(assets);
         }, onProgress, (scene, message, exception) => {
             reject(exception || new Error(message));
@@ -656,7 +684,7 @@ function importAnimations(rootUrl, sceneFilename = "", scene = EngineStore.LastC
             onSuccess(scene);
         }
     };
-    loadAssetContainer(rootUrl, sceneFilename, scene, onAssetContainerLoaded, onProgress, onError, pluginExtension, name, pluginOptions);
+    loadAssetContainerCoreAsync(rootUrl, sceneFilename, scene, onAssetContainerLoaded, onProgress, onError, pluginExtension, name, pluginOptions);
 }
 /**
  * Import animations from a file into a scene
@@ -736,7 +764,7 @@ export class SceneLoader {
      * @returns a plugin or null if none works
      */
     static GetPluginForExtension(extension) {
-        return getPluginForExtension(extension)?.plugin;
+        return getPluginForExtension(extension, true)?.plugin;
     }
     /**
      * Gets a boolean indicating that the given extension can be loaded
@@ -764,10 +792,10 @@ export class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the name of the file, if the data is binary
-     * @returns The loaded plugin
+     * @deprecated Please use ImportMeshAsync instead
      */
     static ImportMesh(meshNames, rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name) {
-        return importMesh(meshNames, rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name);
+        importMeshAsync(meshNames, rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name);
     }
     /**
      * Import meshes into a scene
@@ -793,10 +821,10 @@ export class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
-     * @returns The loaded plugin
+     * @deprecated Please use LoadAsync instead
      */
     static Load(rootUrl, sceneFilename, engine, onSuccess, onProgress, onError, pluginExtension, name) {
-        return loadScene(rootUrl, sceneFilename, engine, onSuccess, onProgress, onError, pluginExtension, name);
+        loadScene(rootUrl, sceneFilename, engine, onSuccess, onProgress, onError, pluginExtension, name);
     }
     /**
      * Load a scene
@@ -821,10 +849,10 @@ export class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the name of the file, if the data is binary
-     * @returns The loaded plugin
+     * @deprecated Please use AppendAsync instead
      */
     static Append(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name) {
-        return append(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name);
+        appendAsync(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name);
     }
     /**
      * Append a scene
@@ -849,10 +877,10 @@ export class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
-     * @returns The loaded plugin
+     * @deprecated Please use LoadAssetContainerAsync instead
      */
     static LoadAssetContainer(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name) {
-        return loadAssetContainer(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name);
+        loadAssetContainerCoreAsync(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name);
     }
     /**
      * Load a scene into an asset container
@@ -865,7 +893,7 @@ export class SceneLoader {
      * @returns The loaded asset container
      */
     static LoadAssetContainerAsync(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name) {
-        return loadAssetContainerAsyncCore(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name);
+        return internalLoadAssetContainerAsync(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name);
     }
     /**
      * Import animations from a file into a scene
@@ -880,6 +908,7 @@ export class SceneLoader {
      * @param onError a callback with the scene, a message, and possibly an exception when import fails
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
+     * @deprecated Please use ImportAnimationsAsync instead
      */
     static ImportAnimations(rootUrl, sceneFilename, scene, overwriteAnimations, animationGroupLoadingMode, targetConverter, onSuccess, onProgress, onError, pluginExtension, name) {
         importAnimations(rootUrl, sceneFilename, scene, overwriteAnimations, animationGroupLoadingMode, targetConverter, onSuccess, onProgress, onError, pluginExtension, name);