Class: VideoGenericViewport

Generic GenericViewport controller.

The base class owns only shared viewport state and binding orchestration: loaded logical data, mounted renderings, view state, and per-dataset render-state forwarding. It does not know how CPU, VTK, DOM, image, volume, or media runtimes work internally.

Concrete viewport families are expected to stay thin and provide:

• a render context for their render paths
• a data provider
• a render path resolver when the default is not enough
• viewport-family-specific public APIs

Concrete render paths are expected to own:

• runtime add/remove lifecycle
• view-state interpretation for that render path
• per-dataset render-state application
• render-path-specific coordinate transforms

This split keeps migration from legacy viewports incremental without centralizing render-mode-specific behavior in the controller.

Extends

• GenericViewport<VideoViewState, VideoDataPresentation, VideoElementRenderContext>

Constructors

new VideoGenericViewport()

new VideoGenericViewport(args): VideoGenericViewport

Parameters

• args: VideoViewportInput

Returns

VideoGenericViewport

Overrides

GenericViewport.constructor

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:57

Properties

_debug

readonly _debug: object

renderModes

renderModes: Record<string, string>

Inherited from

GenericViewport._debug

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:87

---

bindings

protected bindings: Map<string, ViewportDataBinding<VideoDataPresentation>>

Inherited from

GenericViewport.bindings

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:77

---

dataPresentation

protected dataPresentation: Map<string, VideoDataPresentation>

Inherited from

GenericViewport.dataPresentation

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:81

---

dataProvider

protected dataProvider: DataProvider<object, unknown>

Inherited from

GenericViewport.dataProvider

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:73

---

element

readonly element: HTMLDivElement

Inherited from

GenericViewport.element

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:66

---

id

readonly id: string

Inherited from

GenericViewport.id

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:65

---

isDestroyed

protected isDestroyed: boolean = false

Inherited from

GenericViewport.isDestroyed

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:83

---

renderContext

protected renderContext: VideoElementRenderContext

Overrides

GenericViewport.renderContext

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:45

---

renderingEngineId

readonly renderingEngineId: string

Overrides

GenericViewport.renderingEngineId

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:43

---

renderPathResolver

protected renderPathResolver: RenderPathResolver

Inherited from

GenericViewport.renderPathResolver

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:74

---

type

readonly type: VIDEO_NEXT = ViewportType.VIDEO_NEXT

Overrides

GenericViewport.type

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:42

---

viewportStatus

viewportStatus: ViewportStatus = ViewportStatus.NO_DATA

Inherited from

GenericViewport.viewportStatus

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:69

---

viewState

protected viewState: VideoViewState

Inherited from

GenericViewport.viewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:82

Accessors

useCustomRenderingPipeline

get static useCustomRenderingPipeline(): boolean

Returns

boolean

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:51

Methods

addDisplaySet()

addDisplaySet(displaySetId, options): Promise<void>

Loads a logical display set through the viewport data provider and adds it through the render-path resolver.

Parameters

• displaySetId: string

• options: DataAddOptions

Returns

Promise<void>

Inherited from

GenericViewport.addDisplaySet

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:130

---

addLoadedData()

protected addLoadedData(displaySetId, data, options, shouldIgnore?): Promise<boolean>

Converts loaded logical data into a mounted rendering binding.

The binding stores render-path callbacks so future per-dataset render state, camera, transform, resize, and render requests can be routed back to the correct render-path runtime.

Parameters

• displaySetId: string

• data: LoadedData

• options: DataAddOptions

• shouldIgnore?

Returns

Promise<boolean>

Inherited from

GenericViewport.addLoadedData

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:531

---

canvasToWorld()

canvasToWorld(canvasPos): Point3

Converts a canvas-space point to world-space coordinates using the computed camera.

Parameters

• canvasPos: Point2

Returns

Point3

Inherited from

GenericViewport.canvasToWorld

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:308

---

customRenderViewportToCanvas()

customRenderViewportToCanvas(): void

Called by the rendering engine render loop for custom-pipeline viewports (getUseCustomRenderingPipeline returns true). DOM updates happen eagerly in the render path, so this defers to render(); without it the engine threw customRenderViewportToCanvas is not a function for the next video viewport. Mirrors the ECG and WSI native viewports.

Returns

void

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:566

---

destroy()

destroy(): void

Releases mounted bindings and viewport-local resources.

Returns

void

Inherited from

GenericViewport.destroy

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:410

---

destroyBindings()

protected destroyBindings(): void

Tears down all mounted dataset bindings by removing each one individually.

Returns

void

Inherited from

GenericViewport.destroyBindings

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:944

---

dispose()

dispose(): void

Alias for destroy. Provided for compatibility with disposable resource conventions.

Returns

void

Overrides

GenericViewport.dispose

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:595

---

forEachBinding()

protected forEachBinding(visitor): void

Iterates mounted bindings without exposing the underlying map to subclasses.

Parameters

• visitor

Returns

void

Inherited from

GenericViewport.forEachBinding

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:862

---

getAspectRatio()

getAspectRatio(): Point2

Returns the current axis-based stretch as [scaleX, scaleY]. The new generic viewport pipeline does not apply axis-based stretching for now, so this defaults to [1, 1]. Subclasses that support aspect-ratio stretching should override.

Returns

Point2

Inherited from

GenericViewport.getAspectRatio

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:342

---

getBinding()

protected getBinding(displaySetId): ViewportDataBinding<VideoDataPresentation>

Looks up a binding by dataset identifier.

Parameters

• displaySetId: string

Returns

ViewportDataBinding<VideoDataPresentation>

Inherited from

GenericViewport.getBinding

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:796

---

getCameraForEvent()

protected getCameraForEvent(): ICamera<number>

Returns the camera representation used for event payloads. Delegates to the computed camera's ICamera projection when available, falling back to the raw view state.

Returns

ICamera<number>

Inherited from

GenericViewport.getCameraForEvent

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:755

---

getCurrentBinding()

protected getCurrentBinding(): ViewportDataBinding<VideoDataPresentation>

Returns the binding used for generic transform and frame-of-reference queries when a viewport family does not override the selection logic.

Returns

ViewportDataBinding<VideoDataPresentation>

Inherited from

GenericViewport.getCurrentBinding

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:852

---

getCurrentImageId()

getCurrentImageId(index): string

Parameters

• index: number = ...

Returns

string

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:182

---

getCurrentImageIdIndex()

getCurrentImageIdIndex(): number

Returns the current frame index in zero-based stack form.

Returns

number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:508

---

getCurrentMode()

getCurrentMode(): ViewportContentMode

Content-true classification of the currently bound source data.

The duck-typing capability guards (viewportSupportsImageSlices, viewportSupportsVolumeId, ...) report which methods a viewport exposes, not what it is showing, so a single generic viewport reports support for both stack and volume operations regardless of its bound content. This method answers the content question instead, derived from the mounted source binding. The base implementation only distinguishes "has bound data" from "empty"; concrete viewport families override it to report stack, volume, volume3d, etc. See ViewportContentMode.

Returns

ViewportContentMode

Inherited from

GenericViewport.getCurrentMode

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:227

---

getCurrentTime()

getCurrentTime(): number

Returns the current playback time in seconds.

Returns

number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:479

---

getDataPresentationState()

protected getDataPresentationState(displaySetId): VideoDataPresentation

Returns the last render state stored for a display set, even if that display set is not currently mounted.

Parameters

• displaySetId: string

Returns

VideoDataPresentation

Inherited from

GenericViewport.getDataPresentationState

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:648

---

getDisplaySetPresentation()

getDisplaySetPresentation(displaySetId): VideoDataPresentation

Returns the stored presentation state for a specific dataset.

Parameters

• displaySetId: string

Returns

VideoDataPresentation

Inherited from

GenericViewport.getDisplaySetPresentation

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:209

---

getDisplaySetRenderMode()

protected getDisplaySetRenderMode(displaySetId): string

Internal helper: returns the mounted render mode for a specific dataset when present.

Parameters

• displaySetId: string

Returns

string

Inherited from

GenericViewport.getDisplaySetRenderMode

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:806

---

getDisplaySetRole()

protected getDisplaySetRole(displaySetId): BindingRole

Internal helper: returns the binding role for a mounted dataset when present.

Parameters

• displaySetId: string

Returns

BindingRole

Inherited from

GenericViewport.getDisplaySetRole

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:816

---

getDisplaySets()

getDisplaySets(): object[]

Returns the display sets currently mounted on the viewport, in mount order (source binding first, then overlays). Derived from the live bindings, so it always reflects what is actually rendered - including overlays and any removeData calls. The per-entry options carry the binding role.

Returns

object[]

Inherited from

GenericViewport.getDisplaySets

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:148

---

getFirstBinding()

protected getFirstBinding(): ViewportDataBinding<VideoDataPresentation>

Returns the first mounted binding when a viewport family does not have a stronger notion of "current" selection.

Returns

ViewportDataBinding<VideoDataPresentation>

Inherited from

GenericViewport.getFirstBinding

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:826

---

getFrameNumber()

getFrameNumber(): number

Returns the current frame number derived from playback time.

Returns

number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:487

---

getFrameOfReferenceUID()

getFrameOfReferenceUID(): string

Returns the frame of reference UID from the computed camera when available, falling back to the current binding or a viewport-local identifier.

Returns

string

Inherited from

GenericViewport.getFrameOfReferenceUID

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:274

---

getFrameRate()

getFrameRate(): number

Returns the active dataset frame rate.

Returns

number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:458

---

getImageIds()

getImageIds(): string[]

Returns generated frame image ids for the active video dataset.

Returns

string[]

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:515

---

getNumberOfFrames()

getNumberOfFrames(): number

Returns the total number of frames in the active dataset.

Returns

number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:465

---

getNumberOfSlices()

getNumberOfSlices(): number

Returns the stack-like slice count used by tool compatibility layers.

Returns

number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:472

---

getPan()

getPan(): Point2

Returns the current pan offset in canvas coordinates.

Returns

Point2

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:254

---

getReferenceViewContexts()

protected getReferenceViewContexts(): GenericViewportReferenceContext[]

Returns generic reference-compatibility contexts for mounted datasets. Subclasses can add image, volume, slice, plane, and dimension facts.

Returns

GenericViewportReferenceContext[]

Overrides

GenericViewport.getReferenceViewContexts

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:300

---

getRenderingEngine()

getRenderingEngine(): RenderingEngine

Returns the rendering engine that owns this viewport. Tools and utilities rely on this method existing on every viewport (legacy Viewport provides it); without it, calls like viewport.getRenderingEngine() threw on native generic viewports.

Returns

RenderingEngine

Inherited from

GenericViewport.getRenderingEngine

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:287

---

getResolvedView()

getResolvedView(): VideoResolvedView

Returns the computed camera that resolves layout, zoom, and pan from the raw camera state and the current video element dimensions.

Returns

VideoResolvedView

Overrides

GenericViewport.getResolvedView

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:275

---

getSliceIndex()

getSliceIndex(): number

Returns

number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:215

---

getSourceBinding()

protected getSourceBinding(): ViewportDataBinding<VideoDataPresentation>

Returns the active source binding (the dataset that defines the view), falling back to the first mounted binding when no explicit source role is present. Used for content-mode classification and source-scoped queries.

Returns

ViewportDataBinding<VideoDataPresentation>

Inherited from

GenericViewport.getSourceBinding

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:837

---

getUseCustomRenderingPipeline()

getUseCustomRenderingPipeline(): boolean

Returns whether this viewport bypasses the shared rendering pipeline.

Returns

boolean

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:602

---

getViewReference()

getViewReference(viewRefSpecifier): ViewReference

Returns a spatial reference for the current viewport state.

Parameters

• viewRefSpecifier: ViewReferenceSpecifier = {}

Returns

ViewReference

Overrides

GenericViewport.getViewReference

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:155

---

getViewReferenceId()

getViewReferenceId(specifier): string

Returns a stable string identifier for the current view reference.

Parameters

• specifier: ViewReferenceSpecifier = {}

Returns

string

Overrides

GenericViewport.getViewReferenceId

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:194

---

getViewState()

getViewState(): VideoViewState

Returns the controller's current shared view state.

Returns

VideoViewState

Inherited from

GenericViewport.getViewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:372

---

getZoom()

getZoom(): number

Returns the current zoom level derived from camera scale.

Returns

number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:226

---

isReferenceViewable()

isReferenceViewable(viewReference, options): boolean

Returns whether a spatial reference is compatible with this viewport.

Parameters

• viewReference: ViewReference

• options: ReferenceCompatibleOptions = {}

Returns

boolean

Inherited from

GenericViewport.isReferenceViewable

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:258

---

mergeDataPresentation()

protected mergeDataPresentation(displaySetId, props): VideoDataPresentation

Merges object-like updates into the stored per-display-set render state and forwards the result immediately when mounted.

Parameters

• displaySetId: string

• props: Partial<VideoDataPresentation>

Returns

VideoDataPresentation

Inherited from

GenericViewport.mergeDataPresentation

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:679

---

modified()

protected modified(previousCamera?): void

Pushes the current shared view state to every binding and schedules a render. Optionally fires a camera-modified event when a previous camera snapshot is provided.

Parameters

• previousCamera?: ICamera<number>

Returns

void

Inherited from

GenericViewport.modified

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:734

---

normalizeViewState()

protected normalizeViewState(viewState): VideoViewState

Clamps and normalizes video camera values before storage.

Parameters

• viewState: VideoViewState

Returns

VideoViewState

Overrides

GenericViewport.normalizeViewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:613

---

notifyDataPresentationModified()

protected notifyDataPresentationModified(_displaySetId, _props): void

Hook invoked after a per-display-set presentation update is applied through the public setDisplaySetPresentation path and the target display set is mounted. Concrete viewport families override this to emit their presentation-modified events (e.g. VOI_MODIFIED, COLORMAP_MODIFIED) so application UI and synchronizers can react to programmatic and tool-driven presentation changes. The base implementation is intentionally a no-op.

Parameters

• _displaySetId: string

• _props: Partial<VideoDataPresentation>

Returns

void

Inherited from

GenericViewport.notifyDataPresentationModified

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:710

---

onDestroy()

protected onDestroy(): void

Releases the tracked video element listener during destroy.

Returns

void

Overrides

GenericViewport.onDestroy

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:622

---

pause()

pause(): void

Pauses playback and synchronizes the cached current time.

Returns

void

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:349

---

play()

play(): Promise<void>

Starts playback on the active video element.

Returns

Promise<void>

A promise that resolves after the play request settles.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:333

---

removeAllData()

protected removeAllData(): void

Returns

void

Inherited from

GenericViewport.removeAllData

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:615

---

removeData()

removeData(dataId): void

Removes a video dataset and rebinds tracking if the primary video changed.

Parameters

• dataId: string

Logical dataset id to remove.

Returns

void

Overrides

GenericViewport.removeData

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:144

---

removeWidgets()

removeWidgets(): void

Returns

void

Deprecated

Compatibility no-op retained during the V2 migration.

Inherited from

GenericViewport.removeWidgets

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:403

---

render()

render(): void

No-op render because DOM updates happen eagerly in the render path.

Returns

void

Overrides

GenericViewport.render

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:551

---

renderBindings()

protected renderBindings(): boolean

Invokes render on each binding and reports whether any binding handled the render request directly.

Returns

boolean

Inherited from

GenericViewport.renderBindings

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:913

---

resetViewState()

resetViewState(): boolean

Resets layout navigation while preserving the current video time.

Returns

boolean

Overrides

GenericViewport.resetViewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:573

---

resize()

resize(): void

Recomputes viewport-owned runtime sizing. Concrete viewport families may override this when they need to resize canvases or external runtimes.

Returns

void

Inherited from

GenericViewport.resize

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:482

---

resizeBindings()

protected resizeBindings(): void

Invokes resize on each mounted binding.

Returns

void

Inherited from

GenericViewport.resizeBindings

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:931

---

resizeForRenderingEngine()

resizeForRenderingEngine(__namedParameters): void

RenderingEngine-owned resize hook for custom-pipeline viewports.

Generic viewports own semantic view state, so the rendering engine delegates resize behavior here instead of preserving legacy getCamera/setCamera snapshots around a reset.

Parameters

• __namedParameters: RenderingEngineResizeOptions = {}

Returns

void

Inherited from

GenericViewport.resizeForRenderingEngine

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:506

---

scroll()

scroll(delta, _debounceLoading, loop): void

Scrolls through frames using a signed delta.

Parameters

• delta: number = 1

Signed number of frames to move by.

• _debounceLoading: boolean = true

Unused compatibility argument kept for stack-like callers.

• loop: boolean = false

Whether to wrap when scrolling past either end.

Returns

void

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:410

---

seek()

seek(timeSeconds): void

Seeks the active video to the requested time in seconds.

Parameters

• timeSeconds: number

Target playback time in seconds.

Returns

void

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:359

---

setDataPresentationState()

protected setDataPresentationState(displaySetId, props): void

Stores per-dataset render state and forwards it immediately when that dataset is already added.

Parameters

• displaySetId: string

• props: VideoDataPresentation

Returns

void

Inherited from

GenericViewport.setDataPresentationState

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:625

---

setDefaultDataPresentation()

protected setDefaultDataPresentation(displaySetId, defaults): VideoDataPresentation

Stores object-like defaults for a display set without clobbering any values already tracked for that display set.

Parameters

• displaySetId: string

• defaults: VideoDataPresentation

Returns

VideoDataPresentation

Inherited from

GenericViewport.setDefaultDataPresentation

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:658

---

setDisplaySetPresentation()

setDisplaySetPresentation(props)

setDisplaySetPresentation(props): void

Updates the stored per-display-set presentation state. When called with just props, the update is applied to the current (source) binding. When called with an explicit displaySetId, the update targets that binding.

Parameters

• props: Partial<VideoDataPresentation>

Returns

void

Inherited from

GenericViewport.setDisplaySetPresentation

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:183

setDisplaySetPresentation(displaySetId, props)

setDisplaySetPresentation(displaySetId, props): void

Parameters

• displaySetId: string

• props: Partial<VideoDataPresentation>

Returns

void

Inherited from

GenericViewport.setDisplaySetPresentation

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:184

---

setDisplaySets()

setDisplaySets(...entries): Promise<void>

Replaces all mounted video display sets with the provided ones using the HTML video render path. The first entry is mounted as the source binding.

Parameters

• ...entries: object[]

Video display sets to mount.

Returns

Promise<void>

Overrides

GenericViewport.setDisplaySets

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:91

---

setFrameNumber()

setFrameNumber(frameNumber): void

Seeks to the requested frame number using the dataset frame rate.

Parameters

• frameNumber: number

Target frame number in dataset coordinates.

Returns

void

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:375

---

setNeedsRender()

setNeedsRender(): void

Marks the viewport as waiting for a render pass without scheduling one.

Returns

void

Inherited from

GenericViewport.setNeedsRender

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:457

---

setPan()

setPan(pan): void

Sets the pan offset in canvas coordinates.

Parameters

• pan: Point2

Returns

void

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:261

---

setPlaybackRate()

setPlaybackRate(playbackRate): void

Updates playback rate through per-data presentation state.

Parameters

• playbackRate: number

Playback rate to apply to the active dataset.

Returns

void

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:390

---

setRendered()

setRendered(): void

Called by rendering engines after a frame is rendered.

Most GenericViewport families do not need to track this separately because their render paths own concrete runtime state.

Returns

void

Inherited from

GenericViewport.setRendered

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:443

---

setViewReference()

setViewReference(viewRef): void

Applies a spatial reference to the current viewport state.

Parameters

• viewRef: ViewReference

Returns

void

Overrides

GenericViewport.setViewReference

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:204

---

setViewState()

setViewState(viewStatePatch): void

Merges partial view-state updates into the viewport source of truth and propagates the result to every active binding.

Parameters

• viewStatePatch: Partial<VideoViewState>

Returns

void

Inherited from

GenericViewport.setViewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:354

---

setZoom()

setZoom(zoom, canvasPoint?): void

Sets the zoom level, optionally anchored to a canvas point.

Parameters

• zoom: number

• canvasPoint?: Point2

Returns

void

Defined in

packages/core/src/RenderingEngine/GenericViewport/Video/VideoViewport.ts:235

---

triggerCameraModifiedEvent()

protected triggerCameraModifiedEvent(previousCamera): void

Fires a Events.CAMERA_MODIFIED event on the viewport element.

Parameters

• previousCamera: ICamera<number>

Returns

void

Inherited from

GenericViewport.triggerCameraModifiedEvent

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:763

---

triggerCameraResetEvent()

protected triggerCameraResetEvent(): void

Fires a Events.CAMERA_RESET event on the viewport element.

Returns

void

Inherited from

GenericViewport.triggerCameraResetEvent

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:778

---

updateRenderingPipeline()

updateRenderingPipeline(): void

Re-evaluates render paths after a global rendering-configuration change (setRenderBackend, or a deprecated CPU-rendering toggle). The default is a no-op; viewport families that support a live render-path swap override it. Present on every viewport so the global fan-out in init() can call it unconditionally.

Returns

void

Inherited from

GenericViewport.updateRenderingPipeline

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:474

---

updateViewState()

updateViewState(updater): void

Computes a view-state patch from the current state, then applies it through setViewState so normalization, events, and render invalidation stay in the canonical mutation path.

Parameters

• updater: Partial<VideoViewState> | (viewState) => void | Partial<VideoViewState>

Returns

void

Inherited from

GenericViewport.updateViewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:381

---

worldToCanvas()

worldToCanvas(worldPos): Point2

Converts a world-space point to canvas-space coordinates using the computed camera.

Parameters

• worldPos: Point3

Returns

Point2

Inherited from

GenericViewport.worldToCanvas

Defined in

packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:324