Variable: renderingEngineExportsV2

const renderingEngineExportsV2: object

Type declaration

createDefaultECGRenderPaths()

createDefaultECGRenderPaths: () => RenderPathDefinition[]

Returns

RenderPathDefinition[]

createDefaultPlanarRenderPaths()

createDefaultPlanarRenderPaths: () => RenderPathDefinition[]

Returns

RenderPathDefinition[]

createDefaultVideoRenderPaths()

createDefaultVideoRenderPaths: () => RenderPathDefinition[]

Returns

RenderPathDefinition[]

createDefaultVolume3DRenderPaths()

createDefaultVolume3DRenderPaths: () => RenderPathDefinition[]

Returns

RenderPathDefinition[]

createDefaultWSIRenderPaths()

createDefaultWSIRenderPaths: () => RenderPathDefinition[]

Returns

RenderPathDefinition[]

createECGRenderPathResolver()

createECGRenderPathResolver: (paths) => DefaultRenderPathResolver

Parameters

• paths: readonly RenderPathDefinition<BaseViewportRenderContext, BaseViewportRenderContext>[] = ...

Returns

DefaultRenderPathResolver

createPlanarRenderPathResolver()

createPlanarRenderPathResolver: (paths) => DefaultRenderPathResolver

Parameters

• paths: readonly RenderPathDefinition<BaseViewportRenderContext, BaseViewportRenderContext>[] = ...

Returns

DefaultRenderPathResolver

createVideoRenderPathResolver()

createVideoRenderPathResolver: (paths) => DefaultRenderPathResolver

Parameters

• paths: readonly RenderPathDefinition<BaseViewportRenderContext, BaseViewportRenderContext>[] = ...

Returns

DefaultRenderPathResolver

createVolume3DRenderPathResolver()

createVolume3DRenderPathResolver: (paths) => DefaultRenderPathResolver

Parameters

• paths: readonly RenderPathDefinition<BaseViewportRenderContext, BaseViewportRenderContext>[] = ...

Returns

DefaultRenderPathResolver

createWSIRenderPathResolver()

createWSIRenderPathResolver: (paths) => DefaultRenderPathResolver

Parameters

• paths: readonly RenderPathDefinition<BaseViewportRenderContext, BaseViewportRenderContext>[] = ...

Returns

DefaultRenderPathResolver

DefaultECGDataProvider

DefaultECGDataProvider: typeof DefaultECGDataProvider

DefaultPlanarDataProvider

DefaultPlanarDataProvider: typeof DefaultPlanarDataProvider

defaultRenderPathResolver

defaultRenderPathResolver: DefaultRenderPathResolver

DefaultRenderPathResolver

DefaultRenderPathResolver: typeof DefaultRenderPathResolver

DefaultVideoDataProvider

DefaultVideoDataProvider: typeof DefaultVideoDataProvider

DefaultVolume3DDataProvider

DefaultVolume3DDataProvider: typeof DefaultVolume3DDataProvider

DefaultWSIDataProvider

DefaultWSIDataProvider: typeof DefaultWSIDataProvider

ECGGenericViewport

ECGGenericViewport: typeof ECGGenericViewport

ecgProjection

ecgProjection: object

ecgProjection.adapter

adapter: ViewportProjectionAdapter<ECGViewState, ViewPresentation, ECGProjectionSnapshot> = ecgProjectionAdapter

ecgProjection.getSnapshot()

getSnapshot: (request) => ECGProjectionSnapshot | undefined = getECGProjectionSnapshot

Builds the signal-space ECG projection snapshot for a viewport-like object.

Parameters

• request: ECGProjectionRequest

Returns

ECGProjectionSnapshot | undefined

GenericViewport

GenericViewport: typeof GenericViewport

planarProjection

planarProjection: object

planarProjection.adapter

adapter: ViewportProjectionAdapter<PlanarViewState, PlanarViewPresentation, PlanarProjectionSnapshot> = planarProjectionAdapter

planarProjection.applyToRenderer()

applyToRenderer: (args) => PlanarResolvedICamera | undefined = applyPlanarICameraToRenderer

Experimental

Pushes a resolved ICamera onto a vtkRenderer's active camera. Returns the applied camera, or undefined if the camera was incomplete.

Exposed for custom synchronizers and tooling. Less stable than the core viewport API; signatures may change before 3.0 stable. Prefer the planarProjection namespace re-export over importing directly.

Parameters

• args

• args.activeSourceICamera?: PlanarResolvedICamera

The resolved ICamera to apply.

• args.renderer: vtkRenderer

The VTK renderer whose camera will be updated.

Returns

PlanarResolvedICamera | undefined

The applied ICamera, or undefined if required fields were missing.

planarProjection.createImageSliceBasis()

createImageSliceBasis: (args) => PlanarSliceBasis = createPlanarImageSliceBasis

Parameters

• args

• args.canvasHeight: number

• args.canvasWidth: number

• args.image: IImage

Returns

PlanarSliceBasis

planarProjection.createVolumeSliceBasis()

createVolumeSliceBasis: (args) => object = createPlanarVolumeSliceBasis

Parameters

• args

• args.canvasHeight: number

• args.canvasWidth: number

• args.imageIdIndex?: number

• args.imageVolume: ImageVolume

• args.orientation?: PlanarOrientation

• args.viewState?: PlanarViewState

Returns

object

currentImageIdIndex

currentImageIdIndex: number

maxImageIdIndex

maxImageIdIndex: number

sliceBasis

sliceBasis: PlanarSliceBasis

planarProjection.derivePresentation()

derivePresentation: (args) => DerivedPlanarPresentation = derivePlanarPresentation

Experimental

Derives canvas-space presentation values (pan, zoom, rotation) from a semantic PlanarViewState and a PlanarSliceBasis.

Pan is computed in two parts:

1. panFromAnchorWorld — the offset caused by the anchor point being away from sliceCenterWorld, projected into canvas pixels.
2. panFromAnchorCanvas — the offset caused by the anchor being placed at a non-center canvas location (e.g. zoom-to-cursor).

Exposed for custom synchronizers and tooling. Less stable than the core viewport API; signatures may change before 3.0 stable. Prefer the planarProjection namespace re-export over importing directly.

Parameters

• args

• args.camera?: PlanarViewState

The semantic camera (may be undefined for defaults).

• args.canvasHeight: number

Current canvas height in CSS pixels.

• args.canvasWidth: number

Current canvas width in CSS pixels.

• args.sliceBasis: PlanarSliceBasis

The geometric basis for the current slice.

Returns

DerivedPlanarPresentation

Derived pan (pixels), zoom (scale factor), and rotation (degrees).

planarProjection.getPan()

getPan: (snapshot) => Point2 = getPlanarProjectionPan

Reads raw canvas-space pan from a projection snapshot.

Parameters

• snapshot: PlanarProjectionSnapshot

Returns

Point2

planarProjection.getScale()

getScale: (snapshot) => Point2 = getPlanarProjectionScale

Reads the native two-axis Planar scale from a projection snapshot.

Parameters

• snapshot: PlanarProjectionSnapshot

Returns

Point2

planarProjection.getSnapshot()

getSnapshot: (request) => PlanarProjectionSnapshot | undefined = getPlanarProjectionSnapshot

Builds the capability-based Planar projection snapshot for a viewport-like object or an explicit view-state request.

Parameters

• request: PlanarProjectionRequest

Returns

PlanarProjectionSnapshot | undefined

planarProjection.getZoom()

getZoom: (snapshot) => number = getPlanarProjectionZoom

Reads the legacy uniform zoom value from a Planar projection snapshot.

Parameters

• snapshot: PlanarProjectionSnapshot

Returns

number

planarProjection.resolveICamera()

resolveICamera: (args) => PlanarResolvedICamera = resolvePlanarICamera

Experimental

Produces a complete ICamera from a PlanarSliceBasis and an optional PlanarViewState. This is the main entry point for VTK-based render paths that need to set up a vtkRenderer camera.

The pipeline:

1. derivePlanarPresentation extracts pan/zoom/rotation.
2. getResolvedPanOffset converts canvas-space pan back to world offset.
3. focalPoint = sliceCenterWorld - worldOffset.
4. position = focalPoint + viewPlaneNormal * cameraDistance.

Exposed for custom synchronizers and tooling. Less stable than the core viewport API; signatures may change before 3.0 stable. Prefer the planarProjection namespace re-export over importing directly.

Parameters

• args

• args.camera?: PlanarViewState

The semantic camera (may be undefined for defaults).

• args.canvasHeight: number

Current canvas height in CSS pixels.

• args.canvasWidth: number

Current canvas width in CSS pixels.

• args.sliceBasis: PlanarSliceBasis

The geometric basis for the current slice.

Returns

PlanarResolvedICamera

A fully resolved ICamera ready for a VTK renderer.

PlanarViewport

PlanarViewport: typeof PlanarViewport

VideoGenericViewport

VideoGenericViewport: typeof VideoGenericViewport

videoProjection

videoProjection: object

videoProjection.adapter

adapter: ViewportProjectionAdapter<VideoViewState, ViewPresentation, VideoProjectionSnapshot> = videoProjectionAdapter

videoProjection.getSnapshot()

getSnapshot: (request) => VideoProjectionSnapshot | undefined = getVideoProjectionSnapshot

Builds the media-space Video projection snapshot for a viewport-like object.

Parameters

• request: VideoProjectionRequest

Returns

VideoProjectionSnapshot | undefined

volume3DProjection

volume3DProjection: object

volume3DProjection.adapter

adapter: ViewportProjectionAdapter<Volume3DCamera, Volume3DProjectionPresentation, Volume3DProjectionSnapshot> = volume3DProjectionAdapter

volume3DProjection.getSnapshot()

getSnapshot: (request) => Volume3DProjectionSnapshot | undefined = getVolume3DProjectionSnapshot

Builds the capability-based Volume3D projection snapshot for a viewport-like object or explicit 3D camera request.

Parameters

• request: Volume3DProjectionRequest

Returns

Volume3DProjectionSnapshot | undefined

VolumeViewport3D

VolumeViewport3D: typeof GenericVolumeViewport3D = GenericVolumeViewport3D

WSIGenericViewport

WSIGenericViewport: typeof WSIGenericViewport

wsiProjection

wsiProjection: object

wsiProjection.adapter

adapter: ViewportProjectionAdapter<WSIViewState, ViewPresentation, WSIProjectionSnapshot> = wsiProjectionAdapter

wsiProjection.getSnapshot()

getSnapshot: (request) => WSIProjectionSnapshot | undefined = getWSIProjectionSnapshot

Builds the WSI projection snapshot for a viewport-like object.

Parameters

• request: WSIProjectionRequest

Returns

WSIProjectionSnapshot | undefined

Defined in

packages/core/src/index.ts:211