Class: LoadingScreenPlugin

Core-API.LoadingScreenPlugin

Hierarchy

• AAssetManagerProcessStatePlugin

  ↳ LoadingScreenPlugin

Properties

PluginType

▪ Static Readonly PluginType: "LoadingScreenPlugin"

---

LS_DEFAULT_LOGO

▪ Static LS_DEFAULT_LOGO: string = 'https://static.webgi.xyz/logo.svg'

---

enabled

• enabled: boolean = true

Inherited from

AAssetManagerProcessStatePlugin.enabled

---

dependencies

• dependencies: typeof AssetManagerPlugin[]

Inherited from

AAssetManagerProcessStatePlugin.dependencies

---

container

• Optional Readonly container: HTMLElement

Inherited from

AAssetManagerProcessStatePlugin.container

---

processState

• processState: Map<string, { state: string ; progress: undefined | number }>

Inherited from

AAssetManagerProcessStatePlugin.processState

---

styles

• styles: Object = popupStyles

Type declaration

Name	Type
use	(options?: { [id: string]: any; target?: HTMLElement }) => void

---

spinners

• spinners: { styles: { use: (options?: { [id: string]: any; target?: HTMLElement }) => void } = spinner1; html: string = '<span class="loader"></span>' }[]

---

loader

• loader: number = 0

---

loadingTextHeader

• loadingTextHeader: string = 'Loading Files'

---

errorTextHeader

• errorTextHeader: string = 'Error Loading Files'

---

showFileNames

• showFileNames: boolean = true

---

showProcessStates

• showProcessStates: boolean = true

---

showProgress

• showProgress: boolean = true

---

hideOnOnlyErrors

• hideOnOnlyErrors: boolean = true

---

hideOnFilesLoad

• hideOnFilesLoad: boolean = true

---

hideOnSceneObjectLoad

• hideOnSceneObjectLoad: boolean = false

---

minimizeOnSceneObjectLoad

• minimizeOnSceneObjectLoad: boolean = true

Minimize when scene has objects Note: also checks for scene.environment and doesn't minimize when environment is null or undefined

default true

---

showOnFilesLoading

• showOnFilesLoading: boolean = true

---

showOnSceneEmpty

• showOnSceneEmpty: boolean = true

---

hideDelay

• hideDelay: number = 500

---

backgroundOpacity

• backgroundOpacity: number = 0.5

---

backgroundBlur

• backgroundBlur: number = 24

---

background

• background: string = '#ffffff'

---

textColor

• textColor: string = '#222222'

---

logoImage

• logoImage: string = LoadingScreenPlugin.LS_DEFAULT_LOGO

---

loadingElement

• loadingElement: HTMLDivElement

---

filesElement

• filesElement: HTMLDivElement

---

logoElement

• logoElement: HTMLDivElement

---

isEditor

• isEditor: boolean = false

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AAssetManagerProcessStatePlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AAssetManagerProcessStatePlugin._viewer

---

_mainDiv

• Protected _mainDiv: HTMLDivElement

Inherited from

AAssetManagerProcessStatePlugin._mainDiv

---

_contentDiv

• Protected _contentDiv: undefined | HTMLDivElement

Inherited from

AAssetManagerProcessStatePlugin._contentDiv

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AAssetManagerProcessStatePlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AAssetManagerProcessStatePlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AAssetManagerProcessStatePlugin.viewer

---

visible

• get visible(): boolean

Returns

boolean

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AAssetManagerProcessStatePlugin.onDispose

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AAssetManagerProcessStatePlugin.toJSON

---

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

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AAssetManagerProcessStatePlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AAssetManagerProcessStatePlugin.importState

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AAssetManagerProcessStatePlugin.storeState

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AAssetManagerProcessStatePlugin.loadState

---

refresh

▸ refresh(): void

Returns

void

---

togglePreview

▸ togglePreview(): void

Returns

void

---

hide

▸ hide(): Promise<void>

Returns

Promise<void>

---

hideWithDelay

▸ hideWithDelay(): Promise<void>

Returns

Promise<void>

---

show

▸ show(): void

Returns

void

---

minimize

▸ minimize(): void

Returns

void

---

maximize

▸ maximize(): void

Returns

void

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AAssetManagerProcessStatePlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AAssetManagerProcessStatePlugin.onRemove

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AAssetManagerProcessStatePlugin._storeKey

---

_showMainDiv

▸ Protected _showMainDiv(): void

Returns

void

---

_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

Constructors

constructor

• new LoadingScreenPlugin(container?)

Parameters

Name	Type
container?	HTMLElement

Overrides

AAssetManagerProcessStatePlugin.constructor