Class FilesInput
Hierarchy
- FilesInput
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates a new FilesInput
Parameters
-
engine: Engine
defines the rendering engine
-
scene: Nullable<Scene>
defines the hosting scene
-
sceneLoadedCallback: Nullable<(sceneFile: File, scene: Scene) => void>
callback called when scene is loaded
-
progressCallback: Nullable<(progress: ISceneLoaderProgressEvent) => void>
callback called to track progress
-
additionalRenderLoopLogicCallback: Nullable<() => void>
callback called to add user logic to the rendering loop
-
textureLoadingCallback: Nullable<(remaining: number) => void>
callback called when a texture is loading
-
startingProcessingFilesCallback: Nullable<(files?: File[]) => void>
callback called when the system is about to process all files
-
onReloadCallback: Nullable<(sceneFile: File) => void>
callback called when a reload is requested
-
errorCallback: Nullable<(sceneFile: File, scene: Nullable<Scene>, message: string) => void>
callback call if an error occurs
Returns FilesInput
-
Properties
load
Function used when loading the scene file
Type declaration
-
-
Parameters
-
sceneFile: File
-
onProgress: Nullable<(event: ISceneLoaderProgressEvent) => void>
Returns Promise<Scene>
-
-
on
Callback called when a file is processed
Type declaration
-
-
Parameters
-
file: File
-
name: string
-
extension: string
-
setSceneFileToLoad: (sceneFile: File) => void
-
-
Parameters
-
sceneFile: File
Returns void
-
-
-
Returns boolean
-
-
Accessors
files
-
Gets the current list of files to load
Returns File[]
Static Files
-
List of files ready to be loaded
Returns {}
-
[key: string]: File
-
Methods
disposeSearch playground for dispose
-
Release all associated resources
Returns void
load
-
Load files from a drop event
Parameters
-
event: any
defines the drop event to use as source
Returns void
-
monitor
-
Calls this function to listen to drag'n'drop events on a specific DOM element
Parameters
-
elementToMonitor: HTMLElement
defines the DOM element to track
Returns void
-
reloadSearch playground for reload
-
Reload the current scene from the loaded files
Returns void
Class used to help managing file picking and drag-n-drop