Class: ProgressivePlugin

Plugins.ProgressivePlugin

Hierarchy

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

  ↳ ProgressivePlugin

Implements

• IViewerPluginAsync

Properties

PluginType

▪ Static Readonly PluginType: "Progressive"

---

enabled

• enabled: boolean = true

Overrides

MultiFilterPlugin.enabled

---

maxFrameCount

• maxFrameCount: number

---

jitter

• jitter: boolean = true

---

trackedJitterCameras

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

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Implementation of

IViewerPluginAsync.uiConfig

---

_dirty

• Protected _dirty: boolean = false

Inherited from

MultiFilterPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

MultiFilterPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

MultiFilterPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

MultiFilterPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

MultiFilterPlugin.viewer

---

passes

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

Returns

TTupleRecord<TPasses, "passId">

Inherited from

MultiFilterPlugin.passes

---

pipeline

• get pipeline(): string[]

Returns

string[]

Inherited from

MultiFilterPlugin.pipeline

• set pipeline(value): void

Parameters

Name	Type
value	string[]

Returns

void

Inherited from

MultiFilterPlugin.pipeline

---

lastFrame

• get lastFrame(): undefined | IRenderTarget

Returns

undefined | IRenderTarget

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Inherited from

MultiFilterPlugin.onDispose

---

exportState

▸ exportState(): any

Returns

any

Inherited from

MultiFilterPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

MultiFilterPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

MultiFilterPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

MultiFilterPlugin.loadState

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Inherited from

MultiFilterPlugin.toJSON

---

fromJSON

▸ fromJSON(data, meta?): null | ProgressivePlugin

Parameters

Name	Type
data	any
meta?	any

Returns

null | ProgressivePlugin

Implementation of

IViewerPluginAsync.fromJSON

Inherited from

MultiFilterPlugin.fromJSON

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

MultiFilterPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Overrides

MultiFilterPlugin.onRemove

---

getLastFrame

▸ getLastFrame(camera?): undefined | IRenderTarget

Parameters

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

Returns

undefined | IRenderTarget

---

createPasses

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

Parameters

Name	Type
viewer	ViewerApp

Returns

[IFilter<AddBlendPass, "progressive">]

Overrides

MultiFilterPlugin.createPasses

---

isConverged

▸ isConverged(postRender?): boolean

Parameters

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

Returns

boolean

---

updateShaderProperties

▸ updateShaderProperties(material): ProgressivePlugin

Parameters

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

Returns

ProgressivePlugin

---

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

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

MultiFilterPlugin._storeKey

Constructors

constructor

• new ProgressivePlugin(maxFrameCount?)

Parameters

Name	Type
maxFrameCount	number

Overrides

MultiFilterPlugin.constructor