Interface ISceneLoaderPluginBase
Hierarchy
- ISceneLoaderPluginBase
Index
Properties
Methods
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 Direct LoadSearch playground for canDirectLoad
-
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 LoadSearch playground for directLoad
-
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
-
Optional load FileSearch playground for loadFile
-
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
-
-
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 RootURLSearch playground for rewriteRootURL
-
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 the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync