@kitware/vtk.js 32.12.1 → 32.13.0

package/Rendering/Core/Actor2D.d.ts

@@ -54,6 +54,28 @@ export interface vtkActor2D extends vtkProp {
    */
   getMapper(): vtkMapper2D;
 
+  /**
+   * Set the layer number for this 2D actor.
+   * The scenegraph uses this layer number to sort actor 2D overlays/underlays on top of each other.
+   * The actor2D with the highest layer number is going to be rendered at the very front i.e. it is
+   * the top-most layer.
+   * If two actor2D instances share the same layer number, they are rendered in the order in which
+   * they were added to the renderer via `addActor` or `addActor2D`.
+   * By default, each actor2D has a layer number of 0.
+   */
+  setLayerNumber(layer: number): void;
+
+  /**
+   * Get the layer number for this 2D actor.
+   * The scenegraph uses this layer number to sort actor 2D overlays/underlays on top of each other.
+   * The actor2D with the highest layer number is going to be rendered at the very front i.e. it is
+   * the top-most layer.
+   * If two actor2D instances share the same layer number, they are rendered in the order in which
+   * they were added to the renderer via `addActor` or `addActor2D`.
+   * By default, each actor2D has a layer number of 0.
+   */
+  getLayerNumber(): number;
+
   /**
    *
    */

package/Rendering/Core/Actor2D.js

@@ -145,7 +145,7 @@ function extend(publicAPI, model) {
 
   // Build VTK API
   macro.set(publicAPI, model, ['property']);
-  macro.setGet(publicAPI, model, ['mapper']);
+  macro.setGet(publicAPI, model, ['mapper', 'layerNumber']);
 
   // Object methods
   vtkActor2D(publicAPI, model);

package/Rendering/Core/Viewport.js

@@ -46,10 +46,20 @@ function vtkViewport(publicAPI, model) {
     return allProps;
   }
   publicAPI.getViewPropsWithNestedProps = () => {
-    const allPropsArray = [];
-    for (let i = 0; i < model.props.length; i++) {
-      gatherProps(model.props[i], allPropsArray);
+    let allPropsArray = [];
+    // Handle actor2D instances separately so that they can be overlayed and layered
+    const actors2D = publicAPI.getActors2D();
+    // Sort the actor2D list using its layer number
+    actors2D.sort((a, b) => a.getLayerNumber() - b.getLayerNumber());
+    // Filter out all the actor2D instances
+    const newPropList = model.props.filter(item => !actors2D.includes(item));
+    for (let i = 0; i < newPropList.length; i++) {
+      gatherProps(newPropList[i], allPropsArray);
     }
+    // Finally, add the actor2D props at the end of the list
+    // This works because, when traversing the render pass in vtkOpenGLRenderer, the children are
+    // traversed in the order that they are added to the list
+    allPropsArray = allPropsArray.concat(actors2D);
     return allPropsArray;
   };
   publicAPI.addActor2D = publicAPI.addViewProp;

package/Rendering/Misc/SynchronizableRenderWindow/BehaviorManager/CameraSynchronizer.js

@@ -33,8 +33,8 @@ function vtkCameraSynchronizer(publicAPI, model) {
   }
 
   // Update listeners automatically
-  model._srcRendererChanged = updateListeners;
-  model._dstRendererChanged = updateListeners;
+  model._onSrcRendererChanged = updateListeners;
+  model._onDstRendererChanged = updateListeners;
   function updatePreviousValues(position, focalPoint, viewUp) {
     if (cameraState[0] !== position[0] || cameraState[1] !== position[1] || cameraState[2] !== position[2] || cameraState[3] !== focalPoint[0] || cameraState[4] !== focalPoint[1] || cameraState[5] !== focalPoint[2] || cameraState[6] !== viewUp[0] || cameraState[7] !== viewUp[1] || cameraState[8] !== viewUp[2]) {
       cameraState[0] = position[0];

package/Rendering/OpenGL/Renderer.js

@@ -24,7 +24,7 @@ function vtkOpenGLRenderer(publicAPI, model) {
       publicAPI.updateLights();
       publicAPI.prepareNodes();
       publicAPI.addMissingNode(model.renderable.getActiveCamera());
-      publicAPI.addMissingNodes(model.renderable.getViewPropsWithNestedProps());
+      publicAPI.addMissingNodes(model.renderable.getViewPropsWithNestedProps(), true);
       publicAPI.removeUnusedNodes();
     }
   };

package/Rendering/SceneGraph/ViewNode.js

@@ -105,13 +105,23 @@ function vtkViewNode(publicAPI, model) {
 
   // add missing nodes/children for the passed in renderables. This should
   // be called only in between prepareNodes and removeUnusedNodes
-  publicAPI.addMissingNodes = dataObjs => {
+  publicAPI.addMissingNodes = function (dataObjs) {
+    let enforceOrder = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     if (!dataObjs || !dataObjs.length) {
       return;
     }
     for (let index = 0; index < dataObjs.length; ++index) {
       const dobj = dataObjs[index];
-      publicAPI.addMissingNode(dobj);
+      const node = publicAPI.addMissingNode(dobj);
+      if (enforceOrder && node !== undefined && model.children[index] !== node) {
+        for (let i = index + 1; i < model.children.length; ++i) {
+          if (model.children[i] === node) {
+            model.children.splice(i, 1);
+            model.children.splice(index, 0, node);
+            break;
+          }
+        }
+      }
     }
   };
 

package/Widgets/Core/WidgetManager.d.ts

@@ -12,6 +12,14 @@ import { vtkObject } from './../../interfaces';
 import { CaptureOn, ViewTypes } from './WidgetManager/Constants';
 import { Nullable } from './../../types';
 
+export interface IDisplayScaleParams {
+  dispHeightFactor: number;
+  cameraPosition: number[];
+  cameraDir: number[];
+  isParallel: boolean;
+  rendererPixelDims: number[];
+}
+
 export interface ISelectedData {
   requestCount: number;
   propID: number;
@@ -45,7 +53,10 @@ export function extractRenderingComponents(
  * (vertical) distance that matches a display distance of 30px for a coordinate
  * `coord`, you would compute `30 * getPixelWorldHeightAtCoord(coord)`.
  */
-export function getPixelWorldHeightAtCoord(coord: []): Number;
+export function getPixelWorldHeightAtCoord(
+  coord: [],
+  displayScaleParams: IDisplayScaleParams
+): Number;
 
 export interface vtkWidgetManager extends vtkObject {
   /**

package/Widgets/Representations/WidgetRepresentation.d.ts

@@ -2,13 +2,7 @@ import vtkDataArray from './../../Common/Core/DataArray';
 import vtkPolyData from './../../Common/DataModel/PolyData';
 import { vtkObject } from './../../interfaces';
 import vtkProp from './../../Rendering/Core/Prop';
-export interface IDisplayScaleParams {
-  dispHeightFactor: number;
-  cameraPosition: number[];
-  cameraDir: number[];
-  isParallel: boolean;
-  rendererPixelDims: number[];
-}
+import { IDisplayScaleParams } from './../Core/WidgetManager';
 
 export interface IWidgetRepresentationInitialValues {
   labels?: Array<any>;

package/Widgets/Widgets3D/ResliceCursorWidget.d.ts

@@ -12,14 +12,7 @@ import vtkRenderer from './../../Rendering/Core/Renderer';
 import vtkPlaneManipulator from './../Manipulators/PlaneManipulator';
 import { ViewTypes } from './../Core/WidgetManager/Constants';
 import { Vector2, Vector3 } from './../../types';
-
-export interface IDisplayScaleParams {
-  dispHeightFactor: number;
-  cameraPosition: Vector3;
-  cameraDir: Vector3;
-  isParallel: false;
-  rendererPixelDims: Vector2;
-}
+import { IDisplayScaleParams } from './../Core/WidgetManager';
 
 export interface vtkResliceCursorWidget<
   WidgetInstance extends vtkAbstractWidget = vtkResliceCursorWidgetDefaultInstance

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitware/vtk.js",
-  "version": "32.12.1",
+  "version": "32.13.0",
   "description": "Visualization Toolkit for the Web",
   "keywords": [
     "3d",