Class AAssetManagerProcessStatePlugin<TE>`Abstract`

Base Class for Sync Viewer Plugins

Type Parameters

TE extends AViewerPluginEventMap = AViewerPluginEventMap

Hierarchy (View Summary)

AViewerPluginSync<TE>
- AAssetManagerProcessStatePlugin
  - LoadingScreenPlugin

Index

Constructors

`Protected`constructor

new AAssetManagerProcessStatePlugin<
    TE extends AViewerPluginEventMap = AViewerPluginEventMap,
>(
    suffix: string,
    container?: HTMLElement,
): AAssetManagerProcessStatePlugin<TE>
Type Parameters
- TE extends AViewerPluginEventMap = AViewerPluginEventMap
Parameters
- suffix: string
- Optionalcontainer: HTMLElement
Returns AAssetManagerProcessStatePlugin<TE>
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/base/AAssetManagerProcessStatePlugin.ts:17

Properties

`Protected`_contentDiv

_contentDiv: undefined | HTMLDivElement

`Protected`_dirty

_dirty: boolean = false

`Protected`_mainDiv

_mainDiv: HTMLDivElement

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

`Optional` `Readonly`container

container?: HTMLElement

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

`Optional`uiConfig

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

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: string = 'AViewerPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onProcessStateUpdate

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

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

`Protected` `Abstract`_updateMainDiv

_updateMainDiv(
processState: Map<string, { progress?: number; state: string }>,
): void
Parameters
- processState: Map<string, { progress?: number; state: string }>
Returns void
- Defined in src/plugins/base/AAssetManagerProcessStatePlugin.ts:36

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

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

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/base/AAssetManagerProcessStatePlugin.ts:38

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/base/AAssetManagerProcessStatePlugin.ts:51

`Optional`setDirty

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

toJSON

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