Skip to main content

Type Alias: IVolumeInput

IVolumeInput: object

VolumeInput that can be used to add a volume to a viewport. It includes mandatory volumeId but other options such as visibility, blendMode, slabThickness and callback can also be provided

Index Signature​

[key: string]: unknown

Type declaration​

actorUID?​

optional actorUID: string

blendMode?​

optional blendMode: BlendModes

Blend mode of the volume - by default it is additive

callback?​

optional callback: VolumeInputCallback

Callback to be called when the volume is added to the viewport

slabThickness?​

optional slabThickness: number

Slab thickness of the volume - by default it is 0.05

visibility?​

optional visibility: boolean

Visibility of the volume - by default it is true

volumeId​

volumeId: string

Volume ID of the volume in the cache

Defined in​

packages/core/src/types/IVolumeInput.ts:20