ISceneLoaderPluginAsync | Babylon.js API documentation

Interface ISceneLoaderPluginAsync

Interface used to define an async SceneLoader plugin

interface ISceneLoaderPluginAsync {
    extensions: string | ISceneLoaderPluginExtensions;
    name: string;
    canDirectLoad(data: string): boolean;
    directLoad(scene: Scene, data: string): unknown;
    importMeshAsync(
        meshesNames: undefined | null | string | readonly string[],
        scene: Scene,
        data: unknown,
        rootUrl: string,
        onProgress?: (event: ISceneLoaderProgressEvent) => void,
        fileName?: string,
    ): Promise<ISceneLoaderAsyncResult>;
    loadAssetContainerAsync(
        scene: Scene,
        data: unknown,
        rootUrl: string,
        onProgress?: (event: ISceneLoaderProgressEvent) => void,
        fileName?: string,
    ): Promise<AssetContainer>;
    loadAsync(
        scene: Scene,
        data: unknown,
        rootUrl: string,
        onProgress?: (event: ISceneLoaderProgressEvent) => void,
        fileName?: string,
    ): Promise<void>;
    loadFile(
        scene: Scene,
        fileOrUrl: string | ArrayBufferView | File,
        rootUrl: string,
        onSuccess: (data: unknown, responseURL?: string) => void,
        onProgress?: (ev: ISceneLoaderProgressEvent) => void,
        useArrayBuffer?: boolean,
        onError?: (request?: WebRequest, exception?: LoadFileError) => void,
        name?: string,
    ): Nullable<IFileRequest>;
    rewriteRootURL(rootUrl: string, responseURL?: string): string;
}

Hierarchy (View Summary)

ISceneLoaderPluginBase
- ISceneLoaderPluginAsync

Implemented by

Index

Properties

extensions name

Methods

canDirectLoad? directLoad? importMeshAsync loadAssetContainerAsync loadAsync loadFile? rewriteRootURL?

Properties

`Readonly`extensions

extensions: string | ISceneLoaderPluginExtensions

The file extensions supported by the plugin.

`Readonly`name

name: string

The friendly name of the plugin.

Methods

`Optional`canDirectLoad

canDirectLoad(data: string): boolean
The callback that returns true if the data can be directly loaded.
Parameters
- data: string
  string containing the file data
Returns boolean
if the data can be loaded directly
Inherited from ISceneLoaderPluginBase.canDirectLoad
- Defined in .temp/typedoc/docdirectory/doc.d.ts:91503

`Optional`directLoad

directLoad(scene: Scene, data: string): unknown
The callback that returns the data to pass to the plugin if the data can be directly loaded.
Parameters
- scene: Scene
  scene loading this data
- data: string
  string containing the data
Returns unknown
data to pass to the plugin
Inherited from ISceneLoaderPluginBase.directLoad
- Defined in .temp/typedoc/docdirectory/doc.d.ts:91539

importMeshAsync

importMeshAsync(
    meshesNames: undefined | null | string | readonly string[],
    scene: Scene,
    data: unknown,
    rootUrl: string,
    onProgress?: (event: ISceneLoaderProgressEvent) => void,
    fileName?: string,
): Promise<ISceneLoaderAsyncResult>
Import meshes into a scene.
Parameters
- meshesNames: undefined | null | string | readonly string[]
  An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
- scene: Scene
  The scene to import into
- data: unknown
  The data to import
- rootUrl: string
  The root url for scene and resources
- OptionalonProgress: (event: ISceneLoaderProgressEvent) => void
  The callback when the load progresses
- OptionalfileName: string
  Defines the name of the file to load
Returns Promise<ISceneLoaderAsyncResult>
The loaded objects (e.g. meshes, particle systems, skeletons, animation groups, etc.)
- Defined in .temp/typedoc/docdirectory/doc.d.ts:91598

loadAssetContainerAsync

loadAssetContainerAsync(
    scene: Scene,
    data: unknown,
    rootUrl: string,
    onProgress?: (event: ISceneLoaderProgressEvent) => void,
    fileName?: string,
): Promise<AssetContainer>
Load into an asset container.
Parameters
- scene: Scene
  The scene to load into
- data: unknown
  The data to import
- rootUrl: string
  The root url for scene and resources
- OptionalonProgress: (event: ISceneLoaderProgressEvent) => void
  The callback when the load progresses
- OptionalfileName: string
  Defines the name of the file to load
Returns Promise<AssetContainer>
The loaded asset container
- Defined in .temp/typedoc/docdirectory/doc.d.ts:91618

loadAsync

loadAsync(
    scene: Scene,
    data: unknown,
    rootUrl: string,
    onProgress?: (event: ISceneLoaderProgressEvent) => void,
    fileName?: string,
): Promise<void>
Load into a scene.
Parameters
- scene: Scene
  The scene to load into
- data: unknown
  The data to import
- rootUrl: string
  The root url for scene and resources
- OptionalonProgress: (event: ISceneLoaderProgressEvent) => void
  The callback when the load progresses
- OptionalfileName: string
  Defines the name of the file to load
Returns Promise<void>
Nothing
- Defined in .temp/typedoc/docdirectory/doc.d.ts:91608

`Optional`loadFile

loadFile(
    scene: Scene,
    fileOrUrl: string | ArrayBufferView | File,
    rootUrl: string,
    onSuccess: (data: unknown, responseURL?: string) => void,
    onProgress?: (ev: ISceneLoaderProgressEvent) => void,
    useArrayBuffer?: boolean,
    onError?: (request?: WebRequest, exception?: LoadFileError) => void,
    name?: string,
): Nullable<IFileRequest>
The callback called when loading from a url.
Parameters
- scene: Scene
  scene loading this url
- fileOrUrl: string | ArrayBufferView | File
  file or url to load
- rootUrl: string
  root url to use to load assets
- onSuccess: (data: unknown, responseURL?: string) => void
  callback called when the file successfully loads
- OptionalonProgress: (ev: ISceneLoaderProgressEvent) => void
  callback called while file is loading (if the server supports this mode)
- OptionaluseArrayBuffer: boolean
  defines a boolean indicating that date must be returned as ArrayBuffer
- OptionalonError: (request?: WebRequest, exception?: LoadFileError) => void
  callback called when the file fails to load
- Optionalname: string
  defines the name of the file when loading a binary file
Returns Nullable<IFileRequest>
a file request object
Inherited from ISceneLoaderPluginBase.loadFile
- Defined in .temp/typedoc/docdirectory/doc.d.ts:91532

`Optional`rewriteRootURL

rewriteRootURL(rootUrl: string, responseURL?: string): string
The callback that allows custom handling of the root url based on the response url.
Parameters
- rootUrl: string
  the original root url
- OptionalresponseURL: string
  the response url if available
Returns string
the new root url
Inherited from ISceneLoaderPluginBase.rewriteRootURL
- Defined in .temp/typedoc/docdirectory/doc.d.ts:91546

Interface ISceneLoaderPluginAsync

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

`Readonly`extensions

`Readonly`name

Methods

`Optional`canDirectLoad

Parameters

Returns boolean

`Optional`directLoad

Parameters

Returns unknown

importMeshAsync

Parameters

Returns Promise<ISceneLoaderAsyncResult>

loadAssetContainerAsync

Parameters

Returns Promise<AssetContainer>

loadAsync

Parameters

Returns Promise<void>

`Optional`loadFile

Parameters

Returns Nullable<IFileRequest>

`Optional`rewriteRootURL

Parameters

Returns string

Settings

On This Page

Interface ISceneLoaderPluginAsync

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

Readonlyextensions

Readonlyname

Methods

OptionalcanDirectLoad

Parameters

Returns boolean

OptionaldirectLoad

Parameters

Returns unknown

importMeshAsync

Parameters

Returns Promise<ISceneLoaderAsyncResult>

loadAssetContainerAsync

Parameters

Returns Promise<AssetContainer>

loadAsync

Parameters

Returns Promise<void>

OptionalloadFile

Parameters

Returns Nullable<IFileRequest>

OptionalrewriteRootURL

Parameters

Returns string

Settings

On This Page

`Readonly`extensions

`Readonly`name

`Optional`canDirectLoad

`Optional`directLoad

`Optional`loadFile

`Optional`rewriteRootURL