All files / packages/core/src/RenderingEngine/vtkClasses vtkOffscreenMultiRenderWindow.js

100% Statements 46/46
60% Branches 3/5
100% Functions 10/10
100% Lines 46/46

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                                                            123x 123x     123x 123x     123x 123x     123x 123x 123x   123x 157x         157x 157x     123x 122x 122x     123x 157x 157x 157x 157x     123x 23921x     123x 151x   151x 209x     151x       123x 251x   128x       128x 128x 128x         123x   245x 245x       123x             123x             1x               123x     123x 123x           123x     123x         1x          
import macro from '@kitware/vtk.js/macros';
import vtkStreamingOpenGLRenderWindow from './vtkStreamingOpenGLRenderWindow';
import vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
import vtkRenderWindow from '@kitware/vtk.js/Rendering/Core/RenderWindow';
import vtkRenderWindowInteractor from '@kitware/vtk.js/Rendering/Core/RenderWindowInteractor';
 
// Load basic classes for vtk() factory
import '@kitware/vtk.js/Common/Core/Points';
import '@kitware/vtk.js/Common/Core/DataArray';
import '@kitware/vtk.js/Common/DataModel/PolyData';
import '@kitware/vtk.js/Rendering/Core/Actor';
import '@kitware/vtk.js/Rendering/Core/Mapper';
 
/**
 * vtkOffscreenMultiRenderWindow - A class to deal with offscreen rendering with multiple renderers.
 *
 * This class is based on the vtkGenericRenderWindow with two key differences:
 * - the vtkGenericRenderWindow had a renderer at the top level, with helpers to get it from the renderWindow.
 *   although you could add more renderers, this gave special status to the first viewport. Which was confusing.
 * - When checking the size of the container element we no longer check the client size, as the canvas is offscreen.
 * - We aren't using interactor styles, so don't set one up.
 *
 * Additionally this class has some new helpers to easily add/associate renderers to different viewportIds.
 *
 *
 * @param {*} publicAPI The public API to extend
 * @param {*} model The private model to extend.
 */
function vtkOffscreenMultiRenderWindow(publicAPI, model) {
  // Capture resize trigger method to remove from publicAPI
  const invokeResize = publicAPI.invokeResize;
  delete publicAPI.invokeResize;
 
  // VTK renderWindow. No renderers set by default
  model.renderWindow = vtkRenderWindow.newInstance();
  model.rendererMap = {};
 
  // OpenGLRenderWindow
  model.openGLRenderWindow = vtkStreamingOpenGLRenderWindow.newInstance();
  model.renderWindow.addView(model.openGLRenderWindow);
 
  // Interactor
  model.interactor = vtkRenderWindowInteractor.newInstance();
  model.interactor.setView(model.openGLRenderWindow);
  model.interactor.initialize();
 
  publicAPI.addRenderer = ({ viewport, id, background }) => {
    const renderer = vtkRenderer.newInstance({
      viewport,
      background: background || model.background,
    });
 
    model.renderWindow.addRenderer(renderer);
    model.rendererMap[id] = renderer;
  };
 
  publicAPI.destroy = () => {
    const rwi = model.renderWindow.getInteractor();
    rwi.delete();
  };
 
  publicAPI.removeRenderer = (id) => {
    const renderer = publicAPI.getRenderer(id);
    model.renderWindow.removeRenderer(renderer);
    renderer.delete();
    delete model.rendererMap[id];
  };
 
  publicAPI.getRenderer = (id) => {
    return model.rendererMap[id];
  };
 
  publicAPI.getRenderers = () => {
    const { rendererMap } = model;
 
    const renderers = Object.keys(rendererMap).map((id) => {
      return { id, renderer: rendererMap[id] };
    });
 
    return renderers;
  };
 
  // Handle window resize
  publicAPI.resize = () => {
    if (model.container) {
      // Don't use getBoundingClientRect() as in vtkGenericRenderWindow as is an offscreen canvas.
      const { width, height } = model.container;
 
      // Note: we do not scale by devicePixelRatio here because it has already
      // been done when adding the offscreenCanvas viewport representations
      model.openGLRenderWindow.setSize(Math.floor(width), Math.floor(height));
      invokeResize();
      model.renderWindow.render();
    }
  };
 
  // Handle DOM container relocation
  publicAPI.setContainer = (el) => {
    // Switch container
    model.container = el;
    model.openGLRenderWindow.setContainer(model.container);
  };
 
  // Properly release GL context
  publicAPI.delete = macro.chain(
    publicAPI.setContainer,
    publicAPI.destroy,
    model.openGLRenderWindow.delete,
    publicAPI.delete
  );
 
  publicAPI.resize();
}
 
// ----------------------------------------------------------------------------
// Object factory
// ----------------------------------------------------------------------------
 
const DEFAULT_VALUES = {
  background: [0.0, 0.0, 0.0],
  container: null,
};
 
// ----------------------------------------------------------------------------
 
export function extend(publicAPI, model, initialValues = {}) {
  Object.assign(model, DEFAULT_VALUES, initialValues);
 
  // Object methods
  macro.obj(publicAPI, model);
  macro.get(publicAPI, model, [
    'renderWindow',
    'openGLRenderWindow',
    'interactor',
    'container',
  ]);
  macro.event(publicAPI, model, 'resize');
 
  // Object specific methods
  vtkOffscreenMultiRenderWindow(publicAPI, model);
}
 
// ----------------------------------------------------------------------------
 
export const newInstance = macro.newInstance(extend);
 
// ----------------------------------------------------------------------------
 
export default { newInstance, extend };