Class: ProgressivePlugin

Plugins.ProgressivePlugin

Hierarchy

• MultiFilterPlugin<"", [IFilter<AddBlendPass, "progressive">], ViewerApp>

  ↳ ProgressivePlugin

Implements

• IViewerPlugin

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

---

_dirty

• Protected _dirty: boolean = false

Inherited from

MultiFilterPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

MultiFilterPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

MultiFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

MultiFilterPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

---

viewer

• get viewer(): undefined | TViewer

Returns

undefined | TViewer

Inherited from

MultiFilterPlugin.viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

---

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

Name	Type
value	string[]

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

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

MultiFilterPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

exportState

▸ exportState(): any

Returns

any

Inherited from

MultiFilterPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:68

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

MultiFilterPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:71

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPlugin.storeState

Inherited from

MultiFilterPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:78

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

MultiFilterPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
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

Name	Type
data	any
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

Name	Type
viewer	ViewerApp

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

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

MultiFilterPlugin.onRemove

Defined in

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

---

getLastFrame

▸ getLastFrame(camera?): undefined | IRenderTarget

Parameters

Name	Type
camera?	ICamera<ICameraOptions, any, any>

Returns

undefined | IRenderTarget

Defined in

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

---

createPasses

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

Parameters

Name	Type
viewer	ViewerApp

Returns

[IFilter<AddBlendPass, "progressive">]

Overrides

MultiFilterPlugin.createPasses

Defined in

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

---

isConverged

▸ isConverged(postRender?): boolean

Parameters

Name	Type	Default value	Description
postRender	boolean	false	if called after rendering frame.

Returns

boolean

Defined in

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

---

updateShaderProperties

▸ updateShaderProperties(material): ProgressivePlugin

Parameters

Name	Type
material	Object
material.defines	Record<string, undefined | string | number>
material.uniforms	Object

Returns

ProgressivePlugin

Defined in

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

---

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

Name	Type	Default value
recorderPlugin	string	'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:202

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

MultiFilterPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:64

Constructors

constructor

• new ProgressivePlugin(maxFrameCount?)

Parameters

Name	Type
maxFrameCount	number

Overrides

MultiFilterPlugin.constructor

Defined in

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