Class: SSRPlugin

Plugins.SSRPlugin

Hierarchy

• MultiFilterPlugin<"", [IFilter<SSRPass, "ssr">], ViewerApp>

  ↳ SSRPlugin

Implements

• IViewerPlugin

Properties

PluginType

▪ Static Readonly PluginType: "SSReflection"

Defined in

webgi/src/plugins/SSRPlugin.ts:15

---

dependencies

• dependencies: (typeof AssetManagerPlugin | typeof ProgressivePlugin | typeof GBufferPlugin)[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/SSRPlugin.ts:18

---

inlineSSR

• inlineSSR: boolean = true

Defined in

webgi/src/plugins/SSRPlugin.ts:39

---

_dirty

• Protected _dirty: boolean = false

Inherited from

MultiFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

MultiFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

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

MultiFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

---

passes

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

Returns

TTupleRecord<TPasses, "passId">

Inherited from

MultiFilterPlugin.passes

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:17

---

pipeline

• get pipeline(): string[]

Returns

string[]

Inherited from

MultiFilterPlugin.pipeline

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:22

• set pipeline(value): void

Parameters

Name	Type
value	string[]

Returns

void

Inherited from

MultiFilterPlugin.pipeline

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:26

---

ssrTarget

• get ssrTarget(): undefined | IRenderTarget

Returns

undefined | IRenderTarget

Defined in

webgi/src/plugins/SSRPlugin.ts:12

---

enabled

• get enabled(): boolean

Returns

boolean

Overrides

MultiFilterPlugin.enabled

Defined in

webgi/src/plugins/SSRPlugin.ts:25

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Overrides

MultiFilterPlugin.enabled

Defined in

webgi/src/plugins/SSRPlugin.ts:29

---

uiConfig

• get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/SSRPlugin.ts:66

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

MultiFilterPlugin.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"
listener	(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Implementation of

IViewerPlugin.addEventListener

Inherited from

MultiFilterPlugin.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"
listener	(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Implementation of

IViewerPlugin.hasEventListener

Inherited from

MultiFilterPlugin.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"
listener	(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Implementation of

IViewerPlugin.removeEventListener

Inherited from

MultiFilterPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63

---

dispatchEvent

▸ dispatchEvent(event): void

Fire an event type.

Parameters

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

Returns

void

Implementation of

IViewerPlugin.dispatchEvent

Inherited from

MultiFilterPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

MultiFilterPlugin.toJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:65

---

fromJSON

▸ fromJSON(data, meta?): null | SSRPlugin

Parameters

Name	Type
data	any
meta?	any

Returns

null | SSRPlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

MultiFilterPlugin.fromJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:77

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

MultiFilterPlugin.onAdded

Defined in

webgi/src/plugins/SSRPlugin.ts:33

---

createPasses

▸ createPasses(v): [IFilter<SSRPass, "ssr">]

Parameters

Name	Type
v	ViewerApp

Returns

[IFilter<SSRPass, "ssr">]

Overrides

MultiFilterPlugin.createPasses

Defined in

webgi/src/plugins/SSRPlugin.ts:40

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

MultiFilterPlugin.onRemove

Defined in

webgi/src/plugins/SSRPlugin.ts:55

---

setDirty

▸ setDirty(): void

Returns

void

Defined in

webgi/src/plugins/SSRPlugin.ts:60

Constructors

constructor

• new SSRPlugin()

Overrides

MultiFilterPlugin.constructor

Defined in

webgi/src/plugins/SSRPlugin.ts:20