Class DepthOfFieldPlugin

Depth Of Field Plugin

Adds a depth of field effect with configurable focal point.

Hierarchy

PipelinePassPlugin<
DepthOfFieldPluginPass<DepthOfFieldPassId>,
DepthOfFieldPassId,
>
- DepthOfFieldPlugin

Constructors

constructor

new DepthOfFieldPlugin(
enabled?: boolean,
enableEdit?: boolean,
): DepthOfFieldPlugin
Parameters
- enabled: boolean = true
- enableEdit: boolean = false
Returns DepthOfFieldPlugin
Overrides PipelinePassPlugin<DepthOfFieldPluginPass<DepthOfFieldPassId>, DepthOfFieldPassId>.constructor
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:75

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected`_focalPointHit

_focalPointHit: Vector3 = ...

`Protected` `Optional`_pass

_pass?: DepthOfFieldPluginPass<"depthOfField">

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

crossFadeTime

crossFadeTime: number = 200

dependencies

dependencies: typeof GBufferPlugin[] = ...

enabled

enabled: boolean = true

enableEdit

enableEdit: boolean = false

isViewerPluginSync

isViewerPluginSync: true = ...

`Readonly`passId

passId: "depthOfField" = passId

uiConfig

uiConfig: UiObjectConfig = ...

`Static` `Readonly`OldPluginType

OldPluginType: "DepthOfFieldPlugin" = 'DepthOfFieldPlugin'

`Static` `Readonly`PluginType

PluginType: "DepthOfField" = 'DepthOfField'

Accessors

`Protected`_frameFadeTime

get _frameFadeTime(): number
Returns number
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:73

dirty

get dirty(): boolean
Returns boolean
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PipelinePassPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

pass

get pass(): T | undefined
Returns T | undefined
Inherited from PipelinePassPlugin.pass
- Defined in src/plugins/base/PipelinePassPlugin.ts:62

Methods

`Protected`_beforeRender

_beforeRender(
    scene: IScene,
    camera: ICamera,
    renderManager: IRenderManager,
): boolean
This function is called every frame before composer render, if this pass is being used in the pipeline
Parameters
- scene: IScene
- camera: ICamera
- renderManager: IRenderManager
Returns boolean
Overrides PipelinePassPlugin._beforeRender
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:169

`Protected`_createPass

_createPass(): DepthOfFieldPluginPass<"depthOfField">
Returns DepthOfFieldPluginPass<"depthOfField">
Overrides PipelinePassPlugin._createPass
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:103

`Protected`_onObjectHit

_onObjectHit(e: any): void
Parameters
- e: any
Returns void
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:94

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from PipelinePassPlugin._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from PipelinePassPlugin._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from PipelinePassPlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from PipelinePassPlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from PipelinePassPlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from PipelinePassPlugin.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig & { pass?: any },
meta?: SerializationMetaType,
): DepthOfFieldPlugin | Promise<DepthOfFieldPlugin | null> | null
Parameters
- data: ISerializedConfig & { pass?: any }
- Optionalmeta: SerializationMetaType
Returns DepthOfFieldPlugin | Promise<DepthOfFieldPlugin | null> | null
Inherited from PipelinePassPlugin.fromJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:70

getFocalPoint

getFocalPoint(): Vector3
Returns Vector3
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:90

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from PipelinePassPlugin.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from PipelinePassPlugin.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onAdded
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:110

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onRemove
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:119

setDirty

setDirty(): void
Returns void
Inherited from PipelinePassPlugin.setDirty
- Defined in src/plugins/base/PipelinePassPlugin.ts:74

setFocalPoint

setFocalPoint(p: Vector3, fade?: boolean, showGizmo?: boolean): void
Parameters
- p: Vector3
- fade: boolean = true
- showGizmo: boolean = false
Returns void
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:84

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig & { pass?: any }
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig & { pass?: any }
Inherited from PipelinePassPlugin.toJSON
- Defined in src/plugins/base/PipelinePassPlugin.ts:66

Class DepthOfFieldPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DepthOfFieldPlugin

Properties

Protected_dirty

Protected_focalPointHit

Protected Optional_pass

Protected Optional_viewer

Protected_viewerListeners

constructor

crossFadeTime

dependencies

enabled

enableEdit

isViewerPluginSync

ReadonlypassId

uiConfig

Static ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

Protected_frameFadeTime

Returns number

dirty

Returns boolean

Parameters

Returns void

pass

Returns T | undefined

Methods

Protected_beforeRender

Parameters

Returns boolean

Protected_createPass

Returns DepthOfFieldPluginPass<"depthOfField">

Protected_onObjectHit

Parameters

Returns void

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns DepthOfFieldPlugin | Promise<DepthOfFieldPlugin | null> | null

getFocalPoint

Returns Vector3

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

setFocalPoint

`Protected`_dirty

`Protected`_focalPointHit

`Protected` `Optional`_pass

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`passId

`Static` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_frameFadeTime

`Protected`_beforeRender

`Protected`_createPass

`Protected`_onObjectHit

`Protected`_onViewerEvent

`Protected`_storeKey