Class SceneLoader

Class used to load scene from various file formats using registered plugins

See

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.

Constructors

constructor

new SceneLoader(): SceneLoader

Returns SceneLoader

Properties

`Static` `Readonly`DETAILED_LOGGING

DETAILED_LOGGING: 3 = Constants.SCENELOADER_DETAILED_LOGGING

Detailed logging while loading

`Static` `Readonly`MINIMAL_LOGGING

MINIMAL_LOGGING: 1 = Constants.SCENELOADER_MINIMAL_LOGGING

Minimal logging while loading

`Static` `Readonly`NO_LOGGING

NO_LOGGING: 0 = Constants.SCENELOADER_NO_LOGGING

No logging while loading

`Static` `Readonly`OnPluginActivatedObservable

OnPluginActivatedObservable: Observable<
ISceneLoaderPlugin
| ISceneLoaderPluginAsync,
> = onPluginActivatedObservable

Event raised when a plugin is used to load a scene

`Static` `Readonly`SUMMARY_LOGGING

SUMMARY_LOGGING: 2 = Constants.SCENELOADER_SUMMARY_LOGGING

Summary logging while loading

Accessors

`Static`CleanBoneMatrixWeights

get CleanBoneMatrixWeights(): boolean
Gets or set a boolean indicating if matrix weights must be cleaned upon loading

Returns boolean
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1372
set CleanBoneMatrixWeights(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1376

`Static`ForceFullSceneLoadingForIncremental

get ForceFullSceneLoadingForIncremental(): boolean
Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data

Returns boolean
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1336
set ForceFullSceneLoadingForIncremental(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1340

`Static`loggingLevel

get loggingLevel(): number
Ignorenaming
Defines the current logging level (while loading the scene)

Returns number
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1360
set loggingLevel(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1365

`Static`ShowLoadingScreen

get ShowLoadingScreen(): boolean
Gets or sets a boolean indicating if loading screen must be displayed while loading a scene

Returns boolean
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1347
set ShowLoadingScreen(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1351

Methods

`Static`Append

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
Parameters
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalscene: Nullable<Scene>
  is the instance of BABYLON.Scene to append to
- OptionalonSuccess: Nullable<(scene: Scene) => void>
  a callback with the scene when import succeeds
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalonError: Nullable<(scene: Scene, message: string, exception?: any) => void>
  a callback with the scene, a message, and possibly an exception when import fails
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the name of the file, if the data is binary
Returns void

Deprecated
Please use the module level AppendSceneAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1559

`Static`AppendAsync

AppendAsync(
    rootUrl: string,
    sceneFilename?: SceneSource,
    scene?: Nullable<Scene>,
    onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>,
    pluginExtension?: Nullable<string>,
    name?: string,
): Promise<Scene>
Append a scene
Parameters
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalscene: Nullable<Scene>
  is the instance of BABYLON.Scene to append to
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the name of the file, if the data is binary
Returns Promise<Scene>
The given scene

Deprecated
Please use the module level AppendSceneAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1591

`Static`GetDefaultPlugin

GetDefaultPlugin(): IRegisteredPlugin | undefined
Gets the default plugin (used to load Babylon files)

Returns IRegisteredPlugin | undefined
the .babylon plugin
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1391

`Static`GetPluginForExtension

GetPluginForExtension(
    extension: string,
):
    | ISceneLoaderPlugin
    | ISceneLoaderPluginAsync
    | ISceneLoaderPluginFactory
    | undefined
Gets a plugin that can load the given extension
Parameters
- extension: string
  defines the extension to load
Returns
    | ISceneLoaderPlugin
    | ISceneLoaderPluginAsync
    | ISceneLoaderPluginFactory
    | undefined
a plugin or null if none works
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1402

`Static`ImportAnimations

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
Import animations from a file into a scene
Parameters
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalscene: Nullable<Scene>
  is the instance of BABYLON.Scene to append to (default: last created scene)
- OptionaloverwriteAnimations: boolean
  when true, animations are cleaned before importing new ones. Animations are appended otherwise
- OptionalanimationGroupLoadingMode: SceneLoaderAnimationGroupLoadingMode
  defines how to handle old animations groups before importing new ones
- OptionaltargetConverter: Nullable<(target: any) => any>
  defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
- OptionalonSuccess: Nullable<(scene: Scene) => void>
  a callback with the scene when import succeeds
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalonError: Nullable<(scene: Scene, message: string, exception?: any) => void>
  a callback with the scene, a message, and possibly an exception when import fails
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the filename, if the data is binary
Returns void

Deprecated
Please use the module level ImportAnimationsAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1672

`Static`ImportAnimationsAsync

ImportAnimationsAsync(
    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,
): Promise<Scene>
Import animations from a file into a scene
Parameters
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalscene: Nullable<Scene>
  is the instance of BABYLON.Scene to append to (default: last created scene)
- OptionaloverwriteAnimations: boolean
  when true, animations are cleaned before importing new ones. Animations are appended otherwise
- OptionalanimationGroupLoadingMode: SceneLoaderAnimationGroupLoadingMode
  defines how to handle old animations groups before importing new ones
- OptionaltargetConverter: Nullable<(target: any) => any>
  defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
- OptionalonSuccess: Nullable<(scene: Scene) => void>
  a callback with the scene when import succeeds
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalonError: Nullable<(scene: Scene, message: string, exception?: any) => void>
  a callback with the scene, a message, and possibly an exception when import fails
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the filename, if the data is binary
Returns Promise<Scene>
the updated scene with imported animations

Deprecated
Please use the module level ImportAnimationsAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1712

`Static`ImportMesh

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,
    pluginOptions?: {
        [key: string]:
            | { enabled?: boolean; [key: string]: unknown }
            | undefined;
    },
): void
Import meshes into a scene
Parameters
- meshNames: string | readonly string[] | null | undefined
  an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalscene: Nullable<Scene>
  the instance of BABYLON.Scene to append to
- OptionalonSuccess: Nullable<SceneLoaderSuccessCallback>
  a callback with a list of imported meshes, particleSystems, skeletons, and animationGroups when import succeeds
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalonError: Nullable<(scene: Scene, message: string, exception?: any) => void>
  a callback with the scene, a message, and possibly an exception when import fails
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the name of the file, if the data is binary
- OptionalpluginOptions: { [key: string]: { enabled?: boolean; [key: string]: unknown } | undefined }
  defines the options to use with the plugin
Returns void

Deprecated
Please use the module level ImportMeshAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1437

`Static`ImportMeshAsync

ImportMeshAsync(
    meshNames: string | readonly string[] | null | undefined,
    rootUrl: string,
    sceneFilename?: SceneSource,
    scene?: Nullable<Scene>,
    onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>,
    pluginExtension?: Nullable<string>,
    name?: string,
): Promise<ISceneLoaderAsyncResult>
Import meshes into a scene
Parameters
- meshNames: string | readonly string[] | null | undefined
  an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalscene: Nullable<Scene>
  the instance of BABYLON.Scene to append to
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the name of the file
Returns Promise<ISceneLoaderAsyncResult>
The loaded list of imported meshes, particle systems, skeletons, and animation groups

Deprecated
Please use the module level ImportMeshAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1481

`Static`IsPluginForExtensionAvailable

IsPluginForExtensionAvailable(extension: string): boolean
Gets a boolean indicating that the given extension can be loaded
Parameters
- extension: string
  defines the extension to load
Returns boolean
true if the extension is supported
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1411

`Static`Load

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
Parameters
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalengine: Nullable<AbstractEngine>
  is the instance of BABYLON.Engine to use to create the scene
- OptionalonSuccess: Nullable<(scene: Scene) => void>
  a callback with the scene when import succeeds
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalonError: Nullable<(scene: Scene, message: string, exception?: any) => void>
  a callback with the scene, a message, and possibly an exception when import fails
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the filename, if the data is binary
Returns void

Deprecated
Please use the module level LoadSceneAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1505

`Static`LoadAssetContainer

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
Parameters
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalscene: Nullable<Scene>
  is the instance of BABYLON.Scene to append to (default: last created scene)
- OptionalonSuccess: Nullable<(assets: AssetContainer) => void>
  a callback with the scene when import succeeds
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalonError: Nullable<(scene: Scene, message: string, exception?: any) => void>
  a callback with the scene, a message, and possibly an exception when import fails
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the filename, if the data is binary
Returns void

Deprecated
Please use the module level LoadAssetContainerAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1614

`Static`LoadAssetContainerAsync

LoadAssetContainerAsync(
    rootUrl: string,
    sceneFilename?: SceneSource,
    scene?: Nullable<Scene>,
    onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>,
    pluginExtension?: Nullable<string>,
    name?: string,
): Promise<AssetContainer>
Load a scene into an asset container
Parameters
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene (default: empty string)
- Optionalscene: Nullable<Scene>
  is the instance of Scene to append to
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the filename, if the data is binary
Returns Promise<AssetContainer>
The loaded asset container

Deprecated
Please use the module level LoadAssetContainerAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1646

`Static`LoadAsync

LoadAsync(
    rootUrl: string,
    sceneFilename?: SceneSource,
    engine?: Nullable<AbstractEngine>,
    onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>,
    pluginExtension?: Nullable<string>,
    name?: string,
): Promise<Scene>
Load a scene
Parameters
- rootUrl: string
  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)
- OptionalsceneFilename: SceneSource
  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 (default: empty string)
- Optionalengine: Nullable<AbstractEngine>
  is the instance of BABYLON.Engine to use to create the scene
- OptionalonProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
  a callback with a progress event for each file being loaded
- OptionalpluginExtension: Nullable<string>
  the extension used to determine the plugin
- Optionalname: string
  defines the filename, if the data is binary
Returns Promise<Scene>
The loaded scene

Deprecated
Please use the module level LoadSceneAsync instead
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1536

`Static`RegisterPlugin

RegisterPlugin(
    plugin:
        | ISceneLoaderPlugin
        | ISceneLoaderPluginAsync
        | ISceneLoaderPluginFactory,
): void
Adds a new plugin to the list of registered plugins
Parameters
- plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory
  defines the plugin to add
Returns void
- Defined in packages/dev/core/src/Loading/sceneLoader.ts:1419

Class SceneLoader

See

Deprecated

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SceneLoader

Properties

Static ReadonlyDETAILED_LOGGING

Static ReadonlyMINIMAL_LOGGING

Static ReadonlyNO_LOGGING

Static ReadonlyOnPluginActivatedObservable

Static ReadonlySUMMARY_LOGGING

Accessors

StaticCleanBoneMatrixWeights

Returns boolean

Parameters

Returns void

StaticForceFullSceneLoadingForIncremental

Returns boolean

Parameters

Returns void

StaticloggingLevel

Returns number

Parameters

Returns void

StaticShowLoadingScreen

Returns boolean

Parameters

Returns void

Methods

StaticAppend

Parameters

Returns void

Deprecated

StaticAppendAsync

Parameters

Returns Promise<Scene>

Deprecated

StaticGetDefaultPlugin

Returns IRegisteredPlugin | undefined

StaticGetPluginForExtension

Parameters

Returns | ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory | undefined

StaticImportAnimations

Parameters

Returns void

Deprecated

StaticImportAnimationsAsync

Parameters

Returns Promise<Scene>

Deprecated

StaticImportMesh

Parameters

Returns void

Deprecated

StaticImportMeshAsync

Parameters

Returns Promise<ISceneLoaderAsyncResult>

Deprecated

StaticIsPluginForExtensionAvailable

Parameters

Returns boolean

StaticLoad

Parameters

Returns void

Deprecated

StaticLoadAssetContainer

Parameters

Returns void

Deprecated

StaticLoadAssetContainerAsync

Parameters

Returns Promise<AssetContainer>

Deprecated

StaticLoadAsync

`Static` `Readonly`DETAILED_LOGGING

`Static` `Readonly`MINIMAL_LOGGING

`Static` `Readonly`NO_LOGGING

`Static` `Readonly`OnPluginActivatedObservable

`Static` `Readonly`SUMMARY_LOGGING

`Static`CleanBoneMatrixWeights

`Static`ForceFullSceneLoadingForIncremental

`Static`loggingLevel

`Static`ShowLoadingScreen

`Static`Append

`Static`AppendAsync

`Static`GetDefaultPlugin

`Static`GetPluginForExtension

Returns
| ISceneLoaderPlugin
| ISceneLoaderPluginAsync
| ISceneLoaderPluginFactory
| undefined

`Static`ImportAnimations

`Static`ImportAnimationsAsync

`Static`ImportMesh

`Static`ImportMeshAsync

`Static`IsPluginForExtensionAvailable

`Static`Load

`Static`LoadAssetContainer

`Static`LoadAssetContainerAsync

`Static`LoadAsync

`Static`RegisterPlugin