Class LoadingScreenPlugin

Loading Screen Plugin

Shows a configurable loading screen overlay over the canvas.

Hierarchy (View Summary)

AAssetManagerProcessStatePlugin
- LoadingScreenPlugin

Constructors

constructor

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

Properties

`Protected`_contentDiv

_contentDiv: undefined | HTMLDivElement

`Protected`_dirty

_dirty: boolean = false

`Protected`_mainDiv

_mainDiv: HTMLDivElement

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => 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

isEditor

isEditor: boolean = false

loader

loader: number = 0

loadingElement

loadingElement: HTMLDivElement = ...

loadingTextHeader

loadingTextHeader: string = 'Loading Files'

logoElement

logoElement: HTMLDivElement = ...

logoImage

logoImage: string = LoadingScreenPlugin.LS_DEFAULT_LOGO

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 }[] = ...

styles

styles: string = styles

`Optional`stylesheet

stylesheet?: HTMLStyleElement

`Optional`stylesheetLoader

stylesheetLoader?: HTMLStyleElement[]

textColor

textColor: string = '#222222'

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

`Static`LS_DEFAULT_LOGO

LS_DEFAULT_LOGO: string = 'https://threepipe.org/logo.svg'

`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: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AAssetManagerProcessStatePlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

visible

get visible(): boolean
Returns boolean
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:132

Methods

`Protected`_storeKey

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

`Protected`_updateMainDiv

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

`Protected`_updateVisibility

_updateVisibility(
processState: Map<string, { progress?: number; state: string }>,
errors: number,
): boolean
Parameters
- processState: Map<string, { progress?: number; state: string }>
- errors: number
Returns boolean
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:216

disable

disable(key: any): 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: any): 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: ISerializedConfig,
meta?: SerializationMetaType,
): null | LoadingScreenPlugin | Promise<null | LoadingScreenPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: 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:136

hideWithDelay

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

importState

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

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AAssetManagerProcessStatePlugin.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:80

maximize

maximize(): void
Returns void
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:168

minimize

minimize(): void
Returns void
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:163

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AAssetManagerProcessStatePlugin.onAdded
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:259

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AAssetManagerProcessStatePlugin.onRemove
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:266

refresh

refresh(): void
Returns void
- Defined in src/plugins/interaction/LoadingScreenPlugin.ts:25

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...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:151

togglePreview

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

toJSON

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

Class LoadingScreenPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LoadingScreenPlugin

Properties

Protected_contentDiv

Protected_dirty

Protected_mainDiv

Protected Optional_viewer

Protected_viewerListeners

background

backgroundBlur

backgroundOpacity

constructor

Optional Readonlycontainer

enabled

errorTextHeader

filesElement

hideDelay

hideOnFilesLoad

hideOnOnlyErrors

hideOnSceneObjectLoad

isEditor

loader

loadingElement

loadingTextHeader

logoElement

logoImage

minimizeOnSceneObjectLoad

Default

showFileNames

showOnFilesLoading

showOnSceneEmpty

showProcessStates

showProgress

spinners

styles

Optionalstylesheet

OptionalstylesheetLoader

textColor

OptionaluiConfig

StaticLS_DEFAULT_LOGO

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

visible

Returns boolean

Methods

Protected_onProcessStateUpdate

Returns void

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_showMainDiv

Returns void

Protected_storeKey

Parameters

Returns string

Protected_updateMainDiv

Parameters

Returns void

Protected_updateVisibility

Parameters

Returns boolean

disable

Parameters

Returns void

dispose

Returns void

`Protected`_contentDiv

`Protected`_dirty

`Protected`_mainDiv

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional` `Readonly`container

`Optional`stylesheet

`Optional`stylesheetLoader

`Optional`uiConfig

`Static`LS_DEFAULT_LOGO

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onProcessStateUpdate

`Protected`_onViewerEvent

`Protected`_showMainDiv

`Protected`_storeKey

`Protected`_updateMainDiv

`Protected`_updateVisibility

`Optional`setDirty