Class: DepthOfFieldPlugin

Plugins.DepthOfFieldPlugin

Hierarchy

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

  ↳ DepthOfFieldPlugin

Implements

• IViewerPluginAsync

Properties

PluginType

▪ Static Readonly PluginType: "DepthOfField"

---

passId

• passId: "depthOfField"

Overrides

GenericFilterPlugin.passId

---

dependencies

• dependencies: typeof GBufferPlugin[]

Implementation of

IViewerPluginAsync.dependencies

---

enableEdit

• enableEdit: boolean = false

---

crossFadeTime

• crossFadeTime: number = 200

---

_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

---

_focalPointHit

• Protected _focalPointHit: Vector3

---

_pass

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

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

---

depthRange

• get depthRange(): number

Returns

number

• set depthRange(v): void

Parameters

Name	Type
v	number

Returns

void

---

nearBlurScale

• get nearBlurScale(): number

Returns

number

• set nearBlurScale(v): void

Parameters

Name	Type
v	number

Returns

void

---

farBlurScale

• get farBlurScale(): number

Returns

number

• set farBlurScale(v): void

Parameters

Name	Type
v	number

Returns

void

---

uiConfig

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

Returns

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

---

_frameFadeTime

• Protected get _frameFadeTime(): number

Returns

number

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

---

passCtor

▸ passCtor(v): DepthOfFieldPass

Parameters

Name	Type
v	ViewerApp

Returns

DepthOfFieldPass

Overrides

GenericFilterPlugin.passCtor

---

setFocalPoint

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

Parameters

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

Returns

void

---

getFocalPoint

▸ getFocalPoint(): Vector3

Returns

Vector3

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

GenericFilterPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Overrides

GenericFilterPlugin.onRemove

---

setDirty

▸ setDirty(): void

Returns

void

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Inherited from

GenericFilterPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | DepthOfFieldPlugin

Implementation of

IViewerPluginAsync.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

---

_onObjectHit

▸ Protected _onObjectHit(e): void

Parameters

Name	Type
e	any

Returns

void

---

_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 DepthOfFieldPlugin(enabled?, enableEdit?)

Parameters

Name	Type	Default value
enabled	boolean	true
enableEdit	boolean	false

Overrides

GenericFilterPlugin.constructor