Viewer Core
Loader
Abstract class that is the base for all concrete loader implementations.
Constructors
constructor
Populates the loader with data.
Parameters
- resource: This can either be a resource URL, either an resource ID
- (optional) resourceData: Explicit data you want to load
Accessors
resource
Gets the loader’s resource.
Returns: string
Methods
load
This function needs to handle all the resource loading.
Returns: A promise which resolves to a boolean indicating if the loading process completed successfully (true) or was interrupted/failed (false)
cancel
This function needs to cancel any ongoing loading process and clean afterwards.
Returns: void
dispose
This function needs to dispose of the loader and it’s allocated resources.
Returns: void
Typedefs
LoaderEvent
The basic events any Loader implementation should use. Implemented and used by both SpeckleLoader
and ObjLoader
fully or partially.
LoaderEventPayload
Mapping of loader events to event handler argument types