Skip to main content

Class: VelocityBufferPlugin

Plugins.VelocityBufferPlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "VelocityBuffer"

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:16


passId

passId: "velocityBuffer"

Overrides

GenericFilterPlugin.passId

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:10


_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


_pass

Protected Optional _pass: IFilter<SSVelocityPass, "velocityBuffer">

Inherited from

GenericFilterPlugin._pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:8


_beforeFilters

Protected _beforeFilters: string[]

Overrides

GenericFilterPlugin._beforeFilters

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:12


_afterFilters

Protected _afterFilters: never[] = []

Overrides

GenericFilterPlugin._afterFilters

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:13


_requiredFilters

Protected _requiredFilters: string[]

Overrides

GenericFilterPlugin._requiredFilters

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:14

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

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

GenericFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


enabled

get enabled(): boolean

Returns

boolean

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:23

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

GenericFilterPlugin.enabled

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:27


pass

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

Returns

undefined | IFilter<T, TPassId>

Inherited from

GenericFilterPlugin.pass

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:68


uiConfig

get uiConfig(): undefined | UiObjectConfig<any, string>

Returns

undefined | UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:115

Methods

exportState

exportState(): any

Returns

any

Inherited from

GenericFilterPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

GenericFilterPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

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

Parameters

NameType
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

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

GenericFilterPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Inherited from

GenericFilterPlugin.onAdded

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:35


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:72


fromJSON

fromJSON(data, meta?): null | VelocityBufferPlugin

Parameters

NameType
dataany
meta?any

Returns

null | VelocityBufferPlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

GenericFilterPlugin.fromJSON

Defined in

webgi/src/plugins/GenericFilterPlugin.ts:81


passCtor

passCtor(v): SSVelocityPass

Parameters

NameType
vViewerApp

Returns

SSVelocityPass

Overrides

GenericFilterPlugin.passCtor

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:20


getVelocityBuffer

getVelocityBuffer(): undefined | IRenderTarget

Returns

undefined | IRenderTarget

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:97


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Overrides

GenericFilterPlugin.onDispose

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:101


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

GenericFilterPlugin.onRemove

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:105


updateShaderProperties

updateShaderProperties(material): VelocityBufferPlugin

Parameters

NameType
materialObject
material.definesRecord<string, undefined | string | number>
material.uniformsObject

Returns

VelocityBufferPlugin

Implementation of

IShaderPropertiesUpdater.updateShaderProperties

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:110


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

GenericFilterPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60


_update

Protected _update(v): boolean

This function is called every frame before composer render, if this pass is being used in the pipeline

Parameters

NameType
vViewerApp

Returns

boolean

Overrides

GenericFilterPlugin._update

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:81

Constructors

constructor

new VelocityBufferPlugin(enabled?)

Parameters

NameTypeDefault value
enabledbooleantrue

Overrides

GenericFilterPlugin.constructor

Defined in

webgi/src/plugins/VelocityBufferPlugin.ts:92