Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 | 428x 428x 428x 428x 428x 340x 340x 8x 340x 340x 340x 340x 340x 702x 702x 702x 702x 488x 488x 702x 702x 702x 702x 702x 702x 488x 214x 210x 4x 4x 702x 702x 702x 702x 96x 96x 362x 96x 362x 362x 362x 362x 96x 362x 362x 362x 362x 428x 4709x 4709x 4709x 14011x 4709x 4709x 8264x 8264x 8264x 8264x 4709x 4709x 4709x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 19466x 8264x 8264x 8264x 19466x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 7778x 486x 486x 486x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 8264x 29195x 29195x 8264x 590716x 590716x 590716x 590716x | import BaseRenderingEngine, { VIEWPORT_MIN_SIZE } from './BaseRenderingEngine';
import WebGLContextPool from './WebGLContextPool';
import { getConfiguration } from '../init';
import Events from '../enums/Events';
import eventTarget from '../eventTarget';
import triggerEvent from '../utilities/triggerEvent';
import ViewportType from '../enums/ViewportType';
import VolumeViewport from './VolumeViewport';
import StackViewport from './StackViewport';
import VolumeViewport3D from './VolumeViewport3D';
import viewportTypeUsesCustomRenderingPipeline from './helpers/viewportTypeUsesCustomRenderingPipeline';
import getOrCreateCanvas from './helpers/getOrCreateCanvas';
import type IStackViewport from '../types/IStackViewport';
import type IVolumeViewport from '../types/IVolumeViewport';
import type * as EventTypes from '../types/EventTypes';
import type {
ViewportInput,
InternalViewportInput,
NormalizedViewportInput,
IViewport,
} from '../types/IViewport';
import type vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
import type { VtkOffscreenMultiRenderWindow } from '../types';
/**
* ContextPoolRenderingEngine extends BaseRenderingEngine to provide parallel rendering
* capabilities using multiple WebGL contexts for improved performance.
*
* @public
*/
class ContextPoolRenderingEngine extends BaseRenderingEngine {
private contextPool: WebGLContextPool;
constructor(id?: string) {
super(id);
const { rendering } = getConfiguration();
const { webGlContextCount } = rendering;
Eif (!this.useCPURendering) {
this.contextPool = new WebGLContextPool(webGlContextCount);
}
}
/**
* Enables a viewport to be driven by the offscreen vtk.js rendering engine.
*
* @param viewportInputEntry - Information object used to
* construct and enable the viewport.
*/
protected enableVTKjsDrivenViewport(
viewportInputEntry: NormalizedViewportInput
) {
const viewports = this._getViewportsAsArray();
const viewportsDrivenByVtkJs = viewports.filter(
(vp) => viewportTypeUsesCustomRenderingPipeline(vp.type) === false
);
const canvasesDrivenByVtkJs = viewportsDrivenByVtkJs.map((vp) => vp.canvas);
const canvas = getOrCreateCanvas(viewportInputEntry.element);
canvasesDrivenByVtkJs.push(canvas);
const internalViewportEntry = { ...viewportInputEntry, canvas };
this.addVtkjsDrivenViewport(internalViewportEntry);
}
/**
* Adds a viewport driven by vtk.js to the `RenderingEngine`.
*
* @param viewportInputEntry - Information object used to construct and enable the viewport.
*/
protected addVtkjsDrivenViewport(
viewportInputEntry: InternalViewportInput
): void {
const { element, canvas, viewportId, type, defaultOptions } =
viewportInputEntry;
element.tabIndex = -1;
// Assign viewport to a context
// Stack viewports get distributed across contexts, all others use context 0
let contextIndex = 0;
if (type === ViewportType.STACK) {
const contexts = this.contextPool.getAllContexts();
contextIndex = this._viewports.size % contexts.length;
}
this.contextPool.assignViewportToContext(viewportId, contextIndex);
// Get the context and add the renderer
const contextData = this.contextPool.getContextByIndex(contextIndex);
const { context: offscreenMultiRenderWindow } = contextData;
offscreenMultiRenderWindow.addRenderer({
viewport: [0, 0, 1, 1],
id: viewportId,
background: defaultOptions.background
? defaultOptions.background
: [0, 0, 0],
});
const viewportInput = {
id: viewportId,
element,
renderingEngineId: this.id,
type,
canvas,
sx: 0,
sy: 0,
sWidth: canvas.width,
sHeight: canvas.height,
defaultOptions: defaultOptions || {},
} as ViewportInput;
let viewport: IViewport;
if (type === ViewportType.STACK) {
viewport = new StackViewport(viewportInput);
} else if (
type === ViewportType.ORTHOGRAPHIC ||
type === ViewportType.PERSPECTIVE
) {
viewport = new VolumeViewport(viewportInput);
} else if (type === ViewportType.VOLUME_3D) {
viewport = new VolumeViewport3D(viewportInput);
} else E{
throw new Error(`Viewport Type ${type} is not supported`);
}
this._viewports.set(viewportId, viewport);
const eventDetail: EventTypes.ElementEnabledEventDetail = {
element,
viewportId,
renderingEngineId: this.id,
};
Eif (!viewport.suppressEvents) {
triggerEvent(eventTarget, Events.ELEMENT_ENABLED, eventDetail);
}
}
/**
* Sets multiple vtk.js driven viewports to
* the `RenderingEngine`.
*
* @param viewportInputEntries - An array of information
* objects used to construct and enable the viewports.
*/
protected setVtkjsDrivenViewports(
viewportInputEntries: NormalizedViewportInput[]
) {
Eif (viewportInputEntries.length) {
const vtkDrivenCanvases = viewportInputEntries.map((vp) =>
getOrCreateCanvas(vp.element)
);
vtkDrivenCanvases.forEach((canvas) => {
const devicePixelRatio = window.devicePixelRatio || 1;
const rect = canvas.getBoundingClientRect();
canvas.width = rect.width * devicePixelRatio;
canvas.height = rect.height * devicePixelRatio;
});
for (let i = 0; i < viewportInputEntries.length; i++) {
const vtkDrivenViewportInputEntry = viewportInputEntries[i];
const canvas = vtkDrivenCanvases[i];
const internalViewportEntry = {
...vtkDrivenViewportInputEntry,
canvas,
};
this.addVtkjsDrivenViewport(internalViewportEntry);
}
}
}
/**
* Resizes viewports that use VTK.js for rendering.
*/
protected _resizeVTKViewports(
vtkDrivenViewports: (IStackViewport | IVolumeViewport)[],
keepCamera = true,
immediate = true
) {
const canvasesDrivenByVtkJs = vtkDrivenViewports.map(
(vp: IStackViewport | IVolumeViewport) => {
return getOrCreateCanvas(vp.element);
}
);
canvasesDrivenByVtkJs.forEach((canvas) => {
const devicePixelRatio = window.devicePixelRatio || 1;
canvas.width = canvas.clientWidth * devicePixelRatio;
canvas.height = canvas.clientHeight * devicePixelRatio;
});
if (canvasesDrivenByVtkJs.length) {
this._resize(vtkDrivenViewports);
}
vtkDrivenViewports.forEach((vp: IStackViewport | IVolumeViewport) => {
const prevCamera = vp.getCamera();
const rotation = vp.getRotation();
const { flipHorizontal } = prevCamera;
vp.resetCameraForResize();
const displayArea = vp.getDisplayArea();
if (keepCamera) {
if (displayArea) {
if (flipHorizontal) {
vp.setCamera({ flipHorizontal });
}
if (rotation) {
vp.setViewPresentation({ rotation });
}
} else {
vp.setCamera(prevCamera);
}
}
});
if (immediate) {
this.render();
}
}
/**
* Renders all viewports.
*/
protected _renderFlaggedViewports = (): void => {
this._throwIfDestroyed();
const viewports = this._getViewportsAsArray();
const viewportsToRender = viewports.filter((vp) =>
this._needsRender.has(vp.id)
);
Iif (viewportsToRender.length === 0) {
this._animationFrameSet = false;
this._animationFrameHandle = null;
return;
}
// Render all viewports synchronously
const eventDetails = viewportsToRender.map((viewport) => {
const eventDetail = this.renderViewportUsingCustomOrVtkPipeline(viewport);
viewport.setRendered();
this._needsRender.delete(viewport.id);
return eventDetail;
});
this._animationFrameSet = false;
this._animationFrameHandle = null;
// Trigger all events after rendering is complete
eventDetails.forEach((eventDetail) => {
Eif (eventDetail?.element) {
triggerEvent(eventDetail.element, Events.IMAGE_RENDERED, eventDetail);
}
});
};
private renderViewportUsingCustomOrVtkPipeline(
viewport: IViewport
): EventTypes.ImageRenderedEventDetail {
// Handle custom rendering pipeline viewports
Iif (viewportTypeUsesCustomRenderingPipeline(viewport.type)) {
const eventDetail =
viewport.customRenderViewportToCanvas() as EventTypes.ImageRenderedEventDetail;
return eventDetail;
}
// If using CPU rendering, throw error
Iif (this.useCPURendering) {
throw new Error(
'GPU not available, and using a viewport with no custom render pipeline.'
);
}
// Get the context assigned to this viewport
const assignedContextIndex = this.contextPool.getContextIndexForViewport(
viewport.id
);
const contextData =
this.contextPool.getContextByIndex(assignedContextIndex);
const { context, container } = contextData;
const eventDetail = this._renderViewportWithContext(
viewport,
context,
container
);
return eventDetail;
}
private _renderViewportWithContext(
viewport: IViewport,
offscreenMultiRenderWindow: VtkOffscreenMultiRenderWindow,
offScreenCanvasContainer: HTMLDivElement
): EventTypes.ImageRenderedEventDetail {
// Check viewport size
Iif (
viewport.sWidth < VIEWPORT_MIN_SIZE ||
viewport.sHeight < VIEWPORT_MIN_SIZE
) {
console.warn('Viewport is too small', viewport.sWidth, viewport.sHeight);
return;
}
Iif (viewportTypeUsesCustomRenderingPipeline(viewport.type)) {
return viewport.customRenderViewportToCanvas() as EventTypes.ImageRenderedEventDetail;
}
Iif (this.useCPURendering) {
throw new Error(
'GPU not available, and using a viewport with no custom render pipeline.'
);
}
// Add renderer if not already present
Iif (!offscreenMultiRenderWindow.getRenderer(viewport.id)) {
offscreenMultiRenderWindow.addRenderer({
viewport: [0, 0, 1, 1],
id: viewport.id,
background: viewport.defaultOptions?.background || [0, 0, 0],
});
}
const renderWindow = offscreenMultiRenderWindow.getRenderWindow();
this._resizeOffScreenCanvasForViewport(
viewport.canvas,
offScreenCanvasContainer,
offscreenMultiRenderWindow
);
const renderer = offscreenMultiRenderWindow.getRenderer(viewport.id);
renderer.setViewport(0, 0, 1, 1);
// Set only this renderer to draw
const allRenderers = offscreenMultiRenderWindow.getRenderers();
allRenderers.forEach(({ renderer: r, id }) => {
r.setDraw(id === viewport.id);
});
// Handle widget renderers
const widgetRenderers = this.getWidgetRenderers();
widgetRenderers.forEach((viewportId, renderer) => {
renderer.setDraw(viewportId === viewport.id);
});
renderWindow.render();
allRenderers.forEach(({ renderer: r }) => r.setDraw(false));
widgetRenderers.forEach((_, renderer) => {
renderer.setDraw(false);
});
const openGLRenderWindow =
offscreenMultiRenderWindow.getOpenGLRenderWindow();
const context = openGLRenderWindow.get3DContext();
const offScreenCanvas = context.canvas;
const eventDetail = this._copyToOnscreenCanvas(viewport, offScreenCanvas);
return eventDetail;
}
/**
* Renders a particular `Viewport`'s on screen canvas.
* @param viewport - The `Viewport` to render.
* @param offScreenCanvas - The offscreen canvas to render from.
*/
protected _renderViewportFromVtkCanvasToOnscreenCanvas(
viewport: IViewport,
offScreenCanvas: HTMLCanvasElement
): EventTypes.ImageRenderedEventDetail {
return this._copyToOnscreenCanvas(viewport, offScreenCanvas);
}
private _resizeOffScreenCanvasForViewport(
viewportCanvas: HTMLCanvasElement,
offScreenCanvasContainer: HTMLDivElement,
offscreenMultiRenderWindow: VtkOffscreenMultiRenderWindow
): void {
const offScreenCanvasWidth = viewportCanvas.width;
const offScreenCanvasHeight = viewportCanvas.height;
if (
// @ts-expect-error
offScreenCanvasContainer.height === offScreenCanvasHeight &&
// @ts-expect-error
offScreenCanvasContainer.width === offScreenCanvasWidth
) {
return;
}
// @ts-expect-error
offScreenCanvasContainer.width = offScreenCanvasWidth;
// @ts-expect-error
offScreenCanvasContainer.height = offScreenCanvasHeight;
offscreenMultiRenderWindow.resize();
}
private _copyToOnscreenCanvas(
viewport: IViewport,
offScreenCanvas: HTMLCanvasElement
): EventTypes.ImageRenderedEventDetail {
const {
element,
canvas,
id: viewportId,
renderingEngineId,
suppressEvents,
} = viewport;
const { width: dWidth, height: dHeight } = canvas;
const onScreenContext = canvas.getContext('2d');
onScreenContext.drawImage(
offScreenCanvas,
0,
0,
dWidth,
dHeight,
0,
0,
dWidth,
dHeight
);
return {
element,
suppressEvents,
viewportId,
renderingEngineId,
viewportStatus: viewport.viewportStatus,
};
}
private _resize(
viewportsDrivenByVtkJs: (IStackViewport | IVolumeViewport)[]
): void {
for (const viewport of viewportsDrivenByVtkJs) {
viewport.sx = 0;
viewport.sy = 0;
viewport.sWidth = viewport.canvas.width;
viewport.sHeight = viewport.canvas.height;
// Get the context assigned to this viewport
const contextIndex = this.contextPool.getContextIndexForViewport(
viewport.id
);
const contextData = this.contextPool.getContextByIndex(contextIndex);
const { context: offscreenMultiRenderWindow } = contextData;
const renderer = offscreenMultiRenderWindow.getRenderer(viewport.id);
renderer.setViewport(0, 0, 1, 1);
}
}
private getWidgetRenderers(): Map<vtkRenderer, string> {
const allViewports = this._getViewportsAsArray();
const widgetRenderers = new Map();
allViewports.forEach((vp) => {
const widgets = vp.getWidgets ? vp.getWidgets() : [];
widgets.forEach((widget) => {
const renderer = widget.getRenderer ? widget.getRenderer() : null;
if (renderer) {
widgetRenderers.set(renderer, vp.id);
}
});
});
return widgetRenderers;
}
/**
* Get the renderer for a specific viewport
* @param viewportId - The ID of the viewport
* @returns The vtkRenderer instance or undefined
*/
public getRenderer(viewportId: string): vtkRenderer | undefined {
const contextIndex =
this.contextPool?.getContextIndexForViewport(viewportId);
const contextData = this.contextPool.getContextByIndex(contextIndex);
const { context: offscreenMultiRenderWindow } = contextData;
return offscreenMultiRenderWindow.getRenderer(viewportId);
}
/**
* Disables the requested viewportId from the rendering engine.
* Calls the base implementation and then handles context-specific cleanup.
*
* @param viewportId - viewport Id
*/
public disableElement(viewportId: string): void {
const viewport = this.getViewport(viewportId);
if (!viewport) {
return;
}
super.disableElement(viewportId);
if (
!viewportTypeUsesCustomRenderingPipeline(viewport.type) &&
!this.useCPURendering
) {
const contextIndex =
this.contextPool.getContextIndexForViewport(viewportId);
if (contextIndex !== undefined) {
const contextData = this.contextPool.getContextByIndex(contextIndex);
if (contextData) {
const { context: offscreenMultiRenderWindow } = contextData;
offscreenMultiRenderWindow.removeRenderer(viewportId);
}
}
}
}
public destroy(): void {
if (this.contextPool) {
this.contextPool.destroy();
}
super.destroy();
}
public getOffscreenMultiRenderWindow(
viewportId: string
): VtkOffscreenMultiRenderWindow {
if (this.useCPURendering) {
throw new Error(
'Offscreen multi render window is not available when using CPU rendering.'
);
}
const contextIndex =
this.contextPool.getContextIndexForViewport(viewportId);
const contextData = this.contextPool.getContextByIndex(contextIndex);
return contextData.context;
}
}
export default ContextPoolRenderingEngine;
|