Class DepthOfFieldPlugin

Depth Of Field Plugin

Adds a depth of field effect with configurable focal point.

Hierarchy

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

Index

Constructors

Properties

_focalPointHit crossFadeTime dependencies enableEdit passId uiConfig OldPluginType PluginType

Accessors

Methods

_beforeRender _createPass _onObjectHit getFocalPoint onAdded onRemove setFocalPoint

Constructors

constructor

new DepthOfFieldPlugin(
enabled?: boolean,
enableEdit?: boolean,
): DepthOfFieldPlugin
Parameters
- enabled: boolean = true
- enableEdit: boolean = false
Returns DepthOfFieldPlugin
Overrides PipelinePassPlugin<DepthOfFieldPluginPass<DepthOfFieldPassId>, DepthOfFieldPassId, ''>.constructor

Properties

`Protected`_focalPointHit

_focalPointHit: Vector3 = ...

crossFadeTime

crossFadeTime: number = 200

dependencies

dependencies: typeof GBufferPlugin[] = ...

enableEdit

enableEdit: boolean = false

`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

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

`Protected`_createPass

_createPass(): DepthOfFieldPluginPass<"depthOfField">
Returns DepthOfFieldPluginPass<"depthOfField">
Overrides PipelinePassPlugin._createPass

`Protected`_onObjectHit

_onObjectHit(e: any): void
Parameters
- e: any
Returns void

getFocalPoint

getFocalPoint(): Vector3
Returns Vector3

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onAdded

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides PipelinePassPlugin.onRemove

setFocalPoint

setFocalPoint(p: Vector3, fade?: boolean, showGizmo?: boolean): void
Parameters
- p: Vector3
- fade: boolean = true
- showGizmo: boolean = false
Returns void