Function: addVolumesToViewports()
addVolumesToViewports(
renderingEngine
,volumeInputs
,viewportIds
,immediateRender
,suppressEvents
):Promise
<void
>
For each provided viewport it adds a volume to the viewport using the provided renderingEngine
Parameters
• renderingEngine: RenderingEngine
The rendering engine to use to get viewports from
• volumeInputs: IVolumeInput
[]
Array of volume inputs including volumeId. Other properties such as visibility, callback, blendMode, slabThickness are optional
• viewportIds: string
[]
Array of viewport IDs to add the volume to
• immediateRender: boolean
= false
If true, the volumes will be rendered immediately
• suppressEvents: boolean
= false
Returns
Promise
<void
>
A promise that resolves when all volumes have been added
Defined in
packages/core/src/RenderingEngine/helpers/addVolumesToViewports.ts:20