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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

`Optional` `Readonly`container

container?: HTMLElement

enabled

enabled: boolean = 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:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

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:68

`Protected`_storeKey

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

`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:75

dispose

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

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:80

exportState

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

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:46

importState

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

isDisabled

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

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:89

toJSON

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

Class AAssetManagerProcessStatePlugin<TE>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns AAssetManagerProcessStatePlugin<TE>

Properties

Protected_contentDiv

Protected_dirty

Protected_mainDiv

Protected Optional_viewer

Protected_viewerListeners

constructor

Optional Readonlycontainer

enabled

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onProcessStateUpdate

Returns void

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

Protected Abstract_updateMainDiv

Parameters

Returns void

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns | null | AAssetManagerProcessStatePlugin<TE> | Promise<null | AAssetManagerProcessStatePlugin<TE>>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

Class AAssetManagerProcessStatePlugin<TE>`Abstract`

`Protected`constructor

`Protected`_contentDiv

`Protected`_dirty

`Protected`_mainDiv

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional` `Readonly`container

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onProcessStateUpdate

`Protected`_onViewerEvent

`Protected`_storeKey

`Protected` `Abstract`_updateMainDiv

Returns
| null
| AAssetManagerProcessStatePlugin<TE>
| Promise<null | AAssetManagerProcessStatePlugin<TE>>

`Optional`setDirty