Class: DepthOfFieldPlugin

Plugins.DepthOfFieldPlugin

Hierarchy

• GenericFilterPlugin<DepthOfFieldPass, "depthOfField", "">

  ↳ DepthOfFieldPlugin

Implements

• IViewerPlugin

Properties

PluginType

▪ Static Readonly PluginType: "DepthOfField"

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:14

---

passId

• passId: "depthOfField"

Overrides

GenericFilterPlugin.passId

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:15

---

dependencies

• dependencies: typeof GBufferPlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:21

---

enableEdit

• enableEdit: boolean = false

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:28

---

crossFadeTime

• crossFadeTime: number = 200

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:41

---

_dirty

• Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

---

_beforeFilters

• Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:17

---

_afterFilters

• Protected _afterFilters: string[]

Overrides

GenericFilterPlugin._afterFilters

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:18

---

_requiredFilters

• Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:19

---

_focalPointHit

• Protected _focalPointHit: Vector3

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:39

---

_pass

• Protected Optional _pass: IFilter<DepthOfFieldPass, "depthOfField">

Inherited from

GenericFilterPlugin._pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:9

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

---

depthRange

• get depthRange(): number

Returns

number

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:53

• set depthRange(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:57

---

nearBlurScale

• get nearBlurScale(): number

Returns

number

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:62

• set nearBlurScale(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:65

---

farBlurScale

• get farBlurScale(): number

Returns

number

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:70

• set farBlurScale(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:73

---

uiConfig

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

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:152

---

enabled

• get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:24

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:28

---

pass

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

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:69

---

_frameFadeTime

• Protected get _frameFadeTime(): number

Returns

number

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:80

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

GenericFilterPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36

---

exportState

▸ exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPlugin.storeState

Inherited from

GenericFilterPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

GenericFilterPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84

---

passCtor

▸ passCtor(v): DepthOfFieldPass

Parameters

Name	Type
v	ViewerApp

Returns

DepthOfFieldPass

Overrides

GenericFilterPlugin.passCtor

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:23

---

setFocalPoint

▸ setFocalPoint(p, fade?, showGizmo?): void

Parameters

Name	Type	Default value
p	Vector3	undefined
fade	boolean	true
showGizmo	boolean	false

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:43

---

getFocalPoint

▸ getFocalPoint(): Vector3

Returns

Vector3

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:49

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

GenericFilterPlugin.onAdded

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:91

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

GenericFilterPlugin.onRemove

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:99

---

setDirty

▸ setDirty(): void

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:104

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

GenericFilterPlugin.toJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:73

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | DepthOfFieldPlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:82

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

---

_onObjectHit

▸ Protected _onObjectHit(e): void

Parameters

Name	Type
e	any

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:82

---

_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

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:109

Constructors

constructor

• new DepthOfFieldPlugin(enabled?, enableEdit?)

Parameters

Name	Type	Default value
enabled	boolean	true
enableEdit	boolean	false

Overrides

GenericFilterPlugin.constructor

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:30