Skip to main content

Class: ProgressivePlugin

Plugins.ProgressivePlugin

Hierarchy

Implements

Properties

PluginType

Static Readonly PluginType: "Progressive"

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:32


enabled

enabled: boolean = true

Overrides

MultiFilterPlugin.enabled

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:35


maxFrameCount

maxFrameCount: number

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:36


jitter

jitter: boolean = true

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:37


trackedJitterCameras

trackedJitterCameras: Set<[OrthographicCamera | PerspectiveCamera, { width: number ; height: number }]>

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:41


uiConfig

uiConfig: UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:182


_dirty

Protected _dirty: boolean = false

Inherited from

MultiFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

MultiFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

MultiFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

MultiFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22


passes

get passes(): TTupleRecord<TPasses, "passId">

Returns

TTupleRecord<TPasses, "passId">

Inherited from

MultiFilterPlugin.passes

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:17


pipeline

get pipeline(): string[]

Returns

string[]

Inherited from

MultiFilterPlugin.pipeline

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:22

set pipeline(value): void

Parameters

NameType
valuestring[]

Returns

void

Inherited from

MultiFilterPlugin.pipeline

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:26


lastFrame

get lastFrame(): undefined | IRenderTarget

Returns

undefined | IRenderTarget

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:66

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

MultiFilterPlugin.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

MultiFilterPlugin.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

MultiFilterPlugin.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

MultiFilterPlugin.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

MultiFilterPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

MultiFilterPlugin.toJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:65


fromJSON

fromJSON(data, meta?): null | ProgressivePlugin

Parameters

NameType
dataany
meta?any

Returns

null | ProgressivePlugin

Implementation of

IViewerPlugin.fromJSON

Inherited from

MultiFilterPlugin.fromJSON

Defined in

webgi/src/plugins/MultiFilterPlugin.ts:77


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

MultiFilterPlugin.onAdded

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:48


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

MultiFilterPlugin.onRemove

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:53


createPasses

createPasses(viewer): [IFilter<AddBlendPass, "progressive">]

Parameters

NameType
viewerViewerApp

Returns

[IFilter<AddBlendPass, "progressive">]

Overrides

MultiFilterPlugin.createPasses

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:70


isConverged

isConverged(postRender?): boolean

Parameters

NameTypeDefault valueDescription
postRenderbooleanfalseif called after rendering frame.

Returns

boolean

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:173


updateShaderProperties

updateShaderProperties(material): ProgressivePlugin

Parameters

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

Returns

ProgressivePlugin

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:177


postFrameConvergedRecordingDelta

postFrameConvergedRecordingDelta(recorderPlugin?): number

Get recording delta post render, For use with animations to sync with converge mode in canvas recorder. See PopmotionPlugin for usage.

Parameters

NameTypeDefault value
recorderPluginstring'CanvasRecorder'

Returns

number

  • delta time in milliseconds, or 0 when converging, or -1 in case of not recording in converge mode

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:189

Constructors

constructor

new ProgressivePlugin(maxFrameCount?)

Parameters

NameType
maxFrameCountnumber

Overrides

MultiFilterPlugin.constructor

Defined in

webgi/src/plugins/threejs/ProgressivePlugin.ts:43