Interface ISceneLoaderPlugin
extensions: string | ISceneLoaderPluginExtensions;
name: string;
canDirectLoad?(data: string): boolean;
directLoad?(scene: Scene, data: string): unknown;
importMesh(
meshesNames: string | readonly string[] | null | undefined,
scene: Scene,
data: unknown,
rootUrl: string,
meshes: AbstractMesh[],
particleSystems: IParticleSystem[],
skeletons: Skeleton[],
onError?: (message: string, exception?: any) => void,
): boolean;
load(
scene: Scene,
data: unknown,
rootUrl: string,
onError?: (message: string, exception?: any) => void,
): boolean;
loadAssetContainer(
scene: Scene,
data: unknown,
rootUrl: string,
onError?: (message: string, exception?: any) => void,
): AssetContainer;
loadFile?(
scene: Scene,
fileOrUrl: string | ArrayBufferView<ArrayBufferLike> | 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
- ISceneLoaderPlugin
Properties
Readonlyextensions
The file extensions supported by the plugin.
Readonlyname
The friendly name of the plugin.
Methods
Optionalcan
-
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
- data: string
Optionaldirect
-
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
- scene: Scene
import
-
importMesh(
meshesNames: string | readonly string[] | null | undefined,
scene: Scene,
data: unknown,
rootUrl: string,
meshes: AbstractMesh[],
particleSystems: IParticleSystem[],
skeletons: Skeleton[],
onError?: (message: string, exception?: any) => void,
): booleanImport meshes into a scene.
Parameters
- meshesNames: 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
- scene: Scene
The scene to import into
- data: unknown
The data to import
- rootUrl: string
The root url for scene and resources
- meshes: AbstractMesh[]
The meshes array to import into
- particleSystems: IParticleSystem[]
The particle systems array to import into
- skeletons: Skeleton[]
The skeletons array to import into
OptionalonError: (message: string, exception?: any) => voidThe callback when import fails
Returns boolean
True if successful or false otherwise
- meshesNames: string | readonly string[] | null | undefined
load
-
load(
scene: Scene,
data: unknown,
rootUrl: string,
onError?: (message: string, exception?: any) => void,
): booleanLoad 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
OptionalonError: (message: string, exception?: any) => voidThe callback when import fails
Returns boolean
True if successful or false otherwise
- scene: Scene
load
-
loadAssetContainer(
scene: Scene,
data: unknown,
rootUrl: string,
onError?: (message: string, exception?: any) => void,
): AssetContainerLoad 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
OptionalonError: (message: string, exception?: any) => voidThe callback when import fails
Returns AssetContainer
The loaded asset container
- scene: Scene
Optionalload
-
loadFile?(
scene: Scene,
fileOrUrl: string | ArrayBufferView<ArrayBufferLike> | 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<ArrayBufferLike> | 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) => voidcallback called while file is loading (if the server supports this mode)
OptionaluseArrayBuffer: booleandefines a boolean indicating that date must be returned as ArrayBuffer
OptionalonError: (request?: WebRequest, exception?: LoadFileError) => voidcallback called when the file fails to load
Optionalname: stringdefines the name of the file when loading a binary file
Returns Nullable<IFileRequest>
a file request object
- scene: Scene
Optionalrewrite
-
The callback that allows custom handling of the root url based on the response url.
Parameters
- rootUrl: string
the original root url
OptionalresponseURL: stringthe response url if available
Returns string
the new root url
- rootUrl: string
Interface used to define a SceneLoader plugin