Skip to main content

Class: GenericFilterPlugin<T, TPassId, TEvent, TViewer>

Plugins.GenericFilterPlugin

Type parameters

NameType
Textends IPass
TPassIdextends IPassID
TEventextends string
TViewerextends IViewerApp = ViewerApp

Hierarchy

Implements

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


enabled

get enabled(): boolean

Returns

boolean

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:23

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:27


pass

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

Returns

undefined | IFilter<T, TPassId>

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:68

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

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

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

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


passCtor

Abstract passCtor(v): T

Parameters

NameType
vTViewer

Returns

T

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:9


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:35


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerTViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:61


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:72


fromJSON

fromJSON(data, meta?): null | GenericFilterPlugin<T, TPassId, TEvent, TViewer>

Parameters

NameType
dataany
meta?any

Returns

null | GenericFilterPlugin<T, TPassId, TEvent, TViewer>

Implementation of

IViewerPlugin.fromJSON

Overrides

AViewerPlugin.fromJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:81


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._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
vTViewer

Returns

boolean

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:16

Properties

passId

Abstract passId: TPassId

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:7


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: TViewer

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27


_pass

Protected Optional _pass: IFilter<T, TPassId>

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:8


_afterFilters

Protected Optional _afterFilters: string[]

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:17


_beforeFilters

Protected Optional _beforeFilters: string[]

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:18


_requiredFilters

Protected Optional _requiredFilters: string[]

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:19

Constructors

constructor

new GenericFilterPlugin<T, TPassId, TEvent, TViewer>()

Type parameters

NameType
Textends IPass<T>
TPassIdextends string
TEventextends string
TViewerextends IViewerApp<TViewer> = ViewerApp

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:32