Skip to main content

Class: DepthOfFieldPlugin

Plugins.DepthOfFieldPlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "DepthOfField"

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:15


passId

passId: "depthOfField"

Overrides

GenericFilterPlugin.passId

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:16


dependencies

dependencies: typeof GBufferPlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:22


enableEdit

enableEdit: boolean = false

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:29


crossFadeTime

crossFadeTime: number = 200

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:42


_dirty

Protected _dirty: boolean = false

Inherited from

GenericFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

GenericFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


_beforeFilters

Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:18


_afterFilters

Protected _afterFilters: string[]

Overrides

GenericFilterPlugin._afterFilters

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:19


_requiredFilters

Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:20


_focalPointHit

Protected _focalPointHit: Vector3

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:40


_pass

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

Inherited from

GenericFilterPlugin._pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:8

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22


depthRange

get depthRange(): number

Returns

number

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:54

set depthRange(v): void

Parameters

NameType
vnumber

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:58


nearBlurScale

get nearBlurScale(): number

Returns

number

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:63

set nearBlurScale(v): void

Parameters

NameType
vnumber

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:66


farBlurScale

get farBlurScale(): number

Returns

number

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:71

set farBlurScale(v): void

Parameters

NameType
vnumber

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:74


uiConfig

get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:151


enabled

get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:17

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:21


pass

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

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:62


_frameFadeTime

Protected get _frameFadeTime(): number

Returns

number

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:81

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

GenericFilterPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Implementation of

IViewerPlugin.addEventListener

Inherited from

GenericFilterPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Implementation of

IViewerPlugin.hasEventListener

Inherited from

GenericFilterPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Implementation of

IViewerPlugin.removeEventListener

Inherited from

GenericFilterPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Implementation of

IViewerPlugin.dispatchEvent

Inherited from

GenericFilterPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


passCtor

passCtor(v): DepthOfFieldPass

Parameters

NameType
vViewerApp

Returns

DepthOfFieldPass

Overrides

GenericFilterPlugin.passCtor

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:24


setFocalPoint

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

Parameters

NameTypeDefault value
pVector3undefined
fadebooleantrue
showGizmobooleanfalse

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:44


getFocalPoint

getFocalPoint(): Vector3

Returns

Vector3

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:50


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

GenericFilterPlugin.onAdded

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:92


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

GenericFilterPlugin.onRemove

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:100


setDirty

setDirty(): void

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:105


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

GenericFilterPlugin.toJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:66


fromJSON

fromJSON(data, meta?): null | DepthOfFieldPlugin

Parameters

NameType
dataany
meta?any

Returns

null | DepthOfFieldPlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:75


_onObjectHit

Protected _onObjectHit(e): void

Parameters

NameType
eany

Returns

void

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:83


_update

Protected _update(v): boolean

Parameters

NameType
vViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:110

Constructors

constructor

new DepthOfFieldPlugin(enabled?, enableEdit?)

Parameters

NameTypeDefault value
enabledbooleantrue
enableEditbooleanfalse

Overrides

GenericFilterPlugin.constructor

Defined in

webgi/src/plugins/DepthOfFieldPlugin.ts:31