Class: VideoViewport
An object representing a single stack viewport, which is a camera
looking into an internal scene, and an associated target output canvas.
Extends
Constructors
new VideoViewport()
new VideoViewport(
props):VideoViewport
Parameters
• props: VideoViewportInput
Returns
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:122
Properties
_actors
_actors:
Map<string,ActorEntry>
a Map containing the actor uid and actors
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:117
_suppressCameraModifiedEvents
_suppressCameraModifiedEvents:
boolean=false
informs if a new actor was added before a resetCameraClippingRange phase
Inherited from
Viewport._suppressCameraModifiedEvents
Defined in
packages/core/src/RenderingEngine/Viewport.ts:123
calibration
protectedcalibration:IImageCalibration
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:127
canvas
readonlycanvas:HTMLCanvasElement
an internal canvas that is created on the provided HTML element
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:90
canvasContext
readonlycanvasContext:CanvasRenderingContext2D
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:60
defaultOptions
readonlydefaultOptions:ViewportInputOptions
Default options for the viewport which includes orientation, viewPlaneNormal and backgroundColor
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:119
element
readonlyelement:HTMLDivElement
HTML element in DOM that is used for rendering the viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:88
fitToCanvasCamera
protectedfitToCanvasCamera:ICamera
The camera that is defined for resetting displayArea to ensure absolute displayArea settings
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:135
flipHorizontal
protectedflipHorizontal:boolean=false
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:100
flipVertical
protectedflipVertical:boolean=false
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:101
hasPixelSpacing
protectedhasPixelSpacing:boolean=true
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:126
id
readonlyid:string
unique identifier for the viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:86
imageId
protectedimageId:string
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:57
initialCamera
protectedinitialCamera:ICamera
The camera that is initially defined on the reset for the relative pan/zoom
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:131
insetImageMultiplier
protectedinsetImageMultiplier:number=1.1
The amount by which the images are inset in a viewport by default.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:98
isDisabled
isDisabled:
boolean
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:102
metadata
protectedmetadata:any
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:84
modality
modality:
any
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:55
options
options:
ViewportInputOptions
options for the viewport which includes orientation axis, backgroundColor and displayArea
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:121
renderingEngineId
readonlyrenderingEngineId:string
RenderingEngine id that the viewport belongs to
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:59
sHeight
sHeight:
number
sHeight of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:115
suppressEvents
readonlysuppressEvents:boolean
A flag representing if viewport methods should fire events or not
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:125
sWidth
sWidth:
number
sWidth of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:113
sx
sx:
number
sx of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:109
sy
sy:
number
sy of viewport on the offscreen canvas
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:111
type
readonlytype:ViewportType
Type of viewport
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:94
uid
readonlyuid:any
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:58
updateRenderingPipeline()
updateRenderingPipeline: () =>
void
Returns
void
Inherited from
Viewport.updateRenderingPipeline
Defined in
packages/core/src/RenderingEngine/Viewport.ts:170
useCustomRenderingPipeline
useCustomRenderingPipeline:
boolean=true
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:652
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:106
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
Viewport.CameraViewPresentation
Defined in
packages/core/src/RenderingEngine/Viewport.ts:67
frameRangeExtractor
staticframeRangeExtractor:RegExp
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:53
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
Viewport.TransferViewPresentation
Defined in
packages/core/src/RenderingEngine/Viewport.ts:80
Accessors
useCustomRenderingPipeline
getstaticuseCustomRenderingPipeline():boolean
Returns
boolean
Overrides
Viewport.useCustomRenderingPipeline
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:146
Methods
_getCorners()
_getCorners(
bounds):number[][]
Parameters
• bounds: number[]
Returns
number[][]
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1788
_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:1884
_getFocalPointForResetCamera()
_getFocalPointForResetCamera(
centeredFocalPoint,previousCamera,__namedParameters):Point3
Parameters
• centeredFocalPoint: Point3
• previousCamera: ICamera
• __namedParameters
• __namedParameters.resetPan: boolean = true
• __namedParameters.resetToCenter: boolean = true
Returns
Inherited from
Viewport._getFocalPointForResetCamera
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1801
_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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1861
_removeActor()
_removeActor(
actorUID):void
Remove the actor from the viewport
Parameters
• actorUID: string
The unique identifier for the actor.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:510
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:573
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:537
addImages()
addImages(
stackInputs):void
Parameters
• stackInputs: IStackInput[]
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1130
addWidget()
addWidget(
widgetId,widget):void
Parameters
• widgetId: any
• widget: any
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:183
canvasToIndex()
protectedcanvasToIndex(canvasPos):Point2
Uses the transform to convert canvas coordinates into index coordinates.
Parameters
• canvasPos: Point2
Returns
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1025
canvasToWorld()
canvasToWorld(
canvasPos,destPos):Point3
Converts a VideoViewport canvas coordinate to a video coordinate.
Parameters
• canvasPos: Point2
to convert to world
• destPos: Point3 = ...
Returns
World position
Overrides
Viewport.canvasToWorld
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:969
createActorMapper()
protectedcreateActorMapper(image):CanvasActor
Parameters
• image: any
Returns
CanvasActor
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1150
customRenderViewportToCanvas()
customRenderViewportToCanvas():
void
Returns
void
Overrides
Viewport.customRenderViewportToCanvas
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1080
end()
end():
Promise<void>
Returns
Promise<void>
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:406
flip()
protectedflip(flipOptions):void
Flip the viewport on horizontal or vertical axis, this method works with vtk-js backed rendering pipeline.
Parameters
• flipOptions: FlipDirection
Flip options specifying the axis of flip
- flipOptions.flipHorizontal - Flip the viewport on horizontal axis
- flipOptions.flipVertical - Flip the viewport on vertical axis
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:314
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:470
getActorByIndex()
getActorByIndex(
index):ActorEntry
Get an actor by its index
Parameters
• index: number
array index.
Returns
actorUID
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:491
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:453
getActorUIDByIndex()
getActorUIDByIndex(
index):string
Get an actor UID by its index
Parameters
• index: number
array index.
Returns
string
actorUID
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:479
getActorUIDs()
getActorUIDs():
string[]
Returns an array of unique identifiers for all the actors in the viewport.
Returns
string[]
An array of strings
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:461
getCamera()
getCamera():
ICamera
Get the camera's current state
Returns
The camera object.
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:894
getCameraNoRotation()
protectedgetCameraNoRotation():ICamera
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1282
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:1268
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
Viewport.getClippingPlanesForActor
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1574
getCurrentImageId()
getCurrentImageId():
string
This function returns the imageID associated with either the current
frame being displayed, or the range of frames being played. This may not
correspond to any particular imageId that has imageId metadata, as the
format is one of:
<DICOMweb URI>/frames/<Start Frame>(-<End Frame>)?
or
<Other URI>[?&]frameNumber=<Start Frame>(-<EndFrame>)?
for a URL parameter.
Returns
string
an imageID for video
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:773
getCurrentImageIdIndex()
getCurrentImageIdIndex():
number
Returns
number
Overrides
Viewport.getCurrentImageIdIndex
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:886
getDefaultActor()
getDefaultActor():
ActorEntry
Get the default actor
Returns
An actor entry.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:445
getDisplayArea()
getDisplayArea():
DisplayArea
Returns
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:896
getFrameNumber()
getFrameNumber():
number
Gets the 1 based frame number (ala DICOM value), eg 1+ currentImageIdIndex
Returns
number
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:881
getFrameOfReferenceUID()
getFrameOfReferenceUID():
string
Returns
string
Overrides
Viewport.getFrameOfReferenceUID
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:940
getFrameRange()
getFrameRange(): [
number,number]
Returns
[number, number]
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:476
getFrameRate()
getFrameRate():
number
Returns
number
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:936
getImageData()
getImageData():
IImageData|CPUIImageData
Returns
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:574
getImageDataMetadata()
getImageDataMetadata(
image):object
Parameters
• image: string | IImage
Returns
object
bitsAllocated
bitsAllocated:
number=8
columns
columns:
any
dimensions
dimensions:
any[]
direction
direction:
number[]
hasPixelSpacing
hasPixelSpacing:
boolean
imagePlaneModule
imagePlaneModule:
any
numberOfComponents
numberOfComponents:
number=3
numVoxels
numVoxels:
number
origin
origin:
any
rows
rows:
any
spacing
spacing:
any[]
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:169
getImageIds()
getImageIds():
string[]
Gets all the image ids associated with this video element. This will have # of frames elements.
Returns
string[]
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:325
getMiddleSliceData()
getMiddleSliceData():
never
Returns
never
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:648
getNumberOfSlices()
getNumberOfSlices():
number
Returns
number
Overrides
Viewport.getNumberOfSlices
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:929
getPan()
getPan():
Point2
Helper function to return the current canvas pan value.
Returns
a Point2 containing the current pan values on the canvas, computed from the current camera, where the initial pan value is [0,0].
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1015
getProperties()
getProperties():
VideoViewportProperties
Returns
Overrides
Viewport.getProperties
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:526
getRenderer()
getRenderer():
vtkRenderer
Returns the vtkRenderer responsible for rendering the Viewport.
Returns
vtkRenderer
The vtkRenderer for the Viewport.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:241
getRenderingEngine()
getRenderingEngine():
RenderingEngine
Returns the rendering engine driving the Viewport.
Returns
The RenderingEngine instance.
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:232
getRotation()
getRotation():
number
Returns
number
Overrides
Viewport.getRotation
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1020
getScalarData()
protectedgetScalarData():CanvasScalarData
Returns
CanvasScalarData
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:543
getSliceIndex()
getSliceIndex():
number
Returns
number
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:890
getSliceViewInfo()
getSliceViewInfo():
object
Returns
object
height
height:
number
indexToSliceMatrix
indexToSliceMatrix:
mat4
sliceIndex
sliceIndex:
number
slicePlane
slicePlane:
number
sliceToIndexMatrix
sliceToIndexMatrix:
mat4
width
width:
number
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:442
getTransform()
protectedgetTransform():Transform
Creates a transform from video index coordinates to canvas coordinates.
Returns
Transform
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1087
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1731
getViewReference()
getViewReference(
viewRefSpecifier?):ViewReference
Gets a view target that species what type of view is required to show the current view, or the one specified in the forTarget modifiers.
Parameters
• viewRefSpecifier?: ViewReferenceSpecifier
Returns
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:862
getViewReferenceId()
getViewReferenceId(
specifier):string
Gets a target id that can be used to specify how to show this
Parameters
• specifier: ViewReferenceSpecifier = {}
Returns
string
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:786
getVtkActiveCamera()
protectedgetVtkActiveCamera():vtkSlabCamera|vtkCamera
Gets the active vtkCamera for the viewport.
Returns
vtkSlabCamera | vtkCamera
vtk driven camera
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1276
getWidget()
getWidget(
id):any
Parameters
• id: any
Returns
any
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:187
getWidgets()
getWidgets():
any[]
Returns
any[]
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:191
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.
Parameters
• compareCamera: ICamera = ...
Returns
number
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1192
hasImageURI()
hasImageURI(
imageURI):boolean
Checks to see if the imageURI is currently being displayed. The imageURI may contain frame numbers according to the DICOM standard format, which will be stripped to compare the base image URI, and then the values used to check if that frame is currently being displayed.
The DICOM standard allows for comma separated values as well, however, this is not supported here, with only a single range or single value being tested.
For a single value, the time range +/- 5 frames is permitted to allow the detection to actually succeed when nearby without requiring an exact time frame to be matched.
Parameters
• imageURI: string
containing frame number or range.
Returns
boolean
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:671
indexToCanvas()
protectedindexToCanvas(indexPos):Point2
Parameters
• indexPos: Point2
Returns
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1034
isReferenceViewable()
isReferenceViewable(
viewRef,options):boolean
Figure out if a given view can be shown in the current viewport.
Parameters
• viewRef: ViewReference
• options: ReferenceCompatibleOptions = {}
Returns
boolean
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:807
pause()
pause():
void
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:358
play()
play():
Promise<void>
Returns
Promise<void>
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:344
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:525
removeAllActors()
removeAllActors():
void
Remove all actors from the renderer
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:605
removeWidgets()
removeWidgets():
void
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:195
render()
render():
void
Renders the Viewport using the RenderingEngine.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:254
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:284
resetCamera()
resetCamera():
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.
Returns
boolean
boolean
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:917
resetCameraNoEvent()
protectedresetCameraNoEvent():void
Reset the camera to the default viewport camera without firing events
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:614
resetProperties()
resetProperties():
void
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:536
resize()
resize():
void
Returns
void
Overrides
Viewport.resize
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:945
scroll()
scroll(
delta):Promise<void>
Parameters
• delta: number = 1
Returns
Promise<void>
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:367
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:499
setAverageWhite()
setAverageWhite(
averageWhite):void
Parameters
• averageWhite: [number, number, number]
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:692
setCamera()
setCamera(
camera):void
Set the camera parameters
Parameters
• camera: ICamera
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:723
setCameraNoEvent()
protectedsetCameraNoEvent(camera):void
Sets the camera to the default viewport camera without firing events
Parameters
• camera: ICamera
The camera to use for the viewport.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:624
setColorTransform()
protectedsetColorTransform():void
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:697
setDataIds()
setDataIds(
imageIds,options?):void
This is a wrapper for setVideo to allow generic behaviour
Parameters
• imageIds: string[]
a singleton list containing the imageId of a video.
• options?: ImageSetOptions
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:233
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:693
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:830
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:757
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
to store as the initial value.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1097
setFrameNumber()
setFrameNumber(
frame):Promise<void>
Parameters
• frame: number
Returns
Promise<void>
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:454
setFrameRange()
setFrameRange(
frameRange):void
Sets the playback frame range. The video will play over the given set of frames (assuming it is playing).
Parameters
• frameRange: number[]
the minimum to maximum (inclusive) frames to play over
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:465
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
to store as the initial value.
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1087
setInterpolationType()
protectedsetInterpolationType(_interpolationType,_arg?):void
Sets the interpolation type. No-op in the base.
Parameters
• _interpolationType: InterpolationType
• _arg?: any
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:681
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:266
setOrientationOfClippingPlanes()
setOrientationOfClippingPlanes(
vtkPlanes,slabThickness,viewPlaneNormal,focalPoint):void
Parameters
• vtkPlanes: vtkPlane[]
• slabThickness: number
• viewPlaneNormal: Point3
• focalPoint: Point3
Returns
void
Inherited from
Viewport.setOrientationOfClippingPlanes
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1537
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:1158
setPlaybackRate()
setPlaybackRate(
rate):void
Parameters
• rate: number = 1
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:502
setProperties()
setProperties(
props):void
Parameters
• props: VideoViewportProperties
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:480
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:217
setRotation()
protectedsetRotation(_rotation):void
Parameters
• _rotation: number
Returns
void
Inherited from
Defined in
packages/core/src/RenderingEngine/Viewport.ts:172
setScrollSpeed()
setScrollSpeed(
scrollSpeed,unit):void
Parameters
• scrollSpeed: number = 1
• unit: SpeedUnit = VideoViewportEnum.SpeedUnit.FRAME
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:516
setTime()
setTime(
timeInSeconds):Promise<void>
Parameters
• timeInSeconds: number
Returns
Promise<void>
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:424
setVideo()
setVideo(
imageId,frameNumber?):Promise<unknown>
Sets the video image id to show and hte frame number. Requirements are to have the imageUrlModule in the metadata with the rendered endpoint being the raw video in video/mp4 format.
Parameters
• imageId: string
• frameNumber?: number
Returns
Promise<unknown>
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:245
setVideoURL()
setVideoURL(
videoURL):Promise<unknown>
Parameters
• videoURL: string
Returns
Promise<unknown>
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:296
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
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1771
setViewReference()
setViewReference(
viewRef):void
Navigates the video to the specific view reference
Parameters
• viewRef: ViewReference
Returns
void
Overrides
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:850
setVOI()
setVOI(
voiRange):void
Parameters
• voiRange: VOIRange
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:680
setWindowLevel()
setWindowLevel(
windowWidth,windowCenter):void
Parameters
• windowWidth: number = 256
• windowCenter: number = 128
Returns
void
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:685
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.
• 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:1209
start()
start():
Promise<void>
Returns
Promise<void>
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:388
togglePlayPause()
togglePlayPause():
boolean
Returns
boolean
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:334
triggerCameraModifiedEventIfNecessary()
triggerCameraModifiedEventIfNecessary(
previousCamera,updatedCamera):void
Trigger camera modified event
Parameters
• previousCamera: ICamera
• updatedCamera: ICamera
Returns
void
Inherited from
Viewport.triggerCameraModifiedEventIfNecessary
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1459
updateCameraClippingPlanesAndRange()
updateCameraClippingPlanesAndRange():
void
Nothing to do for the clipping planes for video as they don't exist.
Returns
void
Overrides
Viewport.updateCameraClippingPlanesAndRange
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1126
updateClippingPlanesForActors()
protectedupdateClippingPlanesForActors(updatedCamera):Promise<void>
Updates the actors clipping planes orientation from the camera properties
Parameters
• updatedCamera: ICamera
ICamera
Returns
Promise<void>
Inherited from
Viewport.updateClippingPlanesForActors
Defined in
packages/core/src/RenderingEngine/Viewport.ts:1489
worldToCanvas()
worldToCanvas(
worldPos):Point2
Converts [x, y, 0] world video coordinate to canvas CSS coordinates.
Parameters
• worldPos: Point3
world coord to convert to canvas
Returns
Canvas position
Overrides
Viewport.worldToCanvas
Defined in
packages/core/src/RenderingEngine/VideoViewport.ts:1003
boundsRadius()
staticboundsRadius(bounds):number
Computes the bounds radius value
Parameters
• bounds: number[]
Returns
number