@babylonjs/core 7.51.2 → 7.52.0

package/Loading/sceneLoader.js

@@ -315,7 +315,7 @@ export function RegisterSceneLoaderPlugin(plugin) {
 }
 /**
  * Adds a new plugin to the list of registered plugins
- * @deprecated Please use `RegisterSceneLoaderPlugin` instead.
+ * @deprecated Please use {@link RegisterSceneLoaderPlugin} instead.
  * @param plugin defines the plugin to add
  */
 export function registerSceneLoaderPlugin(plugin) {
@@ -335,6 +335,17 @@ export function GetRegisteredSceneLoaderPluginMetadata() {
         return pluginMap;
     }, new Map())).map(([name, extensions]) => ({ name, extensions }));
 }
+/**
+ * Import meshes into a scene
+ * @param source a string that defines the name of the scene file, or starts with "data:" following by the stringified version of the scene, or a File object, or an ArrayBufferView
+ * @param scene the instance of BABYLON.Scene to append to
+ * @param options an object that configures aspects of how the scene is loaded
+ * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
+ */
+export function ImportMeshAsync(source, scene, options) {
+    const { meshNames, rootUrl = "", onProgress, pluginExtension, name, pluginOptions } = options ?? {};
+    return importMeshAsyncCore(meshNames, rootUrl, source, scene, onProgress, pluginExtension, 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");
@@ -455,7 +466,7 @@ export function LoadSceneAsync(source, engine, options) {
 }
 /**
  * Load a scene
- * @deprecated Please use `LoadSceneAsync` instead.
+ * @deprecated Please use {@link LoadSceneAsync} instead.
  * @param source a string that defines the name of the scene file, or starts with "data:" following by the stringified version of the scene, or a File object, or an ArrayBufferView
  * @param engine is the instance of BABYLON.Engine to use to create the scene
  * @param options an object that configures aspects of how the scene is loaded
@@ -565,7 +576,7 @@ export async function AppendSceneAsync(source, scene, options) {
 }
 /**
  * Append a scene
- * @deprecated Please use `AppendSceneAsync` instead.
+ * @deprecated Please use {@link AppendSceneAsync} instead.
  * @param source a string that defines the name of the scene file, or starts with "data:" following by the stringified version of the scene, or a File object, or an ArrayBufferView
  * @param scene is the instance of BABYLON.Scene to append to
  * @param options an object that configures aspects of how the scene is loaded
@@ -678,7 +689,7 @@ export function LoadAssetContainerAsync(source, scene, options) {
 }
 /**
  * Load a scene into an asset container
- * @deprecated Please use `LoadAssetContainerAsync` instead.
+ * @deprecated Please use {@link LoadAssetContainerAsync} instead.
  * @param source a string that defines the name of the scene file, or starts with "data:" following by the stringified version of the scene, or a File object, or an ArrayBufferView
  * @param scene is the instance of Scene to append to
  * @param options an object that configures aspects of how the scene is loaded
@@ -774,7 +785,7 @@ export async function ImportAnimationsAsync(source, scene, options) {
 }
 /**
  * Import animations from a file into a scene
- * @deprecated Please use `ImportAnimationsAsync` instead.
+ * @deprecated Please use {@link ImportAnimationsAsync} instead.
  * @param source a string that defines the name of the scene file, or starts with "data:" following by the stringified version of the scene, or a File object, or an ArrayBufferView
  * @param scene is the instance of BABYLON.Scene to append to
  * @param options an object that configures aspects of how the scene is loaded
@@ -801,7 +812,8 @@ function importAnimationsSharedAsync(rootUrl, sceneFilename, scene, overwriteAni
 /**
  * Class used to load scene from various file formats using registered plugins
  * @see https://doc.babylonjs.com/features/featuresDeepDive/importers/loadingFileTypes
- * @deprecated The module level functions (such as LoadAssetContainerAsync) are more efficient for bundler tree shaking and allow plugin options to be passed through. Future improvements to scene loading will primarily be in the module level functions. The SceneLoader class will remain available, but it will be beneficial to prefer the module level functions.
+ * @deprecated The module level functions are more efficient for bundler tree shaking and allow plugin options to be passed through. Future improvements to scene loading will primarily be in the module level functions. The SceneLoader class will remain available, but it will be beneficial to prefer the module level functions.
+ * @see {@link ImportMeshAsync}, {@link LoadSceneAsync}, {@link AppendSceneAsync}, {@link ImportAnimationsAsync}, {@link LoadAssetContainerAsync}
  */
 export class SceneLoader {
     /**
@@ -885,7 +897,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 name of the file, if the data is binary
-     * @deprecated Please use ImportMeshAsync instead
+     * @deprecated Please use the module level {@link ImportMeshAsync} instead
      */
     static ImportMesh(meshNames, rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name) {
         importMeshAsync(meshNames, rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name).catch((error) => onError?.(EngineStore.LastCreatedScene, error?.message, error));
@@ -900,6 +912,7 @@ export class SceneLoader {
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the name of the file
      * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
+     * @deprecated Please use the module level {@link ImportMeshAsync} instead
      */
     static ImportMeshAsync(meshNames, rootUrl, sceneFilename, scene, onProgress, pluginExtension, name) {
         return importMeshAsyncCore(meshNames, rootUrl, sceneFilename, scene, onProgress, pluginExtension, name);
@@ -914,7 +927,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 LoadAsync instead
+     * @deprecated Please use the module level {@link LoadSceneAsync} instead
      */
     static Load(rootUrl, sceneFilename, engine, onSuccess, onProgress, onError, pluginExtension, name) {
         loadSceneImplAsync(rootUrl, sceneFilename, engine, onSuccess, onProgress, onError, pluginExtension, name).catch((error) => onError?.(EngineStore.LastCreatedScene, error?.message, error));
@@ -928,6 +941,7 @@ export class SceneLoader {
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
      * @returns The loaded scene
+     * @deprecated Please use the module level {@link LoadSceneAsync} instead
      */
     static LoadAsync(rootUrl, sceneFilename, engine, onProgress, pluginExtension, name) {
         return loadSceneSharedAsync(rootUrl, sceneFilename, engine, onProgress, pluginExtension, name);
@@ -942,7 +956,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 name of the file, if the data is binary
-     * @deprecated Please use AppendAsync instead
+     * @deprecated Please use the module level {@link AppendSceneAsync} instead
      */
     static Append(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name) {
         appendSceneImplAsync(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name).catch((error) => onError?.((scene ?? EngineStore.LastCreatedScene), error?.message, error));
@@ -956,6 +970,7 @@ export class SceneLoader {
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the name of the file, if the data is binary
      * @returns The given scene
+     * @deprecated Please use the module level {@link AppendSceneAsync} instead
      */
     static AppendAsync(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name) {
         return appendSceneSharedAsync(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name);
@@ -970,7 +985,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 LoadAssetContainerAsync instead
+     * @deprecated Please use the module level {@link LoadAssetContainerAsync} instead
      */
     static LoadAssetContainer(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name) {
         loadAssetContainerImplAsync(rootUrl, sceneFilename, scene, onSuccess, onProgress, onError, pluginExtension, name).catch((error) => onError?.((scene ?? EngineStore.LastCreatedScene), error?.message, error));
@@ -984,6 +999,7 @@ export class SceneLoader {
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
      * @returns The loaded asset container
+     * @deprecated Please use the module level {@link LoadAssetContainerAsync} instead
      */
     static LoadAssetContainerAsync(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name) {
         return loadAssetContainerSharedAsync(rootUrl, sceneFilename, scene, onProgress, pluginExtension, name);
@@ -1001,7 +1017,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
+     * @deprecated Please use the module level {@link ImportAnimationsAsync} instead
      */
     static ImportAnimations(rootUrl, sceneFilename, scene, overwriteAnimations, animationGroupLoadingMode, targetConverter, onSuccess, onProgress, onError, pluginExtension, name) {
         importAnimationsImplAsync(rootUrl, sceneFilename, scene, overwriteAnimations, animationGroupLoadingMode, targetConverter, onSuccess, onProgress, onError, pluginExtension, name).catch((error) => onError?.((scene ?? EngineStore.LastCreatedScene), error?.message, error));
@@ -1020,6 +1036,7 @@ export class SceneLoader {
      * @param pluginExtension the extension used to determine the plugin
      * @param name defines the filename, if the data is binary
      * @returns the updated scene with imported animations
+     * @deprecated Please use the module level {@link ImportAnimationsAsync} instead
      */
     static ImportAnimationsAsync(rootUrl, sceneFilename, scene, overwriteAnimations, animationGroupLoadingMode, targetConverter, 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars