Class: GenericVolumeViewport3D

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<Volume3DCamera, Volume3DDataPresentation, Volume3DViewportRenderContext>

Constructors

new GenericVolumeViewport3D()

new GenericVolumeViewport3D(args): GenericVolumeViewport3D

Parameters

• args: VolumeViewport3DInput

Returns

GenericVolumeViewport3D

Overrides

GenericViewport.constructor

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:75

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<Volume3DDataPresentation>>

Inherited from

GenericViewport.bindings

Defined in

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

---

canvas

readonly canvas: HTMLCanvasElement

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:53

---

dataPresentation

protected dataPresentation: Map<string, Volume3DDataPresentation>

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

---

defaultOptions

defaultOptions: ViewportInputOptions

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:56

---

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

Overrides

GenericViewport.renderContext

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:59

---

renderingEngineId

readonly renderingEngineId: string

Overrides

GenericViewport.renderingEngineId

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:52

---

renderPathResolver

protected renderPathResolver: RenderPathResolver

Inherited from

GenericViewport.renderPathResolver

Defined in

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

---

sHeight

sHeight: number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:55

---

suppressEvents

suppressEvents: boolean = false

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:57

---

sWidth

sWidth: number

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:54

---

type

readonly type: VOLUME_3D_NEXT = ViewportType.VOLUME_3D_NEXT

Overrides

GenericViewport.type

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:51

---

viewportStatus

viewportStatus: ViewportStatus = ViewportStatus.NO_DATA

Inherited from

GenericViewport.viewportStatus

Defined in

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

---

viewState

protected viewState: Volume3DCamera

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/Volume3D/viewport3D.ts:63

Methods

addDisplaySet()

addDisplaySet(displaySetId, options): Promise<void>

Adds a single 3D display set and selects the effective 3D render mode.

Parameters

• displaySetId: string

Logical display set id to add.

• options: Volume3DSetDataOptions | DataAddOptions = {}

Requested 3D render-mode options.

Returns

Promise<void>

Overrides

GenericViewport.addDisplaySet

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:168

---

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

---

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

Inherited from

GenericViewport.dispose

Defined in

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

---

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

---

getActors()

getActors(): ActorEntry[]

Returns all actor entries contributed by the active 3D bindings.

Returns

ActorEntry[]

Actor entries for all active 3D bindings.

Defined in

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

---

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<Volume3DDataPresentation>

Looks up a binding by dataset identifier.

Parameters

• displaySetId: string

Returns

ViewportDataBinding<Volume3DDataPresentation>

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

---

getCanvas()

getCanvas(): HTMLCanvasElement

Returns the viewport canvas element.

Returns

HTMLCanvasElement

The canvas owned by this viewport.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:242

---

getCurrentBinding()

protected getCurrentBinding(): ViewportDataBinding<Volume3DDataPresentation>

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

Returns

ViewportDataBinding<Volume3DDataPresentation>

Overrides

GenericViewport.getCurrentBinding

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:583

---

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

---

getDataPresentationState()

protected getDataPresentationState(displaySetId): Volume3DDataPresentation

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

Parameters

• displaySetId: string

Returns

Volume3DDataPresentation

Inherited from

GenericViewport.getDataPresentationState

Defined in

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

---

getDefaultActor()

getDefaultActor(): ActorEntry

Returns the default actor for tool integration and legacy compatibility.

Returns

ActorEntry

The primary actor entry, if one is available.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:436

---

getDisplaySetPresentation()

getDisplaySetPresentation(displaySetId): Volume3DDataPresentation

Returns the stored presentation state for a specific dataset.

Parameters

• displaySetId: string

Returns

Volume3DDataPresentation

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<Volume3DDataPresentation>

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

Returns

ViewportDataBinding<Volume3DDataPresentation>

Inherited from

GenericViewport.getFirstBinding

Defined in

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

---

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

---

getImageData()

getImageData(): IImageData

Returns image data from the current binding when exposed by the render path.

Returns

IImageData

The current image-data object, if exposed by the render path.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:401

---

getImageIds()

getImageIds(): string[]

Returns image ids for the primary volume dataset when present.

Returns

string[]

The image ids for the primary volume dataset, if available.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:207

---

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/Volume3D/viewport3D.ts:591

---

getRenderer()

getRenderer(): vtkRenderer

Returns the underlying VTK renderer for direct integration points.

Returns

vtkRenderer

The VTK renderer used by this viewport.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:233

---

getRenderingEngine()

getRenderingEngine(): RenderingEngine

Returns the rendering engine that owns this viewport.

Returns

RenderingEngine

The parent rendering engine, if it is still registered.

Overrides

GenericViewport.getRenderingEngine

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:198

---

getResolvedView()

getResolvedView(): Volume3DResolvedView

Returns the viewport's computed camera snapshot for coordinate transforms and legacy ICamera interop. Subclasses must implement this to produce the viewport-family-specific computed camera.

Returns

Volume3DResolvedView

Overrides

GenericViewport.getResolvedView

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:294

---

getRuntimeCamera()

protected getRuntimeCamera(): Volume3DCamera & ICamera<number>

Returns

Volume3DCamera & ICamera<number>

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:278

---

getSourceBinding()

protected getSourceBinding(): ViewportDataBinding<Volume3DDataPresentation>

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<Volume3DDataPresentation>

Inherited from

GenericViewport.getSourceBinding

Defined in

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

---

getUseCustomRenderingPipeline()

getUseCustomRenderingPipeline(): boolean

Returns

boolean

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:67

---

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/Volume3D/viewport3D.ts:303

---

getViewReferenceId()

getViewReferenceId(_specifier): string

Returns a stable string identifier for the current view reference.

Parameters

• _specifier: ViewReferenceSpecifier = {}

Returns

string

Inherited from

GenericViewport.getViewReferenceId

Defined in

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

---

getViewState()

getViewState(): Volume3DCamera & ICamera<number>

Returns the current 3D camera state in the compatibility camera shape.

Returns

Volume3DCamera & ICamera<number>

The current 3D camera state.

Overrides

GenericViewport.getViewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:260

---

getVolumeId()

getVolumeId(): string

Returns the primary volume id when the active rendering is volume-backed.

Returns

string

The primary volume id, if one is active.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:350

---

getVtkActiveCamera()

getVtkActiveCamera(): vtkCamera

Returns the active VTK camera instance.

Returns

vtkCamera

The active VTK camera object.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:251

---

hasVolumeId()

hasVolumeId(volumeId): boolean

Returns whether the viewport currently contains the given volume id.

Parameters

• volumeId: string

Volume id to look up in the current actors.

Returns

boolean

true when a matching volume actor is present.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:377

---

hasVolumeURI()

hasVolumeURI(volumeURI): boolean

Returns whether any actor reference id contains the given volume URI.

Parameters

• volumeURI: string

Volume URI substring to test against actor references.

Returns

boolean

true when a matching actor reference is present.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:389

---

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): Volume3DDataPresentation

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

Parameters

• displaySetId: string

• props: Partial<Volume3DDataPresentation>

Returns

Volume3DDataPresentation

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): Volume3DCamera

Hook for subclasses to clamp or adjust view-state values before they are stored. The default implementation returns the view state unchanged.

Parameters

• viewState: Volume3DCamera

Returns

Volume3DCamera

Inherited from

GenericViewport.normalizeViewState

Defined in

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

---

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<Volume3DDataPresentation>

Returns

void

Inherited from

GenericViewport.notifyDataPresentationModified

Defined in

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

---

onDestroy()

protected onDestroy(): void

Hook for subclasses to release viewport-local resources during destroy. Called after bindings have been torn down but before the maps are cleared.

Returns

void

Overrides

GenericViewport.onDestroy

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:556

---

removeAllData()

protected removeAllData(): void

Returns

void

Inherited from

GenericViewport.removeAllData

Defined in

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

---

removeData()

removeData(displaySetId): void

Removes a dataset binding and its stored presentation state, then triggers a re-render so the viewport reflects the removal.

Parameters

• displaySetId: string

Returns

void

Inherited from

GenericViewport.removeData

Defined in

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

---

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

Renders active 3D bindings or queues an engine-driven render.

Returns

void

Overrides

GenericViewport.render

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:546

---

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(options?): boolean

Resets the VTK-backed view state and clipping range.

Mirrors the legacy VolumeViewport3D.resetCamera semantics for the options that 3D-camera tooling relies on:

• resetZoom: false keeps the current parallel scale (zoom) instead of refitting to bounds. (OrientationControllerTool animates orientation with resetZoom: false; VolumeCroppingControlTool also forwards options.)
• resetPan: false / resetToCenter: false keep the current focal point and position rather than recentering on the bounds.

vtkRenderer.resetCamera() preserves the current view direction (viewPlaneNormal) and viewUp - it only repositions the camera along the existing direction of projection and recomputes the parallel scale - so an orientation applied via setViewState immediately before this call is not clobbered.

Parameters

• options?

Reset options matching the legacy resetCamera contract.

• options.resetPan?: boolean

• options.resetToCenter?: boolean

• options.resetZoom?: boolean

Returns

boolean

Always true for compatibility with legacy viewport contracts.

Overrides

GenericViewport.resetViewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:475

---

resetViewStateForResize()

resetViewStateForResize(): boolean

Resets the 3D view state after resize using the same behavior as resetViewState.

Returns

boolean

Always true for compatibility with legacy viewport contracts.

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:525

---

resize()

resize(): void

Updates cached size state and notifies active render bindings.

Returns

void

Overrides

GenericViewport.resize

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:532

---

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

---

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

Returns

void

Inherited from

GenericViewport.setDataPresentationState

Defined in

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

---

setDefaultDataPresentation()

protected setDefaultDataPresentation(displaySetId, defaults): Volume3DDataPresentation

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

Parameters

• displaySetId: string

• defaults: Volume3DDataPresentation

Returns

Volume3DDataPresentation

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<Volume3DDataPresentation>

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<Volume3DDataPresentation>

Returns

void

Inherited from

GenericViewport.setDisplaySetPresentation

Defined in

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

---

setDisplaySets()

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

Replaces all mounted 3D display sets with the provided ones. The first entry is mounted as the source binding; subsequent entries default to the overlay role unless they specify one explicitly.

Parameters

• ...entries: object[]

Display sets to mount, each with its own render-mode options.

Returns

Promise<void>

Overrides

GenericViewport.setDisplaySets

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:146

---

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

---

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

Overrides

GenericViewport.setRendered

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:71

---

setViewReference()

setViewReference(_viewReference): void

Applies a spatial reference to the current viewport state.

Parameters

• _viewReference: ViewReference

Returns

void

Inherited from

GenericViewport.setViewReference

Defined in

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

---

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<Volume3DCamera>

Returns

void

Overrides

GenericViewport.setViewState

Defined in

packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:264

---

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<Volume3DCamera> | (viewState) => void | Partial<Volume3DCamera>

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