Skip to main content

Class: RenderingEngine

Constructors

new RenderingEngine()

new RenderingEngine(id?): RenderingEngine

Parameters

id?: string

Returns

RenderingEngine

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:22

Properties

hasBeenDestroyed

hasBeenDestroyed: boolean

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:16


offscreenMultiRenderWindow

offscreenMultiRenderWindow: VtkOffscreenMultiRenderWindow

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:19

Accessors

id

get id(): string

Returns

string

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:42

Methods

destroy()

destroy(): void

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:100


disableElement()

disableElement(viewportId): void

Parameters

viewportId: string

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:54


disableViewport()

disableViewport(viewportId): void

Parameters

viewportId: string

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:46


enableElement()

enableElement(viewportInputEntry): void

Parameters

viewportInputEntry: PublicViewportInput

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:50


fillCanvasWithBackgroundColor()

fillCanvasWithBackgroundColor(canvas, backgroundColor): void

Parameters

canvas: HTMLCanvasElement

backgroundColor: [number, number, number]

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:78


getOffscreenMultiRenderWindow()

getOffscreenMultiRenderWindow(viewportId?): VtkOffscreenMultiRenderWindow

Parameters

viewportId?: string

Returns

VtkOffscreenMultiRenderWindow

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:104


getRenderer()

getRenderer(viewportId): vtkRenderer

Parameters

viewportId: string

Returns

vtkRenderer

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:74


getViewport()

getViewport<T>(viewportId): T

Type Parameters

T = Viewport

Parameters

viewportId: string

Returns

T

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:66


getViewports()

getViewports(): Viewport[]

Returns

Viewport[]

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:70


render()

render(): void

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:88


renderViewport()

renderViewport(viewportId): void

Parameters

viewportId: string

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:96


renderViewports()

renderViewports(viewportIds): void

Parameters

viewportIds: string[]

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:92


resize()

resize(immediate, keepCamera): void

Parameters

immediate: boolean = true

keepCamera: boolean = true

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:62


setViewports()

setViewports(publicViewportInputEntries): void

Parameters

publicViewportInputEntries: PublicViewportInput[]

Returns

void

Defined in

packages/core/src/RenderingEngine/RenderingEngine.ts:58