Class AViewerPluginAsync<TE, TViewer>`Abstract`

Base Class for Async Viewer Plugins

Type Parameters

TE extends AViewerPluginEventMap = AViewerPluginEventMap
TViewer extends ThreeViewer = ThreeViewer

Hierarchy (View Summary)

AViewerPlugin<TE, TViewer, false>
- AViewerPluginAsync

Implements

IViewerPluginAsync<TViewer>

Index

Constructors

Properties

_dirty _viewer? _viewerListeners constructor enabled uiConfig? OldPluginType? PluginType

Accessors

Methods

_onViewerEvent _storeKey disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove setDirty? toJSON

Constructors

constructor

new AViewerPluginAsync<
TE extends AViewerPluginEventMap = AViewerPluginEventMap,
TViewer extends ThreeViewer = ThreeViewer,
>(): AViewerPluginAsync<TE, TViewer>
Creates EventDispatcher object.
Type Parameters
- TE extends AViewerPluginEventMap = AViewerPluginEventMap
- TViewer extends ThreeViewer = ThreeViewer
Returns AViewerPluginAsync<TE, TViewer>
Inherited from AViewerPlugin.constructor
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:55

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: TViewer

`Protected`_viewerListeners

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

constructor

constructor: typeof AViewerPluginAsync & typeof AViewerPlugin

`Abstract`enabled

enabled: boolean

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

disable

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

dispose

dispose(): void
Returns void
Implementation of IViewerPluginAsync.dispose
Inherited from AViewerPlugin.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 AViewerPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:80

exportState

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

fromJSON

fromJSON(
    data: ISerializedConfig,
    meta?: SerializationMetaType,
):
    | null
    | AViewerPluginAsync<TE, TViewer>
    | Promise<null | AViewerPluginAsync<TE, TViewer>>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns
    | null
    | AViewerPluginAsync<TE, TViewer>
    | Promise<null | AViewerPluginAsync<TE, TViewer>>
Implementation of IViewerPluginAsync.fromJSON
Inherited from AViewerPlugin.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:46

importState

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

isDisabled

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

onAdded

onAdded(viewer: TViewer): Promise<void>
Parameters
- viewer: TViewer
Returns Promise<void>
Implementation of IViewerPluginAsync.onAdded
Overrides AViewerPlugin.onAdded
- Defined in src/viewer/AViewerPlugin.ts:165

onRemove

onRemove(viewer: TViewer): Promise<void>
Parameters
- viewer: TViewer
Returns Promise<void>
Implementation of IViewerPluginAsync.onRemove
Overrides AViewerPlugin.onRemove
- Defined in src/viewer/AViewerPlugin.ts:169

`Optional`setDirty

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

toJSON

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