Class: MultiFilterPlugin<TEvent, TPasses, TViewer>

Plugins.MultiFilterPlugin

Type parameters

Name	Type
TEvent	extends string
TPasses	extends IFilter<IPass, IPassID>[]
TViewer	extends IViewerApp = ViewerApp

Hierarchy

• AViewerPlugin<TEvent, TViewer>

  ↳ MultiFilterPlugin

  ↳↳ ProgressivePlugin

  ↳↳ SSAOPlugin

  ↳↳ SSGIPlugin

  ↳↳ SSRPlugin

Implements

• IViewerPlugin

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

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

---

passes

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

Returns

TTupleRecord<TPasses, "passId">

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:17

---

pipeline

• get pipeline(): string[]

Returns

string[]

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:22

• set pipeline(value): void

Parameters

Name	Type
value	string[]

Returns

void

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:26

Properties

enabled

• Abstract enabled: boolean

Inherited from

AViewerPlugin.enabled

Defined in

webgi/src/core/AViewerPlugin.ts:32

---

_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

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	TViewer

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

Name	Type
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

Name	Type
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

Name	Type
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

Name	Type
event	IEvent<"serialize" | "deserialize" | TEvent>

Returns

void

Implementation of

IViewerPlugin.dispatchEvent

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74

---

createPasses

▸ Abstract createPasses(v): TPasses

Parameters

Name	Type
v	TViewer

Returns

TPasses

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:32

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	TViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:40

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	TViewer

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:53

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPlugin.toJSON

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:65

---

fromJSON

▸ fromJSON(data, meta?): null | MultiFilterPlugin<TEvent, TPasses, TViewer>

Parameters

Name	Type
data	any
meta?	any

Returns

null | MultiFilterPlugin<TEvent, TPasses, TViewer>

Implementation of

IViewerPlugin.fromJSON

Overrides

AViewerPlugin.fromJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:77

Constructors

constructor

• new MultiFilterPlugin<TEvent, TPasses, TViewer>()

Type parameters

Name	Type
TEvent	extends string
TPasses	extends IFilter<IPass, string>[]
TViewer	extends IViewerApp<TViewer> = ViewerApp

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:36