@kitware/vtk.js 34.15.1 → 34.15.3

package/CONTRIBUTING.md

@@ -33,7 +33,7 @@ Please follow the coding style:
     $ git checkout -b new_feature
     ```
 
-4. Start hacking. Additional information on how to create class/test/example can be found
+6. Start hacking. Additional information on how to create class/test/example can be found
    [here](https://kitware.github.io/vtk-js/docs/) in the __Development__ section.
 
     ```sh
@@ -41,19 +41,26 @@ Please follow the coding style:
     $ git add file1 file2 file3
     ```
 
-5. Use Commitizen to create commits
+7. Verify you have correctly formatted code, and that all tests pass:
+
+    ```sh
+    $ npm run reformat
+    $ npm run test
+    ```
+
+8. Use Commitizen to create commits
 
     ```sh
     $ npm run commit
     ```
 
-6. Push commits in your feature branch to your fork in GitHub:
+9. Push commits in your feature branch to your fork in GitHub:
 
     ```sh
     $ git push origin new_feature
     ```
 
-7. Visit your fork in Github, browse to the "**Pull Requests**" link on the left, and use the 
+10. Visit your fork in Github, browse to the "**Pull Requests**" link on the left, and use the 
    "**New Pull Request**" button in the upper right to create a Pull Request.
 
     For more information see: 
@@ -62,7 +69,7 @@ Please follow the coding style:
 If committing changes to `vtk.js@next` or `vtk.js@next-major`, then set your base branch to be `next`
 or `next-major`, respectively. For more info see the section on release channels below.
 
-8. vtk.js uses GitHub for code review and Github Actions to validate proposed patches before they are merged.
+11. vtk.js uses GitHub for code review and Github Actions to validate proposed patches before they are merged.
 
 ## Release Channels
 

package/IO/Geometry/IFCImporter.js

@@ -40,13 +40,13 @@ function vtkIFCImporter(publicAPI, model) {
     const cells = vtkCellArray.newInstance();
     const pointValues = new Float32Array(vertices.length / 2);
     const normalsArray = new Float32Array(vertices.length / 2);
-    for (let i = 0; i < vertices.length; i += 6) {
-      pointValues[i / 2] = vertices[i];
-      pointValues[i / 2 + 1] = vertices[i + 1];
-      pointValues[i / 2 + 2] = vertices[i + 2];
-      normalsArray[i / 2] = vertices[i + 3];
-      normalsArray[i / 2 + 1] = vertices[i + 4];
-      normalsArray[i / 2 + 2] = vertices[i + 5];
+    for (let i = 0, p = 0; i < vertices.length; p += 3) {
+      pointValues[p] = vertices[i++];
+      pointValues[p + 1] = vertices[i++];
+      pointValues[p + 2] = vertices[i++];
+      normalsArray[p] = vertices[i++];
+      normalsArray[p + 1] = vertices[i++];
+      normalsArray[p + 2] = vertices[i++];
     }
     const nCells = indices.length;
     cells.resize(3 * nCells / 3);
@@ -82,36 +82,30 @@ function vtkIFCImporter(publicAPI, model) {
     const normalsArray = new Float32Array(vertices.length / 2);
     const colorArray = new Float32Array(vertices.length / 2);
     if (userMatrix) {
-      const transformMatrix = vtkMatrixBuilder.buildFromRadian().setMatrix(userMatrix);
-      const normalMatrix = vtkMatrixBuilder.buildFromRadian().multiply3x3(mat3.fromMat4(mat3.create(), userMatrix));
-      for (let i = 0; i < vertices.length; i += 6) {
-        const point = [vertices[i], vertices[i + 1], vertices[i + 2]];
-        const normal = [vertices[i + 3], vertices[i + 4], vertices[i + 5]];
-        transformMatrix.apply(point);
-        normalMatrix.apply(normal);
-        pointValues[i / 2] = point[0];
-        pointValues[i / 2 + 1] = point[1];
-        pointValues[i / 2 + 2] = point[2];
-        normalsArray[i / 2] = normal[0];
-        normalsArray[i / 2 + 1] = normal[1];
-        normalsArray[i / 2 + 2] = normal[2];
-        const colorIndex = i / 2;
-        colorArray[colorIndex] = color.x;
-        colorArray[colorIndex + 1] = color.y;
-        colorArray[colorIndex + 2] = color.z;
+      for (let i = 0, p = 0; i < vertices.length; p += 3) {
+        pointValues[p] = vertices[i++];
+        pointValues[p + 1] = vertices[i++];
+        pointValues[p + 2] = vertices[i++];
+        normalsArray[p] = vertices[i++];
+        normalsArray[p + 1] = vertices[i++];
+        normalsArray[p + 2] = vertices[i++];
+        colorArray[p] = color.x;
+        colorArray[p + 1] = color.y;
+        colorArray[p + 2] = color.z;
       }
+      vtkMatrixBuilder.buildFromRadian().setMatrix(userMatrix).apply(pointValues);
+      vtkMatrixBuilder.buildFromRadian().multiply3x3(mat3.fromMat4(mat3.create(), userMatrix)).apply(normalsArray);
     } else {
-      for (let i = 0; i < vertices.length; i += 6) {
-        pointValues[i / 2] = vertices[i];
-        pointValues[i / 2 + 1] = vertices[i + 1];
-        pointValues[i / 2 + 2] = vertices[i + 2];
-        normalsArray[i / 2] = vertices[i + 3];
-        normalsArray[i / 2 + 1] = vertices[i + 4];
-        normalsArray[i / 2 + 2] = vertices[i + 5];
-        const colorIndex = i / 2;
-        colorArray[colorIndex] = color.x;
-        colorArray[colorIndex + 1] = color.y;
-        colorArray[colorIndex + 2] = color.z;
+      for (let i = 0, p = 0; i < vertices.length; p += 3) {
+        pointValues[p] = vertices[i++];
+        pointValues[p + 1] = vertices[i++];
+        pointValues[p + 2] = vertices[i++];
+        normalsArray[p] = vertices[i++];
+        normalsArray[p + 1] = vertices[i++];
+        normalsArray[p + 2] = vertices[i++];
+        colorArray[p] = color.x;
+        colorArray[p + 1] = color.y;
+        colorArray[p + 2] = color.z;
       }
     }
     const nCells = indices.length;

package/Rendering/Core/Viewport.js

@@ -47,19 +47,23 @@ function vtkViewport(publicAPI, model) {
   }
   publicAPI.getViewPropsWithNestedProps = () => {
     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);
+    // Repopulate the actor2D list to minimize browsing operations.
+    model.actors2D = [];
+    for (let i = 0; i < model.props.length; i++) {
+      // Handle actor2D instances separately so that they can be overlayed and layered
+      const isActor2D = model.props[i].getActors2D();
+      if (isActor2D && (!Array.isArray(isActor2D) || isActor2D.length > 0)) {
+        model.actors2D = model.actors2D.concat(isActor2D);
+      } else {
+        gatherProps(model.props[i], allPropsArray);
+      }
     }
+    // Actor2D must be rendered by layer number order
+    model.actors2D.sort((a, b) => a.getLayerNumber() - b.getLayerNumber());
     // 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);
+    allPropsArray = allPropsArray.concat(model.actors2D);
     return allPropsArray;
   };
   publicAPI.addActor2D = publicAPI.addViewProp;

package/Rendering/OpenGL/HardwareSelector.js

@@ -231,7 +231,7 @@ function vtkOpenGLHardwareSelector(publicAPI, model) {
 
   //----------------------------------------------------------------------------
   publicAPI.beginSelection = () => {
-    model._openGLRenderer = model._openGLRenderWindow.getViewNodeFor(model._renderer);
+    model._openGLRenderer = model._openGLRenderWindow.getViewNodeFor(model._renderer, model._openGLRenderer);
     model.maxAttributeId = 0;
     const size = model._openGLRenderWindow.getSize();
     if (!model.framebuffer) {
@@ -339,7 +339,7 @@ function vtkOpenGLHardwareSelector(publicAPI, model) {
       vtkErrorMacro('Renderer and view must be set before calling Select.');
       return false;
     }
-    model._openGLRenderer = model._openGLRenderWindow.getViewNodeFor(model._renderer);
+    model._openGLRenderer = model._openGLRenderWindow.getViewNodeFor(model._renderer, model._openGLRenderer);
 
     // todo revisit making selection part of core
     // then we can do this in core

package/Rendering/OpenGL/ImageCPRMapper.js

@@ -43,7 +43,7 @@ function vtkOpenGLImageCPRMapper(publicAPI, model) {
         unregisterGraphicsResources(oldOglRenderWindow);
       }
       model.context = model._openGLRenderWindow.getContext();
-      model.openGLCamera = model._openGLRenderer.getViewNodeFor(model._openGLRenderer.getRenderable().getActiveCamera());
+      model.openGLCamera = model._openGLRenderer.getViewNodeFor(model._openGLRenderer.getRenderable().getActiveCamera(), model.openGLCamera);
       model.tris.setOpenGLRenderWindow(model._openGLRenderWindow);
     }
   };

package/Rendering/OpenGL/ImageMapper.js

@@ -70,7 +70,7 @@ function vtkOpenGLImageMapper(publicAPI, model) {
       model.context = model._openGLRenderWindow.getContext();
       model.tris.setOpenGLRenderWindow(model._openGLRenderWindow);
       const ren = model._openGLRenderer.getRenderable();
-      model.openGLCamera = model._openGLRenderer.getViewNodeFor(ren.getActiveCamera());
+      model.openGLCamera = model._openGLRenderer.getViewNodeFor(ren.getActiveCamera(), model.openGLCamera);
       // is slice set by the camera
       if (model.renderable.isA('vtkImageMapper') && model.renderable.getSliceAtFocalPoint()) {
         model.renderable.setSliceFromCamera(ren.getActiveCamera());

package/Rendering/OpenGL/ImageResliceMapper.js

@@ -93,7 +93,7 @@ function vtkOpenGLImageResliceMapper(publicAPI, model) {
       model._openGLImageSlice = publicAPI.getFirstAncestorOfType('vtkOpenGLImageSlice');
       model._openGLRenderer = publicAPI.getFirstAncestorOfType('vtkOpenGLRenderer');
       const ren = model._openGLRenderer.getRenderable();
-      model._openGLCamera = model._openGLRenderer.getViewNodeFor(ren.getActiveCamera());
+      model._openGLCamera = model._openGLRenderer.getViewNodeFor(ren.getActiveCamera(), model.openGLCamera);
       const oldOglRenderWindow = model._openGLRenderWindow;
       model._openGLRenderWindow = model._openGLRenderer.getLastAncestorOfType('vtkOpenGLRenderWindow');
       if (oldOglRenderWindow && !oldOglRenderWindow.isDeleted() && oldOglRenderWindow !== model._openGLRenderWindow) {

package/Rendering/OpenGL/PolyDataMapper.js

@@ -70,7 +70,7 @@ function vtkOpenGLPolyDataMapper(publicAPI, model) {
       model.openGLActor = publicAPI.getFirstAncestorOfType('vtkOpenGLActor');
       model._openGLRenderer = model.openGLActor.getFirstAncestorOfType('vtkOpenGLRenderer');
       model._openGLRenderWindow = model._openGLRenderer.getLastAncestorOfType('vtkOpenGLRenderWindow');
-      model.openGLCamera = model._openGLRenderer.getViewNodeFor(model._openGLRenderer.getRenderable().getActiveCamera());
+      model.openGLCamera = model._openGLRenderer.getViewNodeFor(model._openGLRenderer.getRenderable().getActiveCamera(), model.openGLCamera);
     }
   };
 

package/Rendering/OpenGL/PolyDataMapper2D.js

@@ -42,7 +42,7 @@ function vtkOpenGLPolyDataMapper2D(publicAPI, model) {
       model.openGLActor2D = publicAPI.getFirstAncestorOfType('vtkOpenGLActor2D');
       model._openGLRenderer = model.openGLActor2D.getFirstAncestorOfType('vtkOpenGLRenderer');
       model._openGLRenderWindow = model._openGLRenderer.getLastAncestorOfType('vtkOpenGLRenderWindow');
-      model.openGLCamera = model._openGLRenderer.getViewNodeFor(model._openGLRenderer.getRenderable().getActiveCamera());
+      model.openGLCamera = model._openGLRenderer.getViewNodeFor(model._openGLRenderer.getRenderable().getActiveCamera(), model.openGLCamera);
     }
   };
   publicAPI.overlayPass = prepass => {

package/Rendering/OpenGL/Skybox.js

@@ -28,7 +28,7 @@ function vtkOpenGLSkybox(publicAPI, model) {
       model.tris.setOpenGLRenderWindow(model._openGLRenderWindow);
       model.openGLTexture.setOpenGLRenderWindow(model._openGLRenderWindow);
       const ren = model._openGLRenderer.getRenderable();
-      model.openGLCamera = model._openGLRenderer.getViewNodeFor(ren.getActiveCamera());
+      model.openGLCamera = model._openGLRenderer.getViewNodeFor(ren.getActiveCamera(), model.openGLCamera);
     }
   };
   publicAPI.queryPass = (prepass, renderPass) => {

package/Rendering/OpenGL/VolumeMapper.js

@@ -124,7 +124,7 @@ function vtkOpenGLVolumeMapper(publicAPI, model) {
       const actor = model.openGLVolume.getRenderable();
       model._openGLRenderer = publicAPI.getFirstAncestorOfType('vtkOpenGLRenderer');
       const ren = model._openGLRenderer.getRenderable();
-      model.openGLCamera = model._openGLRenderer.getViewNodeFor(ren.getActiveCamera());
+      model.openGLCamera = model._openGLRenderer.getViewNodeFor(ren.getActiveCamera(), model.openGLCamera);
       publicAPI.renderPiece(ren, actor);
     }
   };

package/Rendering/SceneGraph/ViewNode.d.ts

@@ -100,8 +100,9 @@ export interface vtkViewNode extends vtkObject {
    * Returns the view node that corresponding to the provided object
    * Will return NULL if a match is not found in self or descendents
    * @param dataObject
+   * @param [hint] the previously found node (for optimization)
    */
-  getViewNodeFor(dataObject: any): any;
+  getViewNodeFor(dataObject: any, hint?: any): any;
 
   /**
    *

package/Rendering/SceneGraph/ViewNode.js

@@ -13,6 +13,25 @@ function vtkViewNode(publicAPI, model) {
   // Set our className
   model.classHierarchy.push('vtkViewNode');
 
+  /**
+   * Convenient method to move a child to a specific index.
+   * @param {*} child the child to move
+   * @param {*} toIndex the index to move the child to
+   * @returns true if the child was moved, false otherwise
+   */
+  function moveChild(child, toIndex) {
+    for (let i = 0; i < model.children.length; ++i) {
+      // Start browsing from toIndex + 1
+      const childIndex = (toIndex + 1 + i) % model.children.length;
+      if (model.children[childIndex] === child) {
+        model.children[childIndex] = model.children[toIndex];
+        model.children[toIndex] = child;
+        return true;
+      }
+    }
+    return false;
+  }
+
   // Builds myself.
   publicAPI.build = prepass => {};
 
@@ -41,7 +60,11 @@ function vtkViewNode(publicAPI, model) {
       customRenderPass(prepass, renderPass);
     }
   };
-  publicAPI.getViewNodeFor = dataObject => {
+  publicAPI.getViewNodeFor = function (dataObject) {
+    let hint = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
+    if (hint && hint.renderable === dataObject) {
+      return hint;
+    }
     if (model.renderable === dataObject) {
       return publicAPI;
     }
@@ -110,17 +133,19 @@ function vtkViewNode(publicAPI, model) {
     if (!dataObjs || !dataObjs.length) {
       return;
     }
+    let nextIndex;
     for (let index = 0; index < dataObjs.length; ++index) {
       const dobj = dataObjs[index];
       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;
-          }
+      if (enforceOrder && node !== undefined) {
+        if (nextIndex === undefined) {
+          // First node can be anywhere
+          nextIndex = model.children.lastIndexOf(node); // node is likely the list child
+        } else if (model.children[nextIndex] !== node) {
+          moveChild(model.children, node);
         }
+        // Next node must follow current node
+        nextIndex++;
       }
     }
   };

package/Rendering/WebGPU/Renderer.js

@@ -122,7 +122,7 @@ function vtkWebGPURenderer(publicAPI, model) {
       publicAPI.addMissingNode(model.camera);
       publicAPI.addMissingNodes(model.renderable.getViewPropsWithNestedProps());
       publicAPI.removeUnusedNodes();
-      model.webgpuCamera = publicAPI.getViewNodeFor(model.camera);
+      model.webgpuCamera = publicAPI.getViewNodeFor(model.camera, model.webgpuCamera);
       publicAPI.updateStabilizedMatrix();
     }
   };

package/package.json

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