Skip to main content

Class: CombinedPostPlugin

Plugins.CombinedPostPlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "CombinedPostPlugin"

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:12


passId

passId: "combinedPost"

Overrides

GenericFilterPlugin.passId

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:13


dependencies

dependencies: typeof GBufferPlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:15


toJSON

toJSON: any = undefined

Implementation of

IViewerPlugin.toJSON

Overrides

GenericFilterPlugin.toJSON

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:17


depthTonemap

Readonly depthTonemap: boolean = true


_dirty

Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27


_pass

Protected Optional _pass: IFilter<CombinedPostPass, "combinedPost">

Inherited from

GenericFilterPlugin._pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:8


_beforeFilters

Protected _beforeFilters: never[] = []

Overrides

GenericFilterPlugin._beforeFilters

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:19


_afterFilters

Protected _afterFilters: string[]

Overrides

GenericFilterPlugin._afterFilters

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:20


_requiredFilters

Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:21

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


enabled

get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:23

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:27


pass

get pass(): undefined | IFilter<T, TPassId>

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:68


renderToScreen

get renderToScreen(): boolean

Returns

boolean

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:24


uiConfig

get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:83

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

GenericFilterPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


exportState

exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

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

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

GenericFilterPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


fromJSON

fromJSON(data, meta?): null | CombinedPostPlugin

Parameters

NameType
dataany
meta?any

Returns

null | CombinedPostPlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:81


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

GenericFilterPlugin.onAdded

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:42


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

GenericFilterPlugin.onRemove

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:52


passCtor

passCtor(v): CombinedPostPass

Parameters

NameType
vViewerApp

Returns

CombinedPostPass

Overrides

GenericFilterPlugin.passCtor

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:57


addExtension

addExtension(extension): void

Parameters

NameType
extensionMaterialExtension

Returns

void

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:89


reRender

reRender(): void

Returns

void

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:94


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60


_update

Protected _update(v): boolean

This function is called every frame before composer render, if this pass is being used in the pipeline

Parameters

NameType
vViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:72

Constructors

constructor

new CombinedPostPlugin(depthTonemap?, renderToScreen?)

Parameters

NameTypeDefault value
depthTonemapbooleantrue
renderToScreenbooleantrue

Overrides

GenericFilterPlugin.constructor

Defined in

webgi/src/plugins/threejs/CombinedPostPlugin.ts:28