Interface ISceneLoaderPluginAsync
Hierarchy
- ISceneLoaderPluginBase
- ISceneLoaderPluginAsync
Implemented by
Index
Properties
extensionsSearch playground for extensions
The file extensions supported by this plugin.
nameSearch playground for name
The friendly name of this plugin.
Methods
Optional can
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 direct
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
import
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
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.)
load
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
Parameters
event: ISceneLoaderProgressEvent
Returns void
Optional fileName: string
Defines the name of the file to load
Returns Promise<AssetContainer>
The loaded asset container
load
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
Parameters
event: ISceneLoaderProgressEvent
Returns void
Optional fileName: string
Defines the name of the file to load
Returns Promise<void>
Nothing
Optional load
The callback called when loading from a url.
Parameters
scene: Scene
scene loading this url
fileOrUrl: string | File
file or url to load
onSuccess: ((data: any, responseURL?: string) => void)
callback called when the file successfully loads
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)
Parameters
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
Parameters
Optional request: WebRequest
Optional exception: LoadFileError
Returns void
Returns IFileRequest
a file request object
Optional rewrite
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
Interface used to define an async SceneLoader plugin