Class: VolumeViewport3D
An object representing a 3-dimensional volume viewport. VolumeViewport3Ds are used to render 3D volumes in their entirety, and not just load a single slice at a time.
For setting volumes on viewports you need to use addVolumesToViewports which will add volumes to the specified viewports.
Extends
Constructors
new VolumeViewport3D()
new VolumeViewport3D(
props):VolumeViewport3D
Parameters
• props: ViewportInput
Returns
Overrides
BaseVolumeViewport.constructor
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:21
Properties
_actors
_actors:
Map<string,ActorEntry>
a Map containing the actor uid and actors
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:142
_displaySets
protected_displaySets:object[] =[]
Records the display sets currently mounted on the viewport. Populated by the
type-specific setDisplaySets overrides (via mountDisplaySets)
and cleared whenever raw data is set directly (e.g. setStack), so that
getDisplaySets reflects only display-set-driven content.
Inherited from
BaseVolumeViewport._displaySets
Defined in
packages/core/src/RenderingEngine/Viewport.ts:149
_suppressCameraModifiedEvents
_suppressCameraModifiedEvents:
boolean=false
informs if a new actor was added before a resetCameraClippingRange phase
Inherited from
BaseVolumeViewport._suppressCameraModifiedEvents
Defined in
packages/core/src/RenderingEngine/Viewport.ts:156
calibration
protectedcalibration:IImageCalibration
Inherited from
BaseVolumeViewport.calibration
Defined in
packages/core/src/RenderingEngine/Viewport.ts:160
canvas
readonlycanvas:HTMLCanvasElement
an internal canvas that is created on the provided HTML element
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:104
canvasToWorld()
canvasToWorld: (
canvasPos) =>Point3
Parameters
• canvasPos: Point2
Returns
Inherited from
BaseVolumeViewport.canvasToWorld
Defined in
packages/core/src/RenderingEngine/Viewport.ts:198
customRenderViewportToCanvas()
customRenderViewportToCanvas: () =>
unknown
Returns
unknown
Inherited from
BaseVolumeViewport.customRenderViewportToCanvas
Defined in
packages/core/src/RenderingEngine/Viewport.ts:200
defaultOptions
readonlydefaultOptions:ViewportInputOptions
Default options for the viewport which includes orientation, viewPlaneNormal and backgroundColor
Inherited from
BaseVolumeViewport.defaultOptions
Defined in
packages/core/src/RenderingEngine/Viewport.ts:152
element
readonlyelement:HTMLDivElement
HTML element in DOM that is used for rendering the viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:102
fitToCanvasCamera
protectedfitToCanvasCamera:ICamera<number>
The camera that is defined for resetting displayArea to ensure absolute displayArea settings
Inherited from
BaseVolumeViewport.fitToCanvasCamera
Defined in
packages/core/src/RenderingEngine/Viewport.ts:168
flipHorizontal
protectedflipHorizontal:boolean=false
Inherited from
BaseVolumeViewport.flipHorizontal
Defined in
packages/core/src/RenderingEngine/Viewport.ts:125
flipVertical
protectedflipVertical:boolean=false
Inherited from
BaseVolumeViewport.flipVertical
Defined in
packages/core/src/RenderingEngine/Viewport.ts:126
hasPixelSpacing
protectedhasPixelSpacing:boolean=true
Inherited from
BaseVolumeViewport.hasPixelSpacing
Defined in
packages/core/src/RenderingEngine/Viewport.ts:159
id
readonlyid:string
unique identifier for the viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:100
initialCamera
protectedinitialCamera:ICamera<number>
The camera that is initially defined on the reset for the relative pan/zoom
Inherited from
BaseVolumeViewport.initialCamera
Defined in
packages/core/src/RenderingEngine/Viewport.ts:164
initialTransferFunctionNodes
protectedinitialTransferFunctionNodes:TransferFunctionNodes
Inherited from
BaseVolumeViewport.initialTransferFunctionNodes
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:112
initialViewUp
protectedinitialViewUp:Point3
Inherited from
BaseVolumeViewport.initialViewUp
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:120
insetImageMultiplier
protectedinsetImageMultiplier:number
The amount by which the images are inset in a viewport by default.
Inherited from
BaseVolumeViewport.insetImageMultiplier
Defined in
packages/core/src/RenderingEngine/Viewport.ts:120
isDisabled
isDisabled:
boolean
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:127
options
options:
ViewportInputOptions
options for the viewport which includes orientation axis, backgroundColor and displayArea
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:154
renderingEngineId
readonlyrenderingEngineId:string
RenderingEngine id that the viewport belongs to
Inherited from
BaseVolumeViewport.renderingEngineId
Defined in
packages/core/src/RenderingEngine/Viewport.ts:106
renderingPipelineFunctions
protectedrenderingPipelineFunctions:object
canvasToWorld
canvasToWorld:
object
canvasToWorld.contextPool()
contextPool: (
canvasPos) =>Point3
Parameters
• canvasPos: Point2
Returns
canvasToWorld.tiled()
tiled: (
canvasPos) =>Point3
canvasToWorld Returns the world coordinates of the given canvasPos
projected onto the plane defined by the Viewport's vtkCamera's focal point
and the direction of projection.
Parameters
• canvasPos: Point2
The position in canvas coordinates.
Returns
The corresponding world coordinates.
getRenderer
getRenderer:
object
getRenderer.contextPool()
contextPool: () =>
vtkRenderer
Get the renderer for this viewport - handles ContextPoolRenderingEngine
Returns
vtkRenderer
getRenderer.tiled()
tiled: () =>
vtkRenderer
Returns the vtkRenderer responsible for rendering the Viewport.
Returns
vtkRenderer
The vtkRenderer for the Viewport.
getVtkDisplayCoords
getVtkDisplayCoords:
object
getVtkDisplayCoords.contextPool()
contextPool: (
canvasPos) =>Point3
Parameters
• canvasPos: Point2
Returns
getVtkDisplayCoords.tiled()
tiled: (
canvasPos) =>Point3
Returns the VTK.js display coordinates of the given canvasPos projected onto the
Viewport's vtkCamera's focal point and the direction of projection.
Parameters
• canvasPos: Point2
The position in canvas coordinates.
Returns
The corresponding display coordinates.
worldToCanvas
worldToCanvas:
object
worldToCanvas.contextPool()
contextPool: (
worldPos) =>Point2
Parameters
• worldPos: Point3
Returns
worldToCanvas.tiled()
tiled: (
worldPos) =>Point2
Returns the canvas coordinates of the given worldPos
projected onto the Viewport's canvas.
Parameters
• worldPos: Point3
The position in world coordinates.
Returns
The corresponding canvas coordinates.
Inherited from
BaseVolumeViewport.renderingPipelineFunctions
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2592
requestedType?
optionalrequestedType:ViewportType
The viewport type originally requested by the caller, before any internal
compatibility remap (e.g. STACK/ORTHOGRAPHIC requested as PLANAR_NEXT when
rendering.useGenericViewport is enabled). Equals type when not remapped.
Set by the rendering engine at creation. Use this when branching on the
legacy viewport type so the branch is transparent across compat adapters.
Inherited from
BaseVolumeViewport.requestedType
Defined in
packages/core/src/RenderingEngine/Viewport.ts:116
resize()
resize: () =>
void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:201
sHeight
sHeight:
number
sHeight of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:140
suppressEvents
readonlysuppressEvents:boolean
A flag representing if viewport methods should fire events or not
Inherited from
BaseVolumeViewport.suppressEvents
Defined in
packages/core/src/RenderingEngine/Viewport.ts:158
sWidth
sWidth:
number
sWidth of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:138
sx
sx:
number
sx of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:134
sy
sy:
number
sy of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:136
type
readonlytype:ViewportType
Type of viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:108
updateRenderingPipeline()
updateRenderingPipeline: () =>
void
Returns
void
Inherited from
BaseVolumeViewport.updateRenderingPipeline
Defined in
packages/core/src/RenderingEngine/Viewport.ts:203
useCPURendering
useCPURendering:
boolean=false
Inherited from
BaseVolumeViewport.useCPURendering
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:107
viewportProperties
protectedviewportProperties:VolumeViewportProperties={}
Inherited from
BaseVolumeViewport.viewportProperties
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:121
viewportStatus
viewportStatus:
ViewportStatus=ViewportStatus.NO_DATA
Record the rendering status, mostly for testing purposes, but can also be useful for knowing things like whether the viewport is initialized
Inherited from
BaseVolumeViewport.viewportStatus
Defined in
packages/core/src/RenderingEngine/Viewport.ts:131
worldToCanvas()
worldToCanvas: (
worldPos) =>Point2
Parameters
• worldPos: Point3
Returns
Inherited from
BaseVolumeViewport.worldToCanvas
Defined in
packages/core/src/RenderingEngine/Viewport.ts:199
CameraViewPresentation
readonlystaticCameraViewPresentation:ViewPresentationSelector
CameraViewPresentation is a view presentation selector that has all the camera related presentation selections, and would typically be used for choosing presentation information between two viewports showing the same type of orientation of a view, such as the CT, PT and fusion views in the same orientation view.
Inherited from
BaseVolumeViewport.CameraViewPresentation
Defined in
packages/core/src/RenderingEngine/Viewport.ts:80
TransferViewPresentation
readonlystaticTransferViewPresentation:ViewPresentationSelector
TransferViewPresentation is a view presentation selector that selects all the transfer function related attributes. It would typically be used for synchronizing different orientations of the same series, or for synchronizing two views of the same type of series such as a CT.
Inherited from
BaseVolumeViewport.TransferViewPresentation
Defined in
packages/core/src/RenderingEngine/Viewport.ts:94
Accessors
useCustomRenderingPipeline
getstaticuseCustomRenderingPipeline():boolean
Returns
boolean
Inherited from
BaseVolumeViewport.useCustomRenderingPipeline
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:159
Methods
_getAcquisitionPlaneOrientation()
protected_getAcquisitionPlaneOrientation():OrientationVectors
Returns
Inherited from
BaseVolumeViewport._getAcquisitionPlaneOrientation
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2383
_getCorners()
_getCorners(
bounds):number[][]
Parameters
• bounds: number[]
Returns
number[][]
Inherited from
BaseVolumeViewport._getCorners
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2389
_getEdges()
_getEdges(
bounds): [number[],number[]][]
Returns a list of edges for the imageData bounds, which are the cube edges in the case of volumeViewport edges. p1: front, bottom, left p2: front, top, left p3: back, bottom, left p4: back, top, left p5: front, bottom, right p6: front, top, right p7: back, bottom, right p8: back, top, right
Parameters
• bounds: number[]
Bounds of the renderer
Returns
[number[], number[]][]
Edges of the containing bounds
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2485
_getFocalPointForResetCamera()
_getFocalPointForResetCamera(
centeredFocalPoint,previousCamera,__namedParameters):Point3
Parameters
• centeredFocalPoint: Point3
• previousCamera: ICamera<number>
• __namedParameters
• __namedParameters.resetPan: boolean = true
• __namedParameters.resetToCenter: boolean = true
Returns
Inherited from
BaseVolumeViewport._getFocalPointForResetCamera
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2402
_getOrientationVectors()
protected_getOrientationVectors(orientation):OrientationVectors
Parameters
• orientation: OrientationAxis | OrientationVectors
Returns
Inherited from
BaseVolumeViewport._getOrientationVectors
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2325
_getViewUp()
protected_getViewUp(viewPlaneNormal):Point3
Gets a view up given a view plane normal and the current orientation Chooses the current view up if orthogonal, otherwise the default view ups for axial, sagittal and coronal Otherwise runs the Gram-Schmidt algorithm with the current viewUp
Parameters
• viewPlaneNormal: Point3
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2302
_isInBounds()
_isInBounds(
point,bounds):boolean
Determines whether or not the 3D point position is inside the boundaries of the 3D imageData.
Parameters
• point: Point3
3D coordinate
• bounds: number[]
Bounds of the image
Returns
boolean
boolean
Inherited from
BaseVolumeViewport._isInBounds
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2462
_removeActor()
_removeActor(
actorUID):ActorEntry
Remove the actor from the viewport
Parameters
• actorUID: string
The unique identifier for the actor.
Returns
The removed actor entry or undefined if it didn't exist
Inherited from
BaseVolumeViewport._removeActor
Defined in
packages/core/src/RenderingEngine/Viewport.ts:674
_restoreVolumeRenderingDefaults()
protected_restoreVolumeRenderingDefaults(volumeActor,volumeId):void
Restores the default visual transfer function for a volume actor on reset. If the viewport has a configured default preset or colormap, it re-applies them via setProperties to restore the full visual state (color TF, opacity, lighting). Otherwise, it falls back to the initial transfer function nodes captured at volume load time.
Parameters
• volumeActor: ActorEntry
The actor entry for the volume
• volumeId: string
The id of the volume
Returns
void
Inherited from
BaseVolumeViewport._restoreVolumeRenderingDefaults
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1197
addActor()
addActor(
actorEntry):void
Add an actor to the viewport including its id, its actor and slabThickness if defined
Parameters
• actorEntry: ActorEntry
ActorEntry
- actorEntry.uid - The unique identifier for the actor.
- actorEntry.actor - The volume actor.
- actorEntry.slabThickness - The slab thickness.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:767
addActors()
addActors(
actors,options):void
Add a list of actors (actor entries) to the viewport
Parameters
• actors: ActorEntry[]
An array of ActorEntry objects.
• options = {}
• options.resetCamera?: boolean
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:718
addVolumes()
addVolumes(
volumeInputArray,immediate,suppressEvents):Promise<void>
Creates and adds volume actors for all volumes defined in the volumeInputArray.
For each entry, if a callback is supplied, it will be called with the new volume actor as input.
Parameters
• volumeInputArray: IVolumeInput[]
The array of VolumeInputs which define the volumes to add.
• immediate: boolean = false
Whether the Viewport should be rendered as soon as volumes are added.
• suppressEvents: boolean = false
Returns
Promise<void>
Inherited from
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1568
addWidget()
addWidget(
widgetId,widget):void
Parameters
• widgetId: any
• widget: any
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:249
applyViewOrientation()
protectedapplyViewOrientation(orientation,resetCamera,suppressEvents):void
Parameters
• orientation: OrientationAxis | OrientationVectors
• resetCamera: boolean = true
• suppressEvents: boolean = false
Returns
void
Inherited from
BaseVolumeViewport.applyViewOrientation
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:178
canvasToWorldContextPool()
canvasToWorldContextPool(
canvasPos):Point3
Parameters
• canvasPos: Point2
Returns
Inherited from
BaseVolumeViewport.canvasToWorldContextPool
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1975
canvasToWorldTiled()
canvasToWorldTiled(
canvasPos):Point3
canvasToWorld Returns the world coordinates of the given canvasPos
projected onto the plane defined by the Viewport's vtkCamera's focal point
and the direction of projection.
Parameters
• canvasPos: Point2
The position in canvas coordinates.
Returns
The corresponding world coordinates.
Inherited from
BaseVolumeViewport.canvasToWorldTiled
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1930
clearDefaultProperties()
clearDefaultProperties(
volumeId?):void
Remove the global default properties of the viewport or remove default properties for a volumeId if specified
Parameters
• volumeId?: string
If given, we remove the default properties only for this volumeId, if not the global default properties will be removed
Returns
void
Inherited from
BaseVolumeViewport.clearDefaultProperties
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:662
clearDisplaySets()
protectedclearDisplaySets():void
Clears the recorded display sets. Native data setters call this so that setting raw data without setDisplaySets resets the stored list. mountDisplaySets relies on this ordering: it runs the native data setter first (which clears) and then records the mounted entries.
Returns
void
Inherited from
BaseVolumeViewport.clearDisplaySets
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2617
destroy()
destroy():
void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:291
dispose()
dispose():
void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:286
flip()
flip(
flipDirection):void
Flip the viewport along the desired axis
Parameters
• flipDirection: FlipDirection
FlipDirection
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1801
getActor()
getActor(
actorUID):ActorEntry
Get an actor by its UID
Parameters
• actorUID: string
The unique ID of the actor.
Returns
An ActorEntry object.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:603
getActorByIndex()
getActorByIndex(
index):ActorEntry
Get an actor by its index
Parameters
• index: number
array index.
Returns
actorUID
Inherited from
BaseVolumeViewport.getActorByIndex
Defined in
packages/core/src/RenderingEngine/Viewport.ts:646
getActors()
getActors():
ActorEntry[]
Get all the actors in the viewport
Returns
An array of ActorEntry objects.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:586
getActorUIDByIndex()
getActorUIDByIndex(
index):string
Get an actor UID by its index
Parameters
• index: number
array index.
Returns
string
actorUID
Inherited from
BaseVolumeViewport.getActorUIDByIndex
Defined in
packages/core/src/RenderingEngine/Viewport.ts:634
getActorUIDs()
getActorUIDs():
string[]
Returns an array of unique identifiers for all the actors in the viewport.
Returns
string[]
An array of strings
Inherited from
BaseVolumeViewport.getActorUIDs
Defined in
packages/core/src/RenderingEngine/Viewport.ts:594
getAllVolumeIds()
getAllVolumeIds():
string[]
Returns an array of all volumeIds currently in the viewport.
Returns
string[]
An array of strings representing all volumeIds.
Inherited from
BaseVolumeViewport.getAllVolumeIds
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2571
getAspectRatio()
getAspectRatio():
Point2
Returns the current aspect ratio of the viewport as a 2D point [widthRatio, heightRatio].
Returns
The current aspect ratio [widthRatio, heightRatio]
based on the active camera settings.
Inherited from
BaseVolumeViewport.getAspectRatio
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1597
getBounds()
getBounds():
number[]
gets the visible bounds of the viewport in the world coordinate system
Returns
number[]
Inherited from
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1791
getCamera()
getCamera():
ICamera<number>
Get the camera's current state
Returns
ICamera<number>
The camera object.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1760
getCameraNoRotation()
protectedgetCameraNoRotation():ICamera<number>
Returns
ICamera<number>
Inherited from
BaseVolumeViewport.getCameraNoRotation
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1716
getCanvas()
getCanvas():
HTMLCanvasElement
Gets the target output canvas for the Viewport.
Returns
HTMLCanvasElement
an HTMLCanvasElement.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1697
getClippingPlanesForActor()
getClippingPlanesForActor(
actorEntry?):vtkPlane[]
Method to get the clipping planes of a given actor
Parameters
• actorEntry?: ActorEntry
The actor entry (a specific type you'll define dependent on your code)
Returns
vtkPlane[]
vtkPlanes - An array of vtkPlane objects associated with the given actor
Inherited from
BaseVolumeViewport.getClippingPlanesForActor
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2039
getComparableParallelScale()
protectedgetComparableParallelScale(compareCamera):number
Gets the parallel scale of the given camera, expressed at the aspect ratio of the current camera.
Each aspect ratio has a different fit, so a zoom of 1 fits the image only when the zoom reads the baseline through the ratio between the two fits. The usual case is two equal aspect ratios, which needs no work.
Parameters
• compareCamera: ICamera<number>
the initial camera, or the fit to canvas camera.
Returns
number
the parallel scale of the baseline at the current aspect ratio.
Inherited from
BaseVolumeViewport.getComparableParallelScale
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1505
getCurrentImageId()
getCurrentImageId():
string
Returns
string
Overrides
BaseVolumeViewport.getCurrentImageId
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:119
getCurrentImageIdIndex()
getCurrentImageIdIndex():
number
Returns
number
Overrides
BaseVolumeViewport.getCurrentImageIdIndex
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:115
getDefaultActor()
getDefaultActor():
ActorEntry
Get the default actor
Returns
An actor entry.
Inherited from
BaseVolumeViewport.getDefaultActor
Defined in
packages/core/src/RenderingEngine/Viewport.ts:578
getDefaultProperties()
getDefaultProperties(
volumeId?):VolumeViewportProperties
Retrieve the viewport default properties
Parameters
• volumeId?: string
If given, we retrieve the default properties of a volumeId if it exists If not given,we return the global properties of the viewport
Returns
default viewport properties including voi, invert, interpolation type, colormap
Inherited from
BaseVolumeViewport.getDefaultProperties
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1316
getDisplayArea()
getDisplayArea():
DisplayArea
Returns
Inherited from
BaseVolumeViewport.getDisplayArea
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1127
getDisplaySets()
getDisplaySets():
object[]
Returns the display sets currently recorded as mounted on the viewport. Empty when the viewport was driven by a raw data setter instead of setDisplaySets.
Returns
object[]
Inherited from
BaseVolumeViewport.getDisplaySets
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2607
getFitParallelScale()
protectedgetFitParallelScale(worldSize,aspectRatio):number
Gets the parallel scale that makes the content fit the canvas at the given aspect ratio. Each aspect ratio has a different fit.
Parameters
• worldSize
the size of the content in the world.
• worldSize.heightWorld: number
• worldSize.widthWorld: number
• aspectRatio: Point2
the aspect ratio to fit at, as [widthRatio, heightRatio].
Returns
number
the parallel scale of the fit.
Inherited from
BaseVolumeViewport.getFitParallelScale
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1176
getFrameOfReferenceUID()
getFrameOfReferenceUID():
string
Returns
string
Inherited from
BaseVolumeViewport.getFrameOfReferenceUID
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1805
getImageActor()
getImageActor(
volumeId?):vtkImageSlice
Retrieves an image actor from the viewport actors.
Parameters
• volumeId?: string
Optional. The ID of the volume to find the corresponding image actor.
Returns
vtkImageSlice
The image actor if found, otherwise null.
Inherited from
BaseVolumeViewport.getImageActor
Defined in
packages/core/src/RenderingEngine/Viewport.ts:613
getImageData()
getImageData(
volumeId?):IImageData
Returns the image and its properties that is being shown inside the stack viewport. It returns, the image dimensions, image direction, image scalar data, vtkImageData object, metadata, and scaling (e.g., PET suvbw) Note: since the volume viewport supports fusion, to get the image data for a specific volume, use the optional volumeId argument.
Parameters
• volumeId?: string
The volumeId of the volume to get the image for.
Returns
IImageData
Inherited from
BaseVolumeViewport.getImageData
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1847
getImageIds()
getImageIds(
volumeId?):string[]
Returns the list of image Ids for the current viewport
Parameters
• volumeId?: string
volumeId
Returns
string[]
list of strings for image Ids
Inherited from
BaseVolumeViewport.getImageIds
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2461
getIntensityFromWorld()
getIntensityFromWorld(
point):number
Given a point in world coordinates, return the intensity at that point
Parameters
• point: Point3
The point in world coordinates to get the intensity from.
Returns
number
The intensity value of the voxel at the given point.
Inherited from
BaseVolumeViewport.getIntensityFromWorld
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2440
getNumberOfSlices()
getNumberOfSlices():
number
Returns
number
Overrides
BaseVolumeViewport.getNumberOfSlices
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:71
getPan()
getPan(
initialCamera):Point2
Helper function to return the current canvas pan value.
Parameters
• initialCamera: ICamera<number> = ...
Returns
a Point2 containing the current pan values on the canvas, computed from the current camera, where the initial pan value is [0,0].
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1416
getProperties()
getProperties(
volumeId?):VolumeViewportProperties
Retrieve the viewport properties
Parameters
• volumeId?: string
The volume id to get the properties for (if undefined, the first volume)
Returns
viewport properties including voi, interpolation type: TODO: slabThickness, invert
Inherited from
BaseVolumeViewport.getProperties
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1338
getReferencePlaneThickness()
protectedgetReferencePlaneThickness():number
Get the geometric thickness in mm that an annotation applies to.
This method does NOT return the slab thickness. getSlabThickness returns
a half thickness on this render path, so this method doubles that value,
and it maps the rendering minimum to undefined. See
docs/docs/concepts/cornerstone-tools/annotation/voxel-statistics.md.
Returns
number
Inherited from
BaseVolumeViewport.getReferencePlaneThickness
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2430
getRenderer()
getRenderer():
vtkRenderer
Returns the vtkRenderer responsible for rendering the Viewport.
Returns
vtkRenderer
The vtkRenderer for the Viewport.
Inherited from
BaseVolumeViewport.getRenderer
Defined in
packages/core/src/RenderingEngine/Viewport.ts:361
getRendererContextPool()
getRendererContextPool():
vtkRenderer
Get the renderer for this viewport - handles ContextPoolRenderingEngine
Returns
vtkRenderer
Inherited from
BaseVolumeViewport.getRendererContextPool
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2250
getRendererTiled()
getRendererTiled():
vtkRenderer
Returns the vtkRenderer responsible for rendering the Viewport.
Returns
vtkRenderer
The vtkRenderer for the Viewport.
Inherited from
BaseVolumeViewport.getRendererTiled
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2260
getRenderingEngine()
getRenderingEngine():
RenderingEngine
Returns the rendering engine driving the Viewport.
Returns
The RenderingEngine instance.
Inherited from
BaseVolumeViewport.getRenderingEngine
Defined in
packages/core/src/RenderingEngine/Viewport.ts:352
getRenderPasses()
getRenderPasses():
any[]
Get render passes for this viewport. If sharpening or smoothing is enabled, returns appropriate render passes.
Returns
any[]
Array of VTK render passes or null if no custom passes are needed
Inherited from
BaseVolumeViewport.getRenderPasses
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1165
getRotation()
getRotation():
number
Gets the rotation resulting from the value set in setRotation AND taking into account any flips that occurred subsequently from the camera provided or the viewport.
Returns
number
the rotation resulting from the value set in setRotation AND taking into account any flips that occurred subsequently.
Overrides
BaseVolumeViewport.getRotation
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:113
getSlabThickness()
getSlabThickness():
number
Gets the largest slab thickness from all actors in the viewport.
Returns
number
slabThickness - The slab thickness.
Inherited from
BaseVolumeViewport.getSlabThickness
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2410
getSliceIndex()
getSliceIndex():
number
Returns
number
Overrides
BaseVolumeViewport.getSliceIndex
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:185
getSliceViewInfo()
getSliceViewInfo():
object
Returns
object
height
height:
number
indexToSliceMatrix
indexToSliceMatrix:
mat4
sliceIndex
sliceIndex:
number
slicePlane
slicePlane:
number
sliceToIndexMatrix
sliceToIndexMatrix:
mat4
width
width:
number
Inherited from
BaseVolumeViewport.getSliceViewInfo
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:167
getUseCustomRenderingPipeline()
getUseCustomRenderingPipeline():
boolean
Returns
boolean
Inherited from
BaseVolumeViewport.getUseCustomRenderingPipeline
Defined in
packages/core/src/RenderingEngine/Viewport.ts:213
getViewPresentation()
getViewPresentation(
viewPresSel):ViewPresentation
Gets a view presentation information specifying HOW a viewport displays something, but not what is being displayed. See getViewReference to get information on WHAT is being displayed.
This is intended to have information on how an image is presented to the user, without specifying what image s displayed. All of this information is available externally, but this method combines the parts of this that are appropriate for remember or applying to other views, without necessarily needing to know what all the attributes are. That differs from methods like getCamera which fetch exact view details that are not likely to be identical between viewports as they change sizes or apply to different images.
Note that the results of this can be used on different viewports, for example, the pan values can be applied to a volume viewport showing a CT, and a stack viewport showing an ultrasound.
The selector allows choosing which view presentation attributes to return.
Some default values are available from Viewport.CameraViewPresentation and
Viewport.TransferViewPresentation
Parameters
• viewPresSel: ViewPresentationSelector = ...
select which attributes to display.
Returns
Inherited from
BaseVolumeViewport.getViewPresentation
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2281
getViewReference()
getViewReference(
viewRefSpecifier):ViewReference
Gets a view target, allowing comparison between view positions as well as restoring views later.
Parameters
• viewRefSpecifier: ViewReferenceSpecifier = {}
Returns
Inherited from
BaseVolumeViewport.getViewReference
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:676
getViewReferenceId()
getViewReferenceId(
specifier):string
For a volume viewport, the reference id will be a URN starting with
volumeId:<volumeId>, followed by additional arguments to specify
the view orientation. This will end up being a unique string that
identifies the view reference being shown. It is different from the
view reference in that the values are all incorporated into a string to
allow using it as a parameter key.
Parameters
• specifier: ViewReferenceSpecifier = {}
Returns
string
Inherited from
BaseVolumeViewport.getViewReferenceId
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2520
getVOIModifiedEventDetail()
protectedgetVOIModifiedEventDetail(volumeId):VoiModifiedEventDetail
Parameters
• volumeId: string
Returns
Inherited from
BaseVolumeViewport.getVOIModifiedEventDetail
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:445
getVolumeId()
getVolumeId(
specifier?):string
Gets the volumeId to use for references. Returns undefined if the specified volume is NOT in this viewport.
Parameters
• specifier?: ViewReferenceSpecifier
Returns
string
Inherited from
BaseVolumeViewport.getVolumeId
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2486
getVtkActiveCamera()
protectedgetVtkActiveCamera():vtkCamera|vtkSlabCamera
Gets the active vtkCamera for the viewport.
Returns
vtkCamera | vtkSlabCamera
vtk driven camera
Inherited from
BaseVolumeViewport.getVtkActiveCamera
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1705
getVtkDisplayCoordsContextPool()
getVtkDisplayCoordsContextPool(
canvasPos):Point3
Parameters
• canvasPos: Point2
Returns
Inherited from
BaseVolumeViewport.getVtkDisplayCoordsContextPool
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2077
getVtkDisplayCoordsTiled()
getVtkDisplayCoordsTiled(
canvasPos):Point3
Returns the VTK.js display coordinates of the given canvasPos projected onto the
Viewport's vtkCamera's focal point and the direction of projection.
Parameters
• canvasPos: Point2
The position in canvas coordinates.
Returns
The corresponding display coordinates.
Inherited from
BaseVolumeViewport.getVtkDisplayCoordsTiled
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2056
getWidget()
getWidget(
id):any
Parameters
• id: any
Returns
any
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:253
getWidgets()
getWidgets():
any[]
Returns
any[]
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:257
getWorldSizeInView()
protectedgetWorldSizeInView(bounds?):object
Gets the size of the visible content in the world, along the view right axis and along the view up axis.
Parameters
• bounds?: number[]
the bounds to use when the viewport shows no image data. The method computes the bounds when the caller gives none.
Returns
object
the width and the height of the content in the world.
heightWorld
heightWorld:
number
widthWorld
widthWorld:
number
Inherited from
BaseVolumeViewport.getWorldSizeInView
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1139
getZoom()
getZoom(
compareCamera):number
Returns a current zoom level relative to the initial parallel scale originally applied to the image. That is, on initial display, the zoom level is 1. Computed as a function of the camera.
The zoom is relative to the fit of the aspect ratio that the camera holds, so a zoom of 1 fits the image at every aspect ratio.
Parameters
• compareCamera: ICamera<number> = ...
Returns
number
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1550
hasImageURI()
hasImageURI(
imageURI):boolean
Parameters
• imageURI: string
Returns
boolean
Inherited from
BaseVolumeViewport.hasImageURI
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2277
hasVolumeId()
hasVolumeId(
volumeId):boolean
Checks if the viewport has a volume actor with the given volumeId
Parameters
• volumeId: string
the volumeId to look for
Returns
boolean
Boolean indicating if the volume is present in the viewport
Inherited from
BaseVolumeViewport.hasVolumeId
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1814
hasVolumeURI()
hasVolumeURI(
volumeURI):boolean
Checks if the viewport has a volume with the given volumeURI.
Parameters
• volumeURI: string
The URI of the volume to check for.
Returns
boolean
A boolean indicating whether the viewport contains a volume with the given URI.
Inherited from
BaseVolumeViewport.hasVolumeURI
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1826
isInAcquisitionPlane()
isInAcquisitionPlane():
boolean
Returns
boolean
Overrides
BaseVolumeViewport.isInAcquisitionPlane
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:75
isOrientationChangeable()
isOrientationChangeable():
boolean
Returns whether the viewport supports changing orientation (e.g. via setCamera with viewPlaneNormal/viewUp). Used by tools like OrientationControllerTool to decide where to show interactive orientation markers.
Returns
boolean
Inherited from
BaseVolumeViewport.isOrientationChangeable
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:163
isPlaneViewable()
isPlaneViewable(
planeRestriction,options?):boolean
Parameters
• planeRestriction: PlaneRestriction
• options?: ReferenceCompatibleOptions
Returns
boolean
Inherited from
BaseVolumeViewport.isPlaneViewable
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2170
isReferenceViewable()
isReferenceViewable(
viewRef,options?):boolean
Find out if this viewport would show this view
Parameters
• viewRef: ViewReference
• options?: ReferenceCompatibleOptions
allows specifying whether the view COULD display this with some modification - either navigation or displaying as volume.
Returns
boolean
true if the target is compatible with this view
Inherited from
BaseVolumeViewport.isReferenceViewable
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:723
mountDisplaySets()
protectedmountDisplaySets<TEntry>(entries,load):Promise<void>
Shared template for the type-specific setDisplaySets overrides. It keeps the clear-then-record ordering invariant in exactly one place instead of being copy-pasted per viewport:
- Validate that a source display set (the first entry) was provided.
- Run
load, which resolves the entry to renderable data and hands it to the viewport's native data setter (setStack/setVolumes/setVideo/setWSI/setEcg). That native setter calls clearDisplaySets, wiping any previously recorded entries. - Record the mounted entries - only after
loadresolves - so getDisplaySets reflects exactly what was mounted.
Because recording always happens last, a new viewport cannot accidentally record before loading (which the native setter would then wipe) or forget to record at all; both failure modes the previous copy-pasted sequence was prone to are handled here once.
Overlays: the variadic signature already accepts overlay entries (index 1+),
matching the generic viewport setDisplaySets. Legacy viewports do not yet
render overlays, so only the source (first) entry is loaded and recorded -
getDisplaySets stays honest about what is actually shown. Adding
overlay support later is purely additive: load the extra entries here and
record them, with no change to the public signature.
Type Parameters
• TEntry extends object
Parameters
• entries: TEntry[]
the display set entries passed to setDisplaySets; the
first is the source and any subsequent entries are overlays.
• load
resolves the source entry to renderable data and loads it via the viewport's native data setter. Receives the validated source entry.
Returns
Promise<void>
Inherited from
BaseVolumeViewport.mountDisplaySets
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2581
removeActors()
removeActors(
actorUIDs):void
Remove the actors with the given UIDs from the viewport
Parameters
• actorUIDs: string[]
An array of actor UIDs to remove.
Returns
void
Inherited from
BaseVolumeViewport.removeActors
Defined in
packages/core/src/RenderingEngine/Viewport.ts:693
removeAllActors()
removeAllActors():
void
Remove all actors from the renderer
Returns
void
Inherited from
BaseVolumeViewport.removeAllActors
Defined in
packages/core/src/RenderingEngine/Viewport.ts:807
removeVolumeActors()
removeVolumeActors(
actorUIDs,immediate):void
It removes the volume actor from the Viewport. If the volume actor is not in the viewport, it does nothing.
Parameters
• actorUIDs: string[]
Array of actor UIDs to remove. In case of simple volume it will
be the volume Id, but in case of Segmentation it will be {volumeId}-{representationType}
since the same volume can be rendered in multiple representations.
• immediate: boolean = false
If true, the Viewport will be rendered immediately
Returns
void
Inherited from
BaseVolumeViewport.removeVolumeActors
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1641
removeWidgets()
removeWidgets():
void
Returns
void
Inherited from
BaseVolumeViewport.removeWidgets
Defined in
packages/core/src/RenderingEngine/Viewport.ts:270
render()
render():
void
Renders the Viewport using the RenderingEngine.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:374
reset()
reset(
immediate):void
Resets the options the Viewport's defaultOptions
Parameters
• immediate: boolean = false
If true, renders the viewport after the options are reset.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:413
resetCamera()
resetCamera(
options):boolean
Resets the camera based on the rendering volume(s) bounds. If resetPan and resetZoom are true it places the focal point at the center of the volume (or slice); otherwise, only the camera zoom and camera Pan or Zoom is reset for the current view.
Parameters
• options: ResetCameraOptions = {}
The reset options
Returns
boolean
boolean
Overrides
BaseVolumeViewport.resetCamera
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:79
resetCameraForResize()
resetCameraForResize():
boolean
Returns
boolean
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:177
resetCameraNoEvent()
protectedresetCameraNoEvent(options?):void
Reset the camera to the default viewport camera without firing events
Parameters
• options?: ResetCameraOptions
the same options that resetCamera takes.
Returns
void
Inherited from
BaseVolumeViewport.resetCameraNoEvent
Defined in
packages/core/src/RenderingEngine/Viewport.ts:828
resetProperties()
resetProperties(
volumeId?):void
Resets the properties of the volume to their default values.
Parameters
• volumeId?: string
The id of the volume to reset. If not provided, the default volume will be reset.
Returns
void
Overrides
BaseVolumeViewport.resetProperties
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:140
resetSlabThickness()
resetSlabThickness():
void
Returns
void
Overrides
BaseVolumeViewport.resetSlabThickness
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:210
resetToDefaultProperties()
resetToDefaultProperties(
volumeId):void
Reset the viewport properties to the default values
Parameters
• volumeId: string
Returns
void
Inherited from
BaseVolumeViewport.resetToDefaultProperties
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1224
resizeForRenderingEngine()
resizeForRenderingEngine(
__namedParameters):void
RenderingEngine-owned resize hook for custom-pipeline viewports. Legacy viewports keep the previous camera-preserving behavior by default.
Parameters
• __namedParameters: RenderingEngineResizeOptions = {}
Returns
void
Inherited from
BaseVolumeViewport.resizeForRenderingEngine
Defined in
packages/core/src/RenderingEngine/Viewport.ts:221
scroll()
scroll(
delta):void
Scrolls the viewport in the given direction/amount
Parameters
• delta: number = 1
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:750
setActors()
setActors(
actors):void
It removes all actors from the viewport and then adds the actors from the array.
Parameters
• actors: ActorEntry[]
An array of ActorEntry objects.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:654
setAspectRatio()
setAspectRatio(
value,options):void
Sets the aspect ratio of the viewport (canvas) using the provided 2D point
[widthRatio, heightRatio].
This updates the VTK camera's projection matrix to apply axis-based stretching during rendering.
As a result:
- World-to-canvas mapping is updated via the camera projection.
- Canvas-to-world mapping is also updated and remains consistent, as VTK utilizes the inverse of the same projection matrix for picking and coordinate transformations.
Note:
- The camera pose and orientation (position, focal point, and viewPlaneNormal) remain unchanged.
- Image data, spacing, and world coordinates are not modified.
- The parallel scale remains unchanged, unless the caller gives the
fitoption. Each aspect ratio has a different fit, andgetZoomreports the zoom against the fit of the aspect ratio that the camera holds.
Parameters
• value: Point2
The aspect ratio to set as [widthRatio, heightRatio].
• options: SetAspectRatioOptions = {}
fit the stretched image, and keep the aspect ratio as the
default. Both default to false.
Returns
void
Inherited from
BaseVolumeViewport.setAspectRatio
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1627
setBestOrentation()
setBestOrentation(
inPlaneVector1,inPlaneVector2):void
This will apply a camera orientation that is compatible with inPlaneVector1 and 2
- If inPlaneVector1 and inPlaneVector2 are compatible with, no change.
- If dot products of the current view plane normal and inPlaneVector 1 and 2 are zero, no change
Parameters
• inPlaneVector1: Point3
• inPlaneVector2: Point3
Returns
void
Inherited from
BaseVolumeViewport.setBestOrentation
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:790
setBlendMode()
setBlendMode(
blendMode,filterActorUIDs?,immediate?):void
Parameters
• blendMode: BlendModes
• filterActorUIDs?: string[]
• immediate?: boolean
Returns
void
Overrides
BaseVolumeViewport.setBlendMode
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:127
setCamera()
setCamera(
props):void
Set the camera parameters
Parameters
• props: any
ICamera
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:189
setCameraClippingRange()
protectedsetCameraClippingRange():void
Returns
void
Overrides
BaseVolumeViewport.setCameraClippingRange
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:195
setCameraNoEvent()
protectedsetCameraNoEvent(camera):void
Sets the camera to the default viewport camera without firing events
Parameters
• camera: ICamera<number>
The camera to use for the viewport.
Returns
void
Inherited from
BaseVolumeViewport.setCameraNoEvent
Defined in
packages/core/src/RenderingEngine/Viewport.ts:839
setColorTransform()
protectedsetColorTransform(voiRange,averageWhite):any
This applies a color transform as an svg filter to the output image.
Parameters
• voiRange: any
• averageWhite: any
Returns
any
Inherited from
BaseVolumeViewport.setColorTransform
Defined in
packages/core/src/RenderingEngine/Viewport.ts:322
setDataList()
setDataList(
_entries):void
Sets one or more datasets on the viewport. Legacy viewports should override this to delegate to their specific data setter.
Parameters
• _entries: object[]
Returns
void
Inherited from
BaseVolumeViewport.setDataList
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2523
setDefaultProperties()
setDefaultProperties(
ViewportProperties,volumeId?):void
Update the default properties for the volume viewport on the volume
Parameters
• ViewportProperties: VolumeViewportProperties
The properties to set
• volumeId?: string
The volume id to set the default properties for (if undefined, we set the global default viewport properties)
Returns
void
Inherited from
BaseVolumeViewport.setDefaultProperties
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:646
setDisplayArea()
setDisplayArea(
displayArea,suppressEvents):void
Sets the camera to an initial bounds. If resetPan and resetZoom are true it places the focal point at the center of the volume (or slice); otherwise, only the camera zoom and camera Pan or Zoom is reset for the current view.
Parameters
• displayArea: DisplayArea
The display area of interest.
• suppressEvents: boolean = false
If true, don't fire displayArea event.
Returns
void
Inherited from
BaseVolumeViewport.setDisplayArea
Defined in
packages/core/src/RenderingEngine/Viewport.ts:909
setDisplayAreaFit()
protectedsetDisplayAreaFit(displayArea):void
This applies a display area with a fit of the provided area to the available area. The zoom level is controlled by the imageArea parameter, which is a pair of percentage width in the horizontal and vertical dimension is scaled to fit the displayable area. Both values are taken into account, and the scaling is set so that both fractions of the image area are visible.
The panning is controlled by the imageCanvasPoint, which has two values, teh imagePoint and the canvasPoint. They are fractional values of the image and canvas respectively, with the panning set to display the image pixel at the given fraction on top of the canvas at the given percentage. The default points are 0.5.
For example, if the zoom level is [2,1], then the image is displayed such that at least twice the width is visible, and the height is visible. That will result in the image width being black, divided up on the left and right according to the imageCanvasPoint
Then, if the imagePoint is [1,0] and the canvas point is [1,0], then the right most edge of the image, at the top of the image, will be displayed at the right most edge of the canvas, at the top.
Parameters
• displayArea: DisplayArea
Returns
void
Inherited from
BaseVolumeViewport.setDisplayAreaFit
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1046
setDisplayAreaScale()
protectedsetDisplayAreaScale(displayArea):void
Sets the viewport to pixel scaling mode. Pixel scaling displays 1 image pixel as 1 (or scale) physical screen pixels. That is, a 1024x512 image will be displayed with scale=2, as 2048x1024 physical image pixels.
Parameters
• displayArea: DisplayArea
display area to set
- displayArea.scale - the number of physical pixels to display
each image pixel in. Values
< 1mean smaller than physical, while values> 1mean more than one pixel. Default is 1 Suggest using whole numbers or integer fractions (eg1/3)
Returns
void
Inherited from
BaseVolumeViewport.setDisplayAreaScale
Defined in
packages/core/src/RenderingEngine/Viewport.ts:973
setDisplaySets()
setDisplaySets(...
entries):Promise<void>
Mounts display sets on the viewport, mirroring the GenericViewport
setDisplaySets API. The displaySetId is resolved through the registered
generic-viewport dataset metadata (see genericViewportDisplaySetMetadataProvider)
to its imageIds; a volume is created/cached from them (if not already
present) and loaded via setVolumes. Per-entry options (e.g. callback,
blendMode, slabThickness) are forwarded to the volume input. Resolution
and loading run inside mountDisplaySets, which records the mounted
entries after setVolumes so getDisplaySets reports them.
Parameters
• ...entries: object[]
display set entries to mount; the first provides the volume.
Returns
Promise<void>
Inherited from
BaseVolumeViewport.setDisplaySets
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1530
setFitToCanvasCamera()
protectedsetFitToCanvasCamera(camera):void
Sets the provided camera as the displayArea camera. This allows computing differences applied later as compared to the initial position, for things like zoom and pan.
Parameters
• camera: ICamera<number>
to store as the initial value.
Returns
void
Inherited from
BaseVolumeViewport.setFitToCanvasCamera
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1404
setInitialCamera()
protectedsetInitialCamera(camera):void
Sets the provided camera as the initial camera. This allows computing differences applied later as compared to the initial position, for things like zoom and pan.
Parameters
• camera: ICamera<number>
to store as the initial value.
Returns
void
Inherited from
BaseVolumeViewport.setInitialCamera
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1394
setInterpolationType()
protectedsetInterpolationType(interpolationType,volumeId?):void
Sets the interpolation type. No-op in the base.
Parameters
• interpolationType: InterpolationType
• volumeId?: string
Returns
void
Inherited from
BaseVolumeViewport.setInterpolationType
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:503
setNeedsRender()
setNeedsRender():
void
Mark the viewport as needing a render pass (e.g. after external display-set / segmentation updates). Does not queue a render; the rendering engine’s normal RAF cycle will pick this up.
Returns
void
Inherited from
BaseVolumeViewport.setNeedsRender
Defined in
packages/core/src/RenderingEngine/Viewport.ts:315
setOptions()
setOptions(
options,immediate):void
Sets new options and (TODO) applies them.
Parameters
• options: ViewportInputOptions
The viewport options to set.
• immediate: boolean = false
If true, renders the viewport after the options are set.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:386
setOrientation()
setOrientation(
_orientation,_immediate,_suppressEvents):void
It sets the orientation for the camera, the orientation can be one of the
following: axial, sagittal, coronal, acquisition. Use the Enums.OrientationAxis
to set the orientation. The "acquisition" orientation is the orientation that
the volume was acquired in (scan axis).
Parameters
• _orientation: OrientationAxis | OrientationVectors
• _immediate: boolean = true
• _suppressEvents: boolean = false
Returns
void
Inherited from
BaseVolumeViewport.setOrientation
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1659
setOrientationOfClippingPlanes()
setOrientationOfClippingPlanes(
vtkPlanes,slabThickness,viewPlaneNormal,focalPoint):void
Parameters
• vtkPlanes: vtkPlane[]
• slabThickness: number
• viewPlaneNormal: Point3
• focalPoint: Point3
Returns
void
Inherited from
BaseVolumeViewport.setOrientationOfClippingPlanes
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2002
setPan()
setPan(
pan,storeAsInitialCamera):void
Sets the canvas pan value relative to the initial view position of 0,0 Modifies the camera to perform the pan.
Parameters
• pan: Point2
• storeAsInitialCamera: boolean = false
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1465
setProperties()
setProperties(
VolumeViewportProperties,volumeId?,suppressEvents?):void
Sets the properties for the volume viewport on the volume and if setProperties is called for the first time, the properties will also become the default one. (if fusion, it sets it for the first volume in the fusion)
Parameters
• VolumeViewportProperties: VolumeViewportProperties = {}
The properties to set
• volumeId?: string
The volume id to set the properties for (if undefined, the first volume)
• suppressEvents?: boolean = false
If true, the viewport will not emit events
Returns
void
Inherited from
BaseVolumeViewport.setProperties
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1055
setRendered()
setRendered():
void
Indicate that the image has been rendered. This will set the viewportStatus to RENDERED if there is image data available to actually be rendered - otherwise, the rendering simply showed the background image.
Returns
void
Inherited from
BaseVolumeViewport.setRendered
Defined in
packages/core/src/RenderingEngine/Viewport.ts:301
setRotation()
protectedsetRotation(rotation):void
Parameters
• rotation: number
Returns
void
Inherited from
BaseVolumeViewport.setRotation
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:592
setSampleDistanceMultiplier()
setSampleDistanceMultiplier(
multiplier):void
Parameters
• multiplier: number
Returns
void
Overrides
BaseVolumeViewport.setSampleDistanceMultiplier
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:37
setSlabThickness()
setSlabThickness(
slabThickness,filterActorUIDs?):void
Parameters
• slabThickness: number
• filterActorUIDs?: string[]
Returns
void
Overrides
BaseVolumeViewport.setSlabThickness
Defined in
packages/core/src/RenderingEngine/VolumeViewport3D.ts:123
setViewPlane()
setViewPlane(
planeRestriction):void
Sets the view reference given a referenced plane and the current view plane normal being applied. This will use the existing normal if compatible, otherwise will calculate a new view plane normal as the referenced plane normal, or else the cross product of the existing view plane normal and the inPlaneVector1
Parameters
• planeRestriction: PlaneRestriction
Returns
void
Inherited from
BaseVolumeViewport.setViewPlane
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:844
setViewPresentation()
setViewPresentation(
viewPres):void
Applies the display area, zoom, pan and rotation from the view presentation. No-op is viewPres isn't defined.
Parameters
• viewPres: ViewPresentation
Returns
void
Inherited from
BaseVolumeViewport.setViewPresentation
Defined in
packages/core/src/RenderingEngine/Viewport.ts:2345
setViewReference()
setViewReference(
viewRef):void
Navigates to the specified view reference.
Parameters
• viewRef: ViewReference
Returns
void
Inherited from
BaseVolumeViewport.setViewReference
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:869
setVolumes()
setVolumes(
volumeInputArray,immediate,suppressEvents):Promise<void>
Creates volume actors for all volumes defined in the volumeInputArray.
For each entry, if a callback is supplied, it will be called with the new volume actor as input.
For each entry, if a blendMode and/or slabThickness is defined, this will be set on the actor's
VolumeMapper.
Parameters
• volumeInputArray: IVolumeInput[]
The array of VolumeInputs which define the volumes to add.
• immediate: boolean = false
Whether the Viewport should be rendered as soon as volumes are added.
• suppressEvents: boolean = false
Returns
Promise<void>
Inherited from
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1447
setZoom()
setZoom(
value,storeAsInitialCamera):void
Zooms the image using parallel scale by updating the camera value.
Parameters
• value: number
The relative parallel scale to apply. It is relative to the initial offsets value, at the aspect ratio that the camera holds.
• storeAsInitialCamera: boolean = false
can be set to true to reset the camera after applying this zoom as the initial camera. A subsequent getZoom call will return "1", but the zoom will have been applied.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1569
shouldUseCustomRenderPass()
protectedshouldUseCustomRenderPass():boolean
Check if custom render passes should be used for this viewport.
Returns
boolean
True if custom render passes should be used, false otherwise
Inherited from
BaseVolumeViewport.shouldUseCustomRenderPass
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1156
triggerCameraModifiedEventIfNecessary()
triggerCameraModifiedEventIfNecessary(
previousCamera,updatedCamera):void
Trigger camera modified event
Parameters
• previousCamera: ICamera<number>
• updatedCamera: ICamera<number>
Returns
void
Inherited from
BaseVolumeViewport.triggerCameraModifiedEventIfNecessary
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1924
updateCameraClippingPlanesAndRange()
updateCameraClippingPlanesAndRange():
void
Updates the camera's clipping planes and range.
Returns
void
Inherited from
BaseVolumeViewport.updateCameraClippingPlanesAndRange
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1944
updateClippingPlanesForActors()
protectedupdateClippingPlanesForActors(updatedCamera):Promise<void>
Updates the actors clipping planes orientation from the camera properties
Parameters
• updatedCamera: ICamera<number>
ICamera
Returns
Promise<void>
Inherited from
BaseVolumeViewport.updateClippingPlanesForActors
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1954
worldToCanvasContextPool()
worldToCanvasContextPool(
worldPos):Point2
Parameters
• worldPos: Point3
Returns
Inherited from
BaseVolumeViewport.worldToCanvasContextPool
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2169
worldToCanvasTiled()
worldToCanvasTiled(
worldPos):Point2
Returns the canvas coordinates of the given worldPos
projected onto the Viewport's canvas.
Parameters
• worldPos: Point3
The position in world coordinates.
Returns
The corresponding canvas coordinates.
Inherited from
BaseVolumeViewport.worldToCanvasTiled
Defined in
packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2112
boundsRadius()
staticboundsRadius(bounds):number
Computes the bounds radius value
Parameters
• bounds: number[]
Returns
number
Inherited from
BaseVolumeViewport.boundsRadius