Skip to main content

Class: VignettePlugin

Plugins.VignettePlugin

Hierarchy

  • GenericExtensionPlugin<VignetteExtension>

    VignettePlugin

Properties

PluginType

Static Readonly PluginType: "Vignette"

Defined in

webgi/src/plugins/threejs/VignettePlugin.ts:97


enabled

enabled: boolean = true

Inherited from

GenericExtensionPlugin.enabled

Defined in

webgi/src/plugins/GenericExtensionPlugin.ts:14


dependencies

dependencies: typeof CombinedPostPlugin[]

Inherited from

GenericExtensionPlugin.dependencies

Defined in

webgi/src/plugins/GenericExtensionPlugin.ts:16


_dirty

Protected _dirty: boolean = false

Inherited from

GenericExtensionPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

GenericExtensionPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27


_extension

Protected Optional _extension: VignetteExtension

Inherited from

GenericExtensionPlugin._extension

Defined in

webgi/src/plugins/GenericExtensionPlugin.ts:10

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

GenericExtensionPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

GenericExtensionPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


uiConfig

get uiConfig(): undefined | UiObjectConfig<any, string>

Returns

undefined | UiObjectConfig<any, string>

Inherited from

GenericExtensionPlugin.uiConfig

Defined in

webgi/src/plugins/GenericExtensionPlugin.ts:18


config

get config(): undefined | T

Returns

undefined | T

Inherited from

GenericExtensionPlugin.config

Defined in

webgi/src/plugins/GenericExtensionPlugin.ts:22


power

get power(): number

Returns

number

Defined in

webgi/src/plugins/threejs/VignettePlugin.ts:107

set power(value): void

Parameters

NameType
valuenumber

Returns

void

Defined in

webgi/src/plugins/threejs/VignettePlugin.ts:111


color

get color(): Color

Returns

Color

Defined in

webgi/src/plugins/threejs/VignettePlugin.ts:118

set color(value): void

Parameters

NameType
valueColor

Returns

void

Defined in

webgi/src/plugins/threejs/VignettePlugin.ts:122

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

GenericExtensionPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

GenericExtensionPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45


fromJSON

fromJSON(data, meta?): null | VignettePlugin | Promise<null | VignettePlugin>

Parameters

NameType
dataany
meta?any

Returns

null | VignettePlugin | Promise<null | VignettePlugin>

Inherited from

GenericExtensionPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52


exportState

exportState(): any

Returns

any

Inherited from

GenericExtensionPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

GenericExtensionPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

GenericExtensionPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

GenericExtensionPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


disposeExtension

disposeExtension(): void

Returns

void

Inherited from

GenericExtensionPlugin.disposeExtension

Defined in

webgi/src/plugins/GenericExtensionPlugin.ts:28


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

GenericExtensionPlugin.onAdded

Defined in

webgi/src/plugins/GenericExtensionPlugin.ts:32


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

GenericExtensionPlugin.onRemove

Defined in

webgi/src/plugins/GenericExtensionPlugin.ts:38


generateExtension

generateExtension(viewer): VignetteExtension

Parameters

NameType
viewerViewerApp

Returns

VignetteExtension

Overrides

GenericExtensionPlugin.generateExtension

Defined in

webgi/src/plugins/threejs/VignettePlugin.ts:103


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

GenericExtensionPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

new VignettePlugin()

Overrides

GenericExtensionPlugin<VignetteExtension\>.constructor

Defined in

webgi/src/plugins/threejs/VignettePlugin.ts:99