Class AViewerPlugin<TE, TViewer, IsSync>`Abstract`

Base Class for Viewer Plugins

Type Parameters

TE extends AViewerPluginEventMap = AViewerPluginEventMap
TViewer extends ThreeViewer = ThreeViewer
IsSync extends boolean = boolean

Hierarchy (View Summary)

EventDispatcher<TE & AViewerPluginEventMap>
- AViewerPlugin
  - AViewerPluginAsync
  - AViewerPluginSync

Implements

IViewerPlugin<TViewer, IsSync>

Index

Constructors

constructor

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

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: TViewer

`Protected`_viewerListeners

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

constructor

constructor: typeof AViewerPlugin

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

disable

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

dispose

dispose(): void
Returns void
Implementation of IViewerPlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:34

enable

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

`Abstract`onAdded

onAdded(viewer: TViewer): IsSync extends false ? Promise<void> : void
Parameters
- viewer: TViewer
Returns IsSync extends false ? Promise<void> : void
Implementation of IViewerPlugin.onAdded
- Defined in src/viewer/AViewerPlugin.ts:30

`Abstract`onRemove

onRemove(viewer: TViewer): IsSync extends false ? Promise<void> : void
Parameters
- viewer: TViewer
Returns IsSync extends false ? Promise<void> : void
Implementation of IViewerPlugin.onRemove
- Defined in src/viewer/AViewerPlugin.ts:32

`Optional`setDirty

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

toJSON

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

Class AViewerPlugin<TE, TViewer, IsSync>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns AViewerPlugin<TE, TViewer, IsSync>

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 | AViewerPlugin<TE, TViewer, IsSync> | Promise<null | AViewerPlugin<TE, TViewer, IsSync>>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

AbstractonAdded

Parameters

Returns IsSync extends false ? Promise<void> : void

AbstractonRemove

Parameters

Returns IsSync extends false ? Promise<void> : void

OptionalsetDirty

Parameters

Returns any

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

Class AViewerPlugin<TE, TViewer, IsSync>`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
| AViewerPlugin<TE, TViewer, IsSync>
| Promise<null | AViewerPlugin<TE, TViewer, IsSync>>

`Abstract`onAdded

`Abstract`onRemove

`Optional`setDirty