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
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:76
Properties
_debug
readonly_debug:object
renderModes
renderModes:
Record<string,string>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:108
bindings
protectedbindings:Map<string,ViewportDataBinding<Volume3DDataPresentation>>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:98
canvas
readonlycanvas:HTMLCanvasElement
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:54
dataPresentation
protecteddataPresentation:Map<string,Volume3DDataPresentation>
Inherited from
GenericViewport.dataPresentation
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:102
dataProvider
protecteddataProvider:DataProvider<object,unknown>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:94
defaultOptions
defaultOptions:
ViewportInputOptions
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:57
element
readonlyelement:HTMLDivElement
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:87
id
readonlyid:string
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:86
isDestroyed
protectedisDestroyed:boolean=false
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:104
renderContext
protectedrenderContext:Volume3DViewportRenderContext
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:60
renderingEngineId
readonlyrenderingEngineId:string
Overrides
GenericViewport.renderingEngineId
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:53
renderPathResolver
protectedrenderPathResolver:RenderPathResolver
Inherited from
GenericViewport.renderPathResolver
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:95
sHeight
sHeight:
number
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:56
suppressEvents
suppressEvents:
boolean=false
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:58
sWidth
sWidth:
number
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:55
type
readonlytype:VOLUME_3D_NEXT=ViewportType.VOLUME_3D_NEXT
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:52
viewportStatus
viewportStatus:
ViewportStatus=ViewportStatus.NO_DATA
Inherited from
GenericViewport.viewportStatus
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:90
viewState
protectedviewState:Volume3DCamera
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:103
Accessors
useCustomRenderingPipeline
getstaticuseCustomRenderingPipeline():boolean
Returns
boolean
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:64
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
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:195
addLoadedData()
protectedaddLoadedData(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
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:677
canReportFidelity()
canReportFidelity():
boolean
The 3D family can show reduced volume data (GENVIEW-FIDELITY-8).
Returns
boolean
Overrides
GenericViewport.canReportFidelity
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:141
canvasToWorld()
canvasToWorld(
canvasPos):Point3
Converts a canvas-space point to world-space coordinates using the computed camera.
Parameters
• canvasPos: Point2
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:454
collectFidelityLines()
protectedcollectFidelityLines(display?):FidelityLine[]
Builds fidelity lines from the typed fidelity fields that each render
path sets on its rendering (GENVIEW-FIDELITY-2): a record for volume
data, an image quality for a stack image (FIDELITY-STATE-8). It reads
every rendering of a binding (getRenderings); a hidden rendering sets
excludeFromFidelity.
Parameters
• display?: FidelityDisplay
Returns
FidelityLine[]
Inherited from
GenericViewport.collectFidelityLines
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:352
destroy()
destroy():
void
Releases mounted bindings and viewport-local resources.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:556
destroyBindings()
protecteddestroyBindings():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:1090
dispose()
dispose():
void
Alias for destroy. Provided for compatibility with disposable resource conventions.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:579
forEachBinding()
protectedforEachBinding(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:1008
getActors()
getActors():
ActorEntry[]
Returns all actor entries contributed by the active 3D bindings.
Returns
Actor entries for all active 3D bindings.
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:437
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
Inherited from
GenericViewport.getAspectRatio
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:488
getBinding()
protectedgetBinding(displaySetId):ViewportDataBinding<Volume3DDataPresentation>
Looks up a binding by dataset identifier.
Parameters
• displaySetId: string
Returns
ViewportDataBinding<Volume3DDataPresentation>
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:942
getCameraForEvent()
protectedgetCameraForEvent():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:901
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:269
getCurrentBinding()
protectedgetCurrentBinding():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:610
getCurrentMode()
getCurrentMode():
ViewportContentMode
Content mode of the 3D family (GENVIEW-FAMILY-5): volume3d for a mounted
volume, unknown for a geometry-only source, empty with no source.
Returns
Overrides
GenericViewport.getCurrentMode
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:154
getDataPresentationState()
protectedgetDataPresentationState(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:794
getDefaultActor()
getDefaultActor():
ActorEntry
Returns the default actor for tool integration and legacy compatibility.
Returns
The primary actor entry, if one is available.
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:463
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:234
getDisplaySetRenderMode()
protectedgetDisplaySetRenderMode(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:952
getDisplaySetRole()
protectedgetDisplaySetRole(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:962
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:173
getFidelityLines()
getFidelityLines():
FidelityLine[]
Fidelity lines for the built-in indicator UI.
Returns
FidelityLine[]
Inherited from
GenericViewport.getFidelityLines
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:281
getFidelityState()
getFidelityState():
ViewportFidelityState
Absolute per-viewport fidelity record (FIDELITY-EVENT-5).
Returns
Inherited from
GenericViewport.getFidelityState
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:269
getFirstBinding()
protectedgetFirstBinding():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:972
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:420
getImageData()
getImageData():
IImageData
Returns image data from the current binding when exposed by the render path.
Returns
The current image-data object, if exposed by the render path.
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:428
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:234
getReferenceViewContexts()
protectedgetReferenceViewContexts():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:618
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:260
getRenderingEngine()
getRenderingEngine():
RenderingEngine
Returns the rendering engine that owns this viewport.
Returns
The parent rendering engine, if it is still registered.
Overrides
GenericViewport.getRenderingEngine
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:225
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:321
getRuntimeCamera()
protectedgetRuntimeCamera():Volume3DCamera&ICamera<number>
Returns
Volume3DCamera & ICamera<number>
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:305
getSourceBinding()
protectedgetSourceBinding():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:983
getUseCustomRenderingPipeline()
getUseCustomRenderingPipeline():
boolean
Returns
boolean
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:68
getViewReference()
getViewReference(
_viewRefSpecifier):ViewReference
Returns a spatial reference for the current viewport state.
Parameters
• _viewRefSpecifier: ViewReferenceSpecifier = {}
Returns
Overrides
GenericViewport.getViewReference
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:330
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:390
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
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:287
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:377
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:278
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:404
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:416
isFidelityView3D()
protectedisFidelityView3D():boolean
A 3D view: a rotation can bring any axis into the view plane.
Returns
boolean
Overrides
GenericViewport.isFidelityView3D
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:146
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:404
mergeDataPresentation()
protectedmergeDataPresentation(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:825
modified()
protectedmodified(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
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:880
normalizeViewState()
protectednormalizeViewState(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
Inherited from
GenericViewport.normalizeViewState
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:871
notifyDataPresentationModified()
protectednotifyDataPresentationModified(_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:856
notifyFidelityStateChanged()
notifyFidelityStateChanged():
void
Internal
Fires VIEWPORT_FIDELITY_CHANGED when the derived fidelity state changes
(FIDELITY-EVENT-2..4). Called after each draw (FIDELITY-EVENT-7). A
viewport that cannot report fidelity does nothing.
Returns
void
Inherited from
GenericViewport.notifyFidelityStateChanged
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:292
onDestroy()
protectedonDestroy():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
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:583
removeAllData()
protectedremoveAllData():void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:761
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
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:186
removeWidgets()
removeWidgets():
void
Returns
void
Deprecated
Compatibility no-op retained during the V2 migration.
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:549
render()
render():
void
Renders active 3D bindings or queues an engine-driven render.
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:573
renderBindings()
protectedrenderBindings():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:1059
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: falsekeeps the current parallel scale (zoom) instead of refitting to bounds. (OrientationControllerTool animates orientation withresetZoom: false; VolumeCroppingControlTool also forwards options.)resetPan: false/resetToCenter: falsekeep 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:502
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:552
resize()
resize():
void
Updates cached size state and notifies active render bindings.
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:559
resizeBindings()
protectedresizeBindings():void
Invokes resize on each mounted binding.
Returns
void
Inherited from
GenericViewport.resizeBindings
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:1077
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:652
setDataPresentationState()
protectedsetDataPresentationState(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:771
setDefaultDataPresentation()
protectedsetDefaultDataPresentation(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:804
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:208
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:209
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:173
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:603
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
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:72
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:397
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
Defined in
packages/core/src/RenderingEngine/GenericViewport/Volume3D/viewport3D.ts:291
triggerCameraModifiedEvent()
protectedtriggerCameraModifiedEvent(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:909
triggerCameraResetEvent()
protectedtriggerCameraResetEvent():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:924
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:620
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:527
worldToCanvas()
worldToCanvas(
worldPos):Point2
Converts a world-space point to canvas-space coordinates using the computed camera.
Parameters
• worldPos: Point3
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/GenericViewport/GenericViewport.ts:470