Class: BloomPlugin

Plugins.BloomPlugin

Hierarchy

• GenericFilterPlugin<BloomPass, "bloom", "">

  ↳ BloomPlugin

Implements

• IViewerPluginAsync
• IGBufferUpdater

Properties

PluginType

▪ Static Readonly PluginType: "Bloom"

---

passId

• passId: "bloom"

Overrides

GenericFilterPlugin.passId

---

materialExtension

• Readonly materialExtension: MaterialExtension

---

_dirty

• Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

---

_beforeFilters

• Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

---

_afterFilters

• Protected _afterFilters: string[]

Overrides

GenericFilterPlugin._afterFilters

---

_requiredFilters

• Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

---

_pass

• Protected Optional _pass: IFilter<BloomPass, "bloom">

Inherited from

GenericFilterPlugin._pass

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

GenericFilterPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

GenericFilterPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

GenericFilterPlugin.viewer

---

uiConfig

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

Returns

undefined | UiObjectConfig<any, string>

Implementation of

IViewerPluginAsync.uiConfig

---

enabled

• get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

---

pass

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

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Inherited from

GenericFilterPlugin.onDispose

---

exportState

▸ exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

GenericFilterPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

GenericFilterPlugin.loadState

---

setDirty

▸ setDirty(): void

Returns

void

---

passCtor

▸ passCtor(v): BloomPass

Parameters

Name	Type
v	ViewerApp

Returns

BloomPass

Overrides

GenericFilterPlugin.passCtor

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

GenericFilterPlugin.onAdded

---

updateGBuffer

▸ updateGBuffer(object, data): void

Parameters

Name	Type
object	Object3D<Object3DEventMap>
data	Vector4

Returns

void

Implementation of

IGBufferUpdater.updateGBuffer

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Inherited from

GenericFilterPlugin.onRemove

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Inherited from

GenericFilterPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | BloomPlugin

Implementation of

IViewerPluginAsync.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

---

_getUiConfig

▸ Protected _getUiConfig(material): UiObjectConfig<any, string>

Parameters

Name	Type
material	IMaterial<any, IMaterialEventMap>

Returns

UiObjectConfig<any, string>

---

_update

▸ Protected _update(v): boolean

This function is called every frame before composer render, if this pass is being used in the pipeline

Parameters

Name	Type
v	ViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Constructors

constructor

• new BloomPlugin()

Inherited from

GenericFilterPlugin.constructor