Interface ISceneLoaderPluginAsync

Interface used to define an async SceneLoader plugin

Hierarchy

ISceneLoaderPluginBase
- ISceneLoaderPluginAsync

Implemented by

Index

Properties

Methods

Properties

extensionsSearch playground for extensions

extensions: string | ISceneLoaderPluginExtensions

The file extensions supported by this plugin.

nameSearch playground for name

name: string

The friendly name of this plugin.

Methods

Optional canDirectLoadSearch playground for canDirectLoad

canDirectLoad(data: string): boolean

Inherited from ISceneLoaderPluginBase.canDirectLoad
- Defined in .temp/docdirectory/doc.d.ts:33584
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

Optional directLoadSearch playground for directLoad

directLoad(scene: Scene, data: string): any

Inherited from ISceneLoaderPluginBase.directLoad
- Defined in .temp/docdirectory/doc.d.ts:33591
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 any

data to pass to the plugin

importMeshAsyncSearch playground for importMeshAsync

importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<ISceneLoaderAsyncResult>

- Defined in .temp/docdirectory/doc.d.ts:33650
Import meshes into a scene.

Parameters
- meshesNames: any
  
  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: any
  
  The data to import
- rootUrl: string
  
  The root url for scene and resources
- Optional onProgress: (event: ISceneLoaderProgressEvent) => void
  
  The callback when the load progresses
  - - (event: ISceneLoaderProgressEvent): void
    - Parameters
      - event: ISceneLoaderProgressEvent
      Returns void
- Optional fileName: string
  
  Defines the name of the file to load
Returns Promise<ISceneLoaderAsyncResult>

The loaded objects (e.g. meshes, particle systems, skeletons, animation groups, etc.)

loadAssetContainerAsyncSearch playground for loadAssetContainerAsync

loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>

- Defined in .temp/docdirectory/doc.d.ts:33670
Load into an asset container.

Parameters
- scene: Scene
  
  The scene to load into
- data: any
  
  The data to import
- rootUrl: string
  
  The root url for scene and resources
- Optional onProgress: (event: ISceneLoaderProgressEvent) => void
  
  The callback when the load progresses
  - - (event: ISceneLoaderProgressEvent): void
    - Parameters
      - event: ISceneLoaderProgressEvent
      Returns void
- Optional fileName: string
  
  Defines the name of the file to load
Returns Promise<AssetContainer>

The loaded asset container

loadAsyncSearch playground for loadAsync

loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>

- Defined in .temp/docdirectory/doc.d.ts:33660
Load into a scene.

Parameters
- scene: Scene
  
  The scene to load into
- data: any
  
  The data to import
- rootUrl: string
  
  The root url for scene and resources
- Optional onProgress: (event: ISceneLoaderProgressEvent) => void
  
  The callback when the load progresses
  - - (event: ISceneLoaderProgressEvent): void
    - Parameters
      - event: ISceneLoaderProgressEvent
      Returns void
- Optional fileName: string
  
  Defines the name of the file to load
Returns Promise<void>

Nothing

Optional loadFileSearch playground for loadFile

loadFile(scene: Scene, fileOrUrl: File | string, onSuccess: (data: any, responseURL?: string) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest

Inherited from ISceneLoaderPluginBase.loadFile
- Defined in .temp/docdirectory/doc.d.ts:33578
The callback called when loading from a url.

Parameters
- scene: Scene
  
  scene loading this url
- fileOrUrl: File | string
  
  file or url to load
- onSuccess: (data: any, responseURL?: string) => void
  
  callback called when the file successfully loads
  - - (data: any, responseURL?: string): void
    - Parameters
      - data: any
      - Optional responseURL: string
      Returns void
- Optional onProgress: (ev: ISceneLoaderProgressEvent) => void
  
  callback called while file is loading (if the server supports this mode)
  - - (ev: ISceneLoaderProgressEvent): void
    - Parameters
      - ev: ISceneLoaderProgressEvent
      Returns void
- Optional useArrayBuffer: boolean
  
  defines a boolean indicating that date must be returned as ArrayBuffer
- Optional onError: (request?: WebRequest, exception?: LoadFileError) => void
  
  callback called when the file fails to load
  - - (request?: WebRequest, exception?: LoadFileError): void
    - Parameters
      - Optional request: WebRequest
      - Optional exception: LoadFileError
      Returns void
Returns IFileRequest

a file request object

Optional rewriteRootURLSearch playground for rewriteRootURL

rewriteRootURL(rootUrl: string, responseURL?: string): string

Inherited from ISceneLoaderPluginBase.rewriteRootURL
- Defined in .temp/docdirectory/doc.d.ts:33598
The callback that allows custom handling of the root url based on the response url.

Parameters
- rootUrl: string
  
  the original root url
- Optional responseURL: string
  
  the response url if available
Returns string

the new root url

Hierarchy

Implemented by

Index

Properties

Methods

Properties

extensionsSearch playground for extensions

nameSearch playground for name

Methods

Optional canDirectLoadSearch playground for canDirectLoad

Parameters

data: string

Returns boolean

Optional directLoadSearch playground for directLoad

Parameters

scene: Scene

data: string

Returns any

importMeshAsyncSearch playground for importMeshAsync

Parameters

meshesNames: any

scene: Scene

data: any

rootUrl: string

Optional onProgress: (event: ISceneLoaderProgressEvent) => void

Parameters

event: ISceneLoaderProgressEvent

Returns void

Optional fileName: string

Returns Promise<ISceneLoaderAsyncResult>

loadAssetContainerAsyncSearch playground for loadAssetContainerAsync

Parameters

scene: Scene

data: any

rootUrl: string

Optional onProgress: (event: ISceneLoaderProgressEvent) => void

Parameters

event: ISceneLoaderProgressEvent

Returns void

Optional fileName: string

Returns Promise<AssetContainer>

loadAsyncSearch playground for loadAsync

Parameters

scene: Scene

data: any

rootUrl: string

Optional onProgress: (event: ISceneLoaderProgressEvent) => void

Parameters

event: ISceneLoaderProgressEvent

Returns void

Optional fileName: string

Returns Promise<void>

Optional loadFileSearch playground for loadFile

Parameters

scene: Scene

fileOrUrl: File | string

onSuccess: (data: any, responseURL?: string) => void

Parameters

data: any

Optional responseURL: string

Returns void

Optional onProgress: (ev: ISceneLoaderProgressEvent) => void

Parameters

ev: ISceneLoaderProgressEvent

Returns void

Optional useArrayBuffer: boolean

Optional onError: (request?: WebRequest, exception?: LoadFileError) => void

Parameters

Optional request: WebRequest

Optional exception: LoadFileError

Returns void

Returns IFileRequest

Optional rewriteRootURLSearch playground for rewriteRootURL

Parameters

rootUrl: string

Optional responseURL: string

Returns string