Class: LoadingScreenPlugin
Core-API.LoadingScreenPlugin
Hierarchy
AAssetManagerProcessStatePlugin↳
LoadingScreenPlugin
Properties
PluginType
▪ Static Readonly PluginType: "LoadingScreenPlugin"
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:10
enabled
• enabled: boolean = true
Inherited from
AAssetManagerProcessStatePlugin.enabled
Defined in
webgi/src/extras/asset_manager/AAssetManagerProcessStatePlugin.ts:14
dependencies
• dependencies: typeof AssetManagerPlugin[]
Inherited from
AAssetManagerProcessStatePlugin.dependencies
Defined in
webgi/src/extras/asset_manager/AAssetManagerProcessStatePlugin.ts:23
container
• Optional Readonly container: HTMLElement
Inherited from
AAssetManagerProcessStatePlugin.container
processState
• processState: Map<string, { state: string ; progress: undefined | number }>
Inherited from
AAssetManagerProcessStatePlugin.processState
Defined in
webgi/src/extras/asset_manager/AAssetManagerProcessStatePlugin.ts:45
styles
• styles: Object = popupStyles
Type declaration
| Name | Type |
|---|---|
use | (options?: { [id: string]: any; target?: HTMLElement }) => void |
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:12
spinners
• spinners: { styles: { use: (options?: { [id: string]: any; target?: HTMLElement }) => void } = spinner1; html: string = '<span class="loader"></span>' }[]
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:13
loader
• loader: number = 0
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:23
loadingTextHeader
• loadingTextHeader: string = 'Loading Files'
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:28
errorTextHeader
• errorTextHeader: string = 'Error Loading Files'
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:31
showFileNames
• showFileNames: boolean = true
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:36
showProcessStates
• showProcessStates: boolean = true
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:40
showProgress
• showProgress: boolean = true
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:44
hideOnOnlyErrors
• hideOnOnlyErrors: boolean = true
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:48
hideOnFilesLoad
• hideOnFilesLoad: boolean = true
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:51
hideOnSceneObjectLoad
• hideOnSceneObjectLoad: boolean = false
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:54
minimizeOnSceneObjectLoad
• minimizeOnSceneObjectLoad: boolean = true
Minimize when scene has objects Note: also checks for scene.environment and doesnt minimize when environment is null or undefined
default true
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:62
showOnFilesLoading
• showOnFilesLoading: boolean = true
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:66
showOnSceneEmpty
• showOnSceneEmpty: boolean = true
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:69
hideDelay
• hideDelay: number = 500
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:73
backgroundOpacity
• backgroundOpacity: number = 0.5
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:78
backgroundBlur
• backgroundBlur: number = 24
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:83
background
• background: string = '#ffffff'
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:88
textColor
• textColor: string = '#222222'
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:93
logoImage
• logoImage: string = 'https://static.webgi.xyz/logo.svg'
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:98
loadingElement
• loadingElement: HTMLDivElement
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:114
filesElement
• filesElement: HTMLDivElement
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:115
logoElement
• logoElement: HTMLDivElement
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:116
_dirty
• Protected _dirty: boolean = false
Inherited from
AAssetManagerProcessStatePlugin._dirty
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
AAssetManagerProcessStatePlugin._viewer
Defined in
webgi/src/core/AViewerPlugin.ts:27
_mainDiv
• Protected _mainDiv: HTMLDivElement
Inherited from
AAssetManagerProcessStatePlugin._mainDiv
Defined in
webgi/src/extras/asset_manager/AAssetManagerProcessStatePlugin.ts:16
_contentDiv
• Protected _contentDiv: undefined | HTMLDivElement
Inherited from
AAssetManagerProcessStatePlugin._contentDiv
Defined in
webgi/src/extras/asset_manager/AAssetManagerProcessStatePlugin.ts:17
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
AAssetManagerProcessStatePlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
AAssetManagerProcessStatePlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
AAssetManagerProcessStatePlugin.onDispose
Defined in
webgi/src/core/AViewerPlugin.ts:36
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
AAssetManagerProcessStatePlugin.toJSON
Defined in
webgi/src/core/AViewerPlugin.ts:45
fromJSON
▸ fromJSON(data, meta?): null | LoadingScreenPlugin | Promise<null | LoadingScreenPlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | LoadingScreenPlugin | Promise<null | LoadingScreenPlugin>
Inherited from
AAssetManagerProcessStatePlugin.fromJSON
Defined in
webgi/src/core/AViewerPlugin.ts:52
exportState
▸ exportState(): any
Returns
any
Inherited from
AAssetManagerProcessStatePlugin.exportState
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
AAssetManagerProcessStatePlugin.importState
Defined in
webgi/src/core/AViewerPlugin.ts:67
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
AAssetManagerProcessStatePlugin.storeState
Defined in
webgi/src/core/AViewerPlugin.ts:74
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Inherited from
AAssetManagerProcessStatePlugin.loadState
Defined in
webgi/src/core/AViewerPlugin.ts:84
refresh
▸ refresh(): void
Returns
void
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:17
togglePreview
▸ togglePreview(): void
Returns
void
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:104
hide
▸ hide(): Promise<void>
Returns
Promise<void>
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:137
hideWithDelay
▸ hideWithDelay(): Promise<void>
Returns
Promise<void>
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:146
show
▸ show(): void
Returns
void
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:152
minimize
▸ minimize(): void
Returns
void
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:164
maximize
▸ maximize(): void
Returns
void
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:169
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
AAssetManagerProcessStatePlugin.onAdded
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:236
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
AAssetManagerProcessStatePlugin.onRemove
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:244
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
AAssetManagerProcessStatePlugin._storeKey
Defined in
webgi/src/core/AViewerPlugin.ts:60
_showMainDiv
▸ Protected _showMainDiv(): void
Returns
void
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:159
_updateMainDiv
▸ Protected _updateMainDiv(processState, updateVisibility?): void
Parameters
| Name | Type | Default value |
|---|---|---|
processState | Map<string, { state: string ; progress?: number }> | undefined |
updateVisibility | boolean | true |
Returns
void
Overrides
AAssetManagerProcessStatePlugin._updateMainDiv
Defined in
webgi/src/extras/asset_manager/LoadingScreenPlugin.ts:178
Constructors
constructor
• new LoadingScreenPlugin(container?)
Parameters
| Name | Type |
|---|---|
container? | HTMLElement |
Overrides
AAssetManagerProcessStatePlugin.constructor