Class LoadingScreenPlugin

Loading Screen Plugin

Shows a configurable loading screen overlay over the canvas.

Hierarchy (view full)

AAssetManagerProcessStatePlugin
- LoadingScreenPlugin

Index

Constructors

constructor

Accessors

dirty

Constructors

constructor

new LoadingScreenPlugin(container?): LoadingScreenPlugin
Parameters
- Optional container: HTMLElement
Returns LoadingScreenPlugin
Overrides AAssetManagerProcessStatePlugin.constructor
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:111

Properties

`Protected` _contentDiv

_contentDiv: undefined | HTMLDivElement

`Protected` _dirty

_dirty: boolean = false

`Private` _isHidden

_isHidden: boolean = false

`Private` _isPreviewing

_isPreviewing: boolean = false

`Protected` _mainDiv

_mainDiv: HTMLDivElement

`Private` _previewState

_previewState: Map<string, {
    progress: number;
    state: string;
} | {
    progress?: undefined;
    state: string;
}> = ...

`Private` _temp

_temp: HTMLTemplateElement = ...

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

background

background: string = '#ffffff'

backgroundBlur

backgroundBlur: number = 24

backgroundOpacity

backgroundOpacity: number = 0.5

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

`Optional` `Readonly` container

container?: HTMLElement

enabled

enabled: boolean = true

errorTextHeader

errorTextHeader: string = 'Error Loading Files'

filesElement

filesElement: HTMLDivElement = ...

hideDelay

hideDelay: number = 500

hideOnFilesLoad

hideOnFilesLoad: boolean = true

hideOnOnlyErrors

hideOnOnlyErrors: boolean = true

hideOnSceneObjectLoad

hideOnSceneObjectLoad: boolean = false

loader

loader: number = 0

loadingElement

loadingElement: HTMLDivElement = ...

loadingTextHeader

loadingTextHeader: string = 'Loading Files'

logoElement

logoElement: HTMLDivElement = ...

logoImage

logoImage: string = 'https://static.webgi.xyz/logo.svg'

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

showFileNames

showFileNames: boolean = true

showOnFilesLoading

showOnFilesLoading: boolean = true

showOnSceneEmpty

showOnSceneEmpty: boolean = true

showProcessStates

showProcessStates: boolean = true

showProgress

showProgress: boolean = true

spinners

spinners: {
html: string;
styles: string;
}[] = ...

Type declaration

html: string
styles: string

styles

styles: string = styles

`Optional` stylesheet

stylesheet?: HTMLStyleElement

`Optional` stylesheetLoader

stylesheetLoader?: HTMLStyleElement[]

textColor

textColor: string = '#222222'

`Optional` uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Optional` `Readonly` OldPluginType

OldPluginType?: string

`Static` `Readonly` PluginType

PluginType: "LoadingScreenPlugin" = 'LoadingScreenPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AAssetManagerProcessStatePlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:107
set dirty(value): void
Parameters
- value: boolean
Returns void
Inherited from AAssetManagerProcessStatePlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Protected` _onProcessStateUpdate

_onProcessStateUpdate(): void
Returns void
Inherited from AAssetManagerProcessStatePlugin._onProcessStateUpdate
- Defined in src/plugins/base/AAssetManagerProcessStatePlugin.ts:46

`Protected` _onViewerEvent

_onViewerEvent(e): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AAssetManagerProcessStatePlugin._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Private` _sceneUpdate

_sceneUpdate(e): void
Parameters
- e: any
Returns void
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:215

`Private` _setHTML

_setHTML(elem, html): void
Parameters
- elem: HTMLElement
- html: string
Returns void
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:168

`Protected` _showMainDiv

_showMainDiv(): void
Returns void
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:152

`Protected` _storeKey

_storeKey(prefix?): string
Parameters
- Optional prefix: string
Returns string
Inherited from AAssetManagerProcessStatePlugin._storeKey
- Defined in src/viewer/AViewerPlugin.ts:49

`Protected` _updateMainDiv

_updateMainDiv(processState, updateVisibility?): void
Parameters
- processState: Map<string, {
  progress?: number;
  state: string;
  }>
- updateVisibility: boolean = true
Returns void
Overrides AAssetManagerProcessStatePlugin._updateMainDiv
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:174

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from AAssetManagerProcessStatePlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

dispose(): void
Returns void
Inherited from AAssetManagerProcessStatePlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:29

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from AAssetManagerProcessStatePlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AAssetManagerProcessStatePlugin.exportState
- Defined in src/viewer/AViewerPlugin.ts:54

fromJSON

fromJSON(data, meta?): null | LoadingScreenPlugin | Promise<null | LoadingScreenPlugin>
Parameters
- data: ISerializedConfig
- Optional meta: SerializationMetaType
Returns null | LoadingScreenPlugin | Promise<null | LoadingScreenPlugin>
Inherited from AAssetManagerProcessStatePlugin.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:41

hide

hide(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:130

hideWithDelay

hideWithDelay(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:139

importState

importState(state): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AAssetManagerProcessStatePlugin.importState
- Defined in src/viewer/AViewerPlugin.ts:57

`Optional` setDirty

setDirty(...args): any
Parameters
- Rest ...args: any[]
Returns any
Inherited from AAssetManagerProcessStatePlugin.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

show

show(): void
Returns void
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:145

toJSON

toJSON(meta?): ISerializedConfig
Parameters
- Optional meta: SerializationMetaType
Returns ISerializedConfig
Inherited from AAssetManagerProcessStatePlugin.toJSON
- Defined in src/viewer/AViewerPlugin.ts:33

togglePreview

togglePreview(): void
Returns void
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:97

Class LoadingScreenPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional container: HTMLElement

Returns LoadingScreenPlugin

Properties

Protected _contentDiv

Protected _dirty

Private _isHidden

Private _isPreviewing

Protected _mainDiv

Private _previewState

Private _temp

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

background

backgroundBlur

backgroundOpacity

constructor

Optional Readonly container

enabled

errorTextHeader

filesElement

hideDelay

hideOnFilesLoad

hideOnOnlyErrors

hideOnSceneObjectLoad

loader

loadingElement

loadingTextHeader

logoElement

logoImage

minimizeOnSceneObjectLoad

Default

showFileNames

showOnFilesLoading

showOnSceneEmpty

showProcessStates

showProgress

spinners

Type declaration

html: string

styles: string

styles

Optional stylesheet

Optional stylesheetLoader

textColor

Optional uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onProcessStateUpdate

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Private _sceneUpdate

Parameters

e: any

Returns void

Private _setHTML

Parameters

`Optional` container: HTMLElement

`Protected` _contentDiv

`Protected` _dirty

`Private` _isHidden

`Private` _isPreviewing

`Protected` _mainDiv

`Private` _previewState

`Private` _temp

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` `Readonly` container

`Optional` stylesheet

`Optional` stylesheetLoader

`Optional` uiConfig

`Static` `Optional` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Protected` _onProcessStateUpdate

`Protected` _onViewerEvent

`Private` _sceneUpdate

`Private` _setHTML

`Protected` _showMainDiv

`Protected` _storeKey

`Optional` prefix: string

`Protected` _updateMainDiv

processState: Map<string, {
progress?: number;
state: string;
}>

`Optional` meta: SerializationMetaType

`Optional` setDirty

`Rest` ...args: any[]

`Optional` meta: SerializationMetaType