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:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22


enabled

get enabled(): boolean

Returns

boolean

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:17

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:21


pass

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

Returns

undefined | IFilter<T, TPassId>

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:62

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:38


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"serialize" | "deserialize" | TEvent
listener(event: IEvent<"serialize" | "deserialize" | TEvent>) => void

Returns

void

Implementation of

IViewerPlugin.addEventListener

Inherited from

AViewerPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"serialize" | "deserialize" | TEvent
listener(event: IEvent<"serialize" | "deserialize" | TEvent>) => void

Returns

boolean

Implementation of

IViewerPlugin.hasEventListener

Inherited from

AViewerPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"serialize" | "deserialize" | TEvent
listener(event: IEvent<"serialize" | "deserialize" | TEvent>) => void

Returns

void

Implementation of

IViewerPlugin.removeEventListener

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"serialize" | "deserialize" | TEvent>

Returns

void

Implementation of

IViewerPlugin.dispatchEvent

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


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:29


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:55


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:66


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:75


_update

Protected _update(v): boolean

Parameters

NameType
vTViewer

Returns

boolean

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:10

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:25


_viewer

Protected Optional _viewer: TViewer

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


_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:11


_beforeFilters

Protected Optional _beforeFilters: string[]

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:12


_requiredFilters

Protected Optional _requiredFilters: string[]

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:13

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:26