Skip to main content

Class: SSGIPlugin

Plugins.SSGIPlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "SSGI"

Defined in

webgi/src/plugins/SSGIPlugin.ts:22


dependencies

dependencies: (typeof AssetManagerPlugin | typeof ProgressivePlugin | typeof GBufferPlugin)[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/SSGIPlugin.ts:26


_dirty

Protected _dirty: boolean = false

Inherited from

MultiFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

MultiFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

MultiFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

MultiFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


passes

get passes(): TTupleRecord<TPasses, "passId">

Returns

TTupleRecord<TPasses, "passId">

Inherited from

MultiFilterPlugin.passes

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:17


pipeline

get pipeline(): string[]

Returns

string[]

Inherited from

MultiFilterPlugin.pipeline

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:22

set pipeline(value): void

Parameters

NameType
valuestring[]

Returns

void

Inherited from

MultiFilterPlugin.pipeline

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:26


rtgiTarget

get rtgiTarget(): undefined | WebGLRenderTarget

Returns

undefined | WebGLRenderTarget

Defined in

webgi/src/plugins/SSGIPlugin.ts:18


enabled

get enabled(): boolean

Returns

boolean

Overrides

MultiFilterPlugin.enabled

Defined in

webgi/src/plugins/SSGIPlugin.ts:42

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Overrides

MultiFilterPlugin.enabled

Defined in

webgi/src/plugins/SSGIPlugin.ts:46


uiConfig

get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/SSGIPlugin.ts:101

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

MultiFilterPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


exportState

exportState(): any

Returns

any

Inherited from

MultiFilterPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

MultiFilterPlugin.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

Implementation of

IViewerPlugin.storeState

Inherited from

MultiFilterPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

MultiFilterPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

MultiFilterPlugin.toJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:65


fromJSON

fromJSON(data, meta?): null | SSGIPlugin

Parameters

NameType
dataany
meta?any

Returns

null | SSGIPlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

MultiFilterPlugin.fromJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:77


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

MultiFilterPlugin.onAdded

Defined in

webgi/src/plugins/SSGIPlugin.ts:36


createPasses

createPasses(v): [IFilter<SSRTAOPass, "ssrtgi">]

Parameters

NameType
vViewerApp

Returns

[IFilter<SSRTAOPass, "ssrtgi">]

Overrides

MultiFilterPlugin.createPasses

Defined in

webgi/src/plugins/SSGIPlugin.ts:51


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

MultiFilterPlugin.onRemove

Defined in

webgi/src/plugins/SSGIPlugin.ts:90


setDirty

setDirty(): void

Returns

void

Defined in

webgi/src/plugins/SSGIPlugin.ts:95


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

MultiFilterPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

new SSGIPlugin(enabled?)

Parameters

NameTypeDefault value
enabledbooleantrue

Overrides

MultiFilterPlugin.constructor

Defined in

webgi/src/plugins/SSGIPlugin.ts:30