Class AViewerPluginSync<TE, TViewer>`Abstract`

Base Class for Sync Viewer Plugins

Type Parameters

TE extends AViewerPluginEventMap = AViewerPluginEventMap
TViewer extends ThreeViewer = ThreeViewer

Index

Constructors

constructor

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

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: TViewer

`Protected`_viewerListeners

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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

`Abstract`enabled

enabled: boolean

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: string = 'AViewerPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
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): void
Parameters
- key: any
Returns void
Inherited from AViewerPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:75

dispose

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

enable

enable(key: any): void
Parameters
- key: any
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
    | AViewerPluginSync<TE, TViewer>
    | Promise<null | AViewerPluginSync<TE, TViewer>>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns
    | null
    | AViewerPluginSync<TE, TViewer>
    | Promise<null | AViewerPluginSync<TE, TViewer>>
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): void
Parameters
- viewer: TViewer
Returns void
Overrides AViewerPlugin.onAdded
- Defined in src/viewer/AViewerPlugin.ts:146

onRemove

onRemove(viewer: TViewer): void
Parameters
- viewer: TViewer
Returns void
Overrides AViewerPlugin.onRemove
- Defined in src/viewer/AViewerPlugin.ts:150

`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
Inherited from AViewerPlugin.toJSON
- Defined in src/viewer/AViewerPlugin.ts:38

Class AViewerPluginSync<TE, TViewer>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns AViewerPluginSync<TE, TViewer>

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

Abstractenabled

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns | null | AViewerPluginSync<TE, TViewer> | Promise<null | AViewerPluginSync<TE, TViewer>>

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 AViewerPluginSync<TE, TViewer>`Abstract`

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Abstract`enabled

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

Returns
| null
| AViewerPluginSync<TE, TViewer>
| Promise<null | AViewerPluginSync<TE, TViewer>>

`Optional`setDirty