Skip to main content

Class: GenericFilterPlugin<T, TPassId, TEvent>

Plugins.GenericFilterPlugin

Type parameters

NameType
Textends IPass
TPassIdextends IPassID
TEventextends string

Hierarchy

Implements

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

AViewerPlugin.dirty

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

AViewerPlugin.dirty


viewer

get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer


enabled

get enabled(): boolean

Returns

boolean

Overrides

AViewerPlugin.enabled

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Overrides

AViewerPlugin.enabled


pass

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

Returns

undefined | IFilter<T, TPassId>

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Inherited from

AViewerPlugin.onDispose


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

AViewerPlugin.storeState


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

AViewerPlugin.loadState


passCtor

Abstract passCtor(v): T

Parameters

NameType
vViewerApp

Returns

T


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

AViewerPlugin.onAdded


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Overrides

AViewerPlugin.onRemove


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Overrides

AViewerPlugin.toJSON


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | GenericFilterPlugin<T, TPassId, TEvent>

Implementation of

IViewerPluginAsync.fromJSON

Overrides

AViewerPlugin.fromJSON


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey


_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

Properties

passId

Abstract passId: TPassId


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer


_pass

Protected Optional _pass: IFilter<T, TPassId>


_afterFilters

Protected Optional _afterFilters: string[]


_beforeFilters

Protected Optional _beforeFilters: string[]


_requiredFilters

Protected Optional _requiredFilters: string[]

Constructors

constructor

new GenericFilterPlugin<T, TPassId, TEvent>()

Type parameters

NameType
Textends IPass<T>
TPassIdextends string
TEventextends string

Overrides

AViewerPlugin.constructor