@kitware/vtk.js 24.2.0 → 24.3.0

package/Rendering/Core/CubeAxesActor.js

@@ -696,7 +696,7 @@ function vtkCubeAxesActor(publicAPI, model) {
   publicAPI.getBounds = function () {
     publicAPI.update();
     vtkBoundingBox.setBounds(model.bounds, model.gridActor.getBounds());
-    vtkBoundingBox.scaleAboutCenter(model.bounds, model.boundsScaleFactor);
+    vtkBoundingBox.scaleAboutCenter(model.bounds, model.boundsScaleFactor, model.boundsScaleFactor, model.boundsScaleFactor);
     return model.bounds;
   };
 } // ----------------------------------------------------------------------------

package/Rendering/Core/RenderWindowInteractor.js

@@ -184,8 +184,14 @@ function vtkRenderWindowInteractor(publicAPI, model) {
       rootElm[method]('mouseup', publicAPI.handleMouseUp);
       rootElm[method]('mousemove', publicAPI.handleMouseMove);
       rootElm[method]('touchend', publicAPI.handleTouchEnd, false);
-      rootElm[method]('touchcancel', publicAPI.handleTouchEnd, false);
-      rootElm[method]('touchmove', publicAPI.handleTouchMove, false);
+      rootElm[method]('touchcancel', publicAPI.handleTouchEnd, {
+        passive: false,
+        capture: false
+      });
+      rootElm[method]('touchmove', publicAPI.handleTouchMove, {
+        passive: false,
+        capture: false
+      });
     }
 
     if (!force && addListeners) {
@@ -207,7 +213,10 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     document.addEventListener('keydown', publicAPI.handleKeyDown);
     document.addEventListener('keyup', publicAPI.handleKeyUp);
     document.addEventListener('pointerlockchange', publicAPI.handlePointerLockChange);
-    container.addEventListener('touchstart', publicAPI.handleTouchStart, false);
+    container.addEventListener('touchstart', publicAPI.handleTouchStart, {
+      passive: false,
+      capture: false
+    });
   };
 
   publicAPI.unbindEvents = function () {
@@ -225,7 +234,10 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     document.removeEventListener('keydown', publicAPI.handleKeyDown);
     document.removeEventListener('keyup', publicAPI.handleKeyUp);
     document.removeEventListener('pointerlockchange', publicAPI.handlePointerLockChange);
-    model.container.removeEventListener('touchstart', publicAPI.handleTouchStart);
+    model.container.removeEventListener('touchstart', publicAPI.handleTouchStart, {
+      passive: false,
+      capture: false
+    });
     model.container = null;
   };
 

package/Rendering/OpenGL/OrderIndependentTranslucentPass.js

@@ -212,7 +212,7 @@ function vtkOpenGLOrderIndependentTranslucentPass(publicAPI, model) {
       return translucentShaderReplacement;
     }
 
-    return {};
+    return null;
   };
 
   publicAPI.releaseGraphicsResources = function (viewNode) {

package/Widgets/Core/WidgetManager.js

@@ -7,6 +7,7 @@ import macro from '../../macros.js';
 import vtkSelectionNode from '../../Common/DataModel/SelectionNode.js';
 import WidgetManagerConst from './WidgetManager/Constants.js';
 import vtkSVGRepresentation from '../SVG/SVGRepresentation.js';
+import { WIDGET_PRIORITY } from './AbstractWidget/Constants.js';
 import { diff } from './WidgetManager/vdom.js';
 
 var ViewTypes = WidgetManagerConst.ViewTypes,
@@ -263,6 +264,110 @@ function vtkWidgetManager(publicAPI, model) {
   // --------------------------------------------------------------------------
 
 
+  function updateSelection(_x) {
+    return _updateSelection.apply(this, arguments);
+  }
+
+  function _updateSelection() {
+    _updateSelection = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref) {
+      var position, _yield$publicAPI$getS, requestCount, selectedState, representation, widget, i, w;
+
+      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              position = _ref.position;
+              model._selectionInProgress = true;
+              _context2.next = 4;
+              return publicAPI.getSelectedDataForXY(position.x, position.y);
+
+            case 4:
+              _yield$publicAPI$getS = _context2.sent;
+              requestCount = _yield$publicAPI$getS.requestCount;
+              selectedState = _yield$publicAPI$getS.selectedState;
+              representation = _yield$publicAPI$getS.representation;
+              widget = _yield$publicAPI$getS.widget;
+              model._selectionInProgress = false;
+
+              if (!requestCount) {
+                _context2.next = 12;
+                break;
+              }
+
+              return _context2.abrupt("return");
+
+            case 12:
+              // Default cursor behavior
+              model._apiSpecificRenderWindow.setCursor(widget ? 'pointer' : 'default');
+
+              if (model.widgetInFocus === widget && widget.hasFocus()) {
+                widget.activateHandle({
+                  selectedState: selectedState,
+                  representation: representation
+                }); // Ken FIXME
+
+                model._interactor.render();
+
+                model._interactor.render();
+              } else {
+                for (i = 0; i < model.widgets.length; i++) {
+                  w = model.widgets[i];
+
+                  if (w === widget && w.getNestedPickable()) {
+                    w.activateHandle({
+                      selectedState: selectedState,
+                      representation: representation
+                    });
+                    model.activeWidget = w;
+                  } else {
+                    w.deactivateAllHandles();
+                  }
+                } // Ken FIXME
+
+
+                model._interactor.render();
+
+                model._interactor.render();
+              }
+
+            case 14:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2);
+    }));
+    return _updateSelection.apply(this, arguments);
+  }
+
+  var handleEvent = function handleEvent(eventName) {
+    var guard = false;
+    return function (callData) {
+      if (guard || model.isAnimating || !model.pickingEnabled || model._selectionInProgress) {
+        return macro.VOID;
+      }
+
+      var updatePromise = updateSelection(callData);
+      macro.measurePromiseExecution(updatePromise, function (elapsed) {
+        // 100ms is deemed fast enough. Anything higher can degrade usability.
+        if (elapsed > 100) {
+          macro.vtkWarningMacro("vtkWidgetManager updateSelection() took ".concat(elapsed, "ms on ").concat(eventName));
+        }
+      });
+      updatePromise.then(function () {
+        if (model._interactor) {
+          // re-trigger the event, ignoring our own handler
+          guard = true;
+
+          model._interactor["invoke".concat(eventName)](callData);
+
+          guard = false;
+        }
+      });
+      return macro.EVENT_ABORT;
+    };
+  };
+
   function updateWidgetForRender(w) {
     w.updateRepresentationForRender(model.renderingType);
   }
@@ -277,7 +382,7 @@ function vtkWidgetManager(publicAPI, model) {
     model.widgets.forEach(updateWidgetForRender);
   }
 
-  function captureBuffers(_x, _x2, _x3, _x4) {
+  function captureBuffers(_x2, _x3, _x4, _x5) {
     return _captureBuffers.apply(this, arguments);
   }
 
@@ -366,89 +471,9 @@ function vtkWidgetManager(publicAPI, model) {
       model.isAnimating = false;
       publicAPI.renderWidgets();
     }));
-    subscriptions.push(model._interactor.onMouseMove( /*#__PURE__*/function () {
-      var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
-        var position, _yield$publicAPI$getS, requestCount, selectedState, representation, widget, i, w;
-
-        return _regeneratorRuntime.wrap(function _callee$(_context) {
-          while (1) {
-            switch (_context.prev = _context.next) {
-              case 0:
-                position = _ref.position;
-
-                if (!(model.isAnimating || !model.pickingEnabled || model._selectionInProgress)) {
-                  _context.next = 3;
-                  break;
-                }
-
-                return _context.abrupt("return");
-
-              case 3:
-                model._selectionInProgress = true;
-                _context.next = 6;
-                return publicAPI.getSelectedDataForXY(position.x, position.y);
-
-              case 6:
-                _yield$publicAPI$getS = _context.sent;
-                requestCount = _yield$publicAPI$getS.requestCount;
-                selectedState = _yield$publicAPI$getS.selectedState;
-                representation = _yield$publicAPI$getS.representation;
-                widget = _yield$publicAPI$getS.widget;
-                model._selectionInProgress = false;
-
-                if (!requestCount) {
-                  _context.next = 14;
-                  break;
-                }
-
-                return _context.abrupt("return");
-
-              case 14:
-                // Default cursor behavior
-                model._apiSpecificRenderWindow.setCursor(widget ? 'pointer' : 'default');
-
-                if (model.widgetInFocus === widget && widget.hasFocus()) {
-                  widget.activateHandle({
-                    selectedState: selectedState,
-                    representation: representation
-                  }); // Ken FIXME
-
-                  model._interactor.render();
-
-                  model._interactor.render();
-                } else {
-                  for (i = 0; i < model.widgets.length; i++) {
-                    w = model.widgets[i];
-
-                    if (w === widget && w.getNestedPickable()) {
-                      w.activateHandle({
-                        selectedState: selectedState,
-                        representation: representation
-                      });
-                      model.activeWidget = w;
-                    } else {
-                      w.deactivateAllHandles();
-                    }
-                  } // Ken FIXME
-
-
-                  model._interactor.render();
-
-                  model._interactor.render();
-                }
-
-              case 16:
-              case "end":
-                return _context.stop();
-            }
-          }
-        }, _callee);
-      }));
-
-      return function (_x5) {
-        return _ref2.apply(this, arguments);
-      };
-    }()));
+    subscriptions.push(model._interactor.onMouseMove(handleEvent('MouseMove')));
+    subscriptions.push(model._interactor.onLeftButtonPress(handleEvent('LeftButtonPress'), // stay after widgets, but before default of 0
+    WIDGET_PRIORITY / 2));
     publicAPI.modified();
 
     if (model.pickingEnabled) {
@@ -530,16 +555,16 @@ function vtkWidgetManager(publicAPI, model) {
   };
 
   publicAPI.getSelectedDataForXY = /*#__PURE__*/function () {
-    var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(x, y) {
+    var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(x, y) {
       var i, widget, hoveredSVGReps, selection, capturedRegion;
-      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) {
-          switch (_context2.prev = _context2.next) {
+          switch (_context.prev = _context.next) {
             case 0:
               model.selections = null;
 
               if (!model.pickingEnabled) {
-                _context2.next = 24;
+                _context.next = 24;
                 break;
               }
 
@@ -547,7 +572,7 @@ function vtkWidgetManager(publicAPI, model) {
 
             case 3:
               if (!(i < model.widgets.length)) {
-                _context2.next = 16;
+                _context.next = 16;
                 break;
               }
 
@@ -557,7 +582,7 @@ function vtkWidgetManager(publicAPI, model) {
               });
 
               if (!hoveredSVGReps.length) {
-                _context2.next = 13;
+                _context.next = 13;
                 break;
               }
 
@@ -566,20 +591,20 @@ function vtkWidgetManager(publicAPI, model) {
               selection.getProperties().widget = widget;
               selection.getProperties().representation = hoveredSVGReps[0];
               model.selections = [selection];
-              return _context2.abrupt("return", publicAPI.getSelectedData());
+              return _context.abrupt("return", publicAPI.getSelectedData());
 
             case 13:
               ++i;
-              _context2.next = 3;
+              _context.next = 3;
               break;
 
             case 16:
               if (!(!model._capturedBuffers || model.captureOn === CaptureOn.MOUSE_MOVE)) {
-                _context2.next = 19;
+                _context.next = 19;
                 break;
               }
 
-              _context2.next = 19;
+              _context.next = 19;
               return captureBuffers(x, y, x, y);
 
             case 19:
@@ -587,29 +612,29 @@ function vtkWidgetManager(publicAPI, model) {
               capturedRegion = model._capturedBuffers.area;
 
               if (!(x < capturedRegion[0] || x > capturedRegion[2] || y < capturedRegion[1] || y > capturedRegion[3])) {
-                _context2.next = 23;
+                _context.next = 23;
                 break;
               }
 
-              _context2.next = 23;
+              _context.next = 23;
               return captureBuffers(x, y, x, y);
 
             case 23:
               model.selections = model._capturedBuffers.generateSelection(x, y, x, y);
 
             case 24:
-              return _context2.abrupt("return", publicAPI.getSelectedData());
+              return _context.abrupt("return", publicAPI.getSelectedData());
 
             case 25:
             case "end":
-              return _context2.stop();
+              return _context.stop();
           }
         }
-      }, _callee2);
+      }, _callee);
     }));
 
     return function (_x6, _x7) {
-      return _ref3.apply(this, arguments);
+      return _ref2.apply(this, arguments);
     };
   }();
 

package/Widgets/Widgets3D/PolyLineWidget/behavior.js

@@ -16,6 +16,20 @@ function widgetBehavior(publicAPI, model) {
 
   function ignoreKey(e) {
     return e.altKey || e.controlKey || e.shiftKey;
+  }
+
+  function updateMoveHandle(callData) {
+    model.manipulator.setOrigin(model._camera.getFocalPoint());
+    model.manipulator.setNormal(model._camera.getDirectionOfProjection());
+    var worldCoords = model.manipulator.handleEvent(callData, model._apiSpecificRenderWindow);
+
+    if (worldCoords.length && (model.activeState === model.widgetState.getMoveHandle() || isDragging)) {
+      model.activeState.setOrigin(worldCoords);
+      publicAPI.invokeInteractionEvent();
+      return macro.EVENT_ABORT;
+    }
+
+    return macro.VOID;
   } // --------------------------------------------------------------------------
   // Right click: Delete handle
   // --------------------------------------------------------------------------
@@ -51,7 +65,8 @@ function widgetBehavior(publicAPI, model) {
     }
 
     if (model.activeState === model.widgetState.getMoveHandle()) {
-      // Commit handle to location
+      updateMoveHandle(e); // Commit handle to location
+
       var moveHandle = model.widgetState.getMoveHandle();
       var newHandle = model.widgetState.addHandle();
       newHandle.setOrigin.apply(newHandle, _toConsumableArray(moveHandle.getOrigin()));
@@ -74,13 +89,7 @@ function widgetBehavior(publicAPI, model) {
 
   publicAPI.handleMouseMove = function (callData) {
     if (model.pickable && model.dragable && model.manipulator && model.activeState && model.activeState.getActive() && !ignoreKey(callData)) {
-      model.manipulator.setOrigin(model.activeState.getOrigin());
-      model.manipulator.setNormal(model._camera.getDirectionOfProjection());
-      var worldCoords = model.manipulator.handleEvent(callData, model._apiSpecificRenderWindow);
-
-      if (worldCoords.length && (model.activeState === model.widgetState.getMoveHandle() || isDragging)) {
-        model.activeState.setOrigin(worldCoords);
-        publicAPI.invokeInteractionEvent();
+      if (updateMoveHandle(callData) === macro.EVENT_ABORT) {
         return macro.EVENT_ABORT;
       }
     }

package/index.d.ts

@@ -2,8 +2,8 @@
 /// <reference path="./interfaces.d.ts" />
 /// <reference path="./macros.d.ts" />
 /// <reference path="./vtk.d.ts" />
-/// <reference path="./Common/Core/CellArray.d.ts" />
 /// <reference path="./Common/Core/Base64.d.ts" />
+/// <reference path="./Common/Core/CellArray.d.ts" />
 /// <reference path="./Common/Core/DataArray.d.ts" />
 /// <reference path="./Common/Core/Endian.d.ts" />
 /// <reference path="./Common/Core/HalfFloat.d.ts" />

package/macros.d.ts

@@ -138,6 +138,16 @@ declare function getStateArrayMapFunc(item: any): any;
  */
 export function setImmediateVTK(fn: () => void ): void;
 
+/**
+ * Measures the time it takes for a promise to finish from the time this function is invoked.
+ *
+ * The callback receives the time it took for the promise to resolve or reject.
+ *
+ * @param promise promise to measure
+ * @param callback called with the elapsed time for the promise
+ */
+export function measurePromiseExecution(promise: Promise<any>, callback: (elapsed: number) => void): void;
+
 /**
  * Turns the provided publicAPI into a VtkObject
  *
@@ -631,6 +641,8 @@ declare const Macro: {
   getStateArrayMapFunc: typeof getStateArrayMapFunc,
   isVtkObject: typeof isVtkObject,
   keystore: typeof keystore,
+  measurePromiseExecution: typeof measurePromiseExecution,
+  moveToProtected: typeof moveToProtected,
   newInstance: typeof newInstance,
   normalizeWheel: typeof normalizeWheel,
   obj: typeof obj,

package/macros.js

@@ -202,6 +202,20 @@ function getStateArrayMapFunc(item) {
 function setImmediateVTK(fn) {
   setTimeout(fn, 0);
 } // ----------------------------------------------------------------------------
+// measurePromiseExecution
+//
+// Measures the time it takes for a promise to finish from
+//   the time this function is invoked.
+// The callback receives the time it took for the promise to resolve or reject.
+// ----------------------------------------------------------------------------
+
+function measurePromiseExecution(promise, callback) {
+  var start = performance.now();
+  promise.finally(function () {
+    var delta = performance.now() - start;
+    callback(delta);
+  });
+} // ----------------------------------------------------------------------------
 // vtkObject: modified(), onModified(callback), delete()
 // ----------------------------------------------------------------------------
 
@@ -1824,6 +1838,7 @@ var macro = {
   getStateArrayMapFunc: getStateArrayMapFunc,
   isVtkObject: isVtkObject,
   keystore: keystore,
+  measurePromiseExecution: measurePromiseExecution,
   moveToProtected: moveToProtected,
   newInstance: newInstance,
   newTypedArray: newTypedArray,
@@ -1854,4 +1869,4 @@ var macro = {
   vtkWarningMacro: vtkWarningMacro
 };
 
-export { EVENT_ABORT, TYPED_ARRAYS, VOID, _capitalize, algo, capitalize, chain, debounce, macro as default, event, formatBytesToProperUnit, formatNumbersWithThousandSeparator, get, getArray, isVtkObject, keystore, moveToProtected, newInstance, newTypedArray, newTypedArrayFrom, normalizeWheel, obj, proxy, proxyPropertyMapping, proxyPropertyState, set, setArray, setGet, setGetArray, setImmediateVTK, setLoggerFunction, throttle, traverseInstanceTree, uncapitalize, vtkDebugMacro, vtkErrorMacro, vtkInfoMacro, vtkLogMacro, vtkOnceErrorMacro, vtkWarningMacro };
+export { EVENT_ABORT, TYPED_ARRAYS, VOID, _capitalize, algo, capitalize, chain, debounce, macro as default, event, formatBytesToProperUnit, formatNumbersWithThousandSeparator, get, getArray, isVtkObject, keystore, measurePromiseExecution, moveToProtected, newInstance, newTypedArray, newTypedArrayFrom, normalizeWheel, obj, proxy, proxyPropertyMapping, proxyPropertyState, set, setArray, setGet, setGetArray, setImmediateVTK, setLoggerFunction, throttle, traverseInstanceTree, uncapitalize, vtkDebugMacro, vtkErrorMacro, vtkInfoMacro, vtkLogMacro, vtkOnceErrorMacro, vtkWarningMacro };

package/package.json

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