@kitware/vtk.js 29.4.4 → 29.4.6

package/Rendering/Core/RenderWindowInteractor.d.ts

@@ -93,7 +93,7 @@ export interface vtkRenderWindowInteractor extends vtkObject {
 	 *
 	 * @default null
 	 */
-	getContainer(): HTMLElement;
+	getContainer(): Nullable<HTMLElement>;
 
 	/**
 	 *
@@ -827,6 +827,13 @@ export interface vtkRenderWindowInteractor extends vtkObject {
 	 */
 	rotateEvent(args: any): any;
 
+	/**
+	 * Add an HTMLElement as the new container for the interactor.
+	 * All events will be bound to this new container.
+	 * Any old container will be removed along with its listeners.
+	 */
+	setContainer(container: Nullable<HTMLElement>): boolean;
+
 	/**
 	 * Turn on/off the automatic repositioning of lights as the camera moves.
 	 * @param lightFollowCamera
@@ -992,12 +999,15 @@ export interface vtkRenderWindowInteractor extends vtkObject {
 
 	/**
 	 *
-	 * @param container
+	 * @param container kept for backward compatibility.
+	 * @deprecated please use vtkRenderWindowInteractor.setContainer(container: HTMLElement)
+	 *     which will also bind events.
 	 */
 	bindEvents(container: any): void;
 
 	/**
 	 *
+	 * @deprecated please use vtkRenderWindowInteractor.setContainer(null) instead.
 	 */
 	unbindEvents(): void;
 

package/Rendering/Core/RenderWindowInteractor.js

@@ -51,6 +51,11 @@ function vtkRenderWindowInteractor(publicAPI, model) {
   // Set our className
   model.classHierarchy.push('vtkRenderWindowInteractor');
 
+  // Capture "parentClass" api for internal use
+  const superClass = {
+    ...publicAPI
+  };
+
   // Initialize list of requesters
   const animationRequesters = new Set();
 
@@ -161,8 +166,13 @@ function vtkRenderWindowInteractor(publicAPI, model) {
   function getDeviceTypeFor(event) {
     return event.pointerType || '';
   }
-  publicAPI.bindEvents = container => {
-    model.container = container;
+  const _bindEvents = () => {
+    if (model.container === null) {
+      return;
+    }
+    const {
+      container
+    } = model;
     container.addEventListener('contextmenu', preventDefault);
     container.addEventListener('wheel', publicAPI.handleWheel);
     container.addEventListener('DOMMouseScroll', publicAPI.handleWheel);
@@ -188,30 +198,53 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     // disables tap highlight for when cursor is pointer
     container.style.webkitTapHighlightColor = 'rgba(0,0,0,0)';
   };
-  publicAPI.unbindEvents = () => {
+
+  // For backward compatibility.
+  // Necessary for using unbind/bindEvent without calling setContainer.
+  publicAPI.bindEvents = container => {
+    if (container === null) {
+      return;
+    }
+    const res = superClass.setContainer(container);
+    if (res) {
+      _bindEvents();
+    }
+  };
+  const _unbindEvents = () => {
+    // Clear any previous timeouts and state variables that control mouse / touchpad behavior.
+    clearTimeout(model.moveTimeoutID);
+    clearTimeout(model.wheelTimeoutID);
+    model.moveTimeoutID = 0;
+    model.wheelTimeoutID = 0;
+    wheelCoefficient = 1.0;
     const {
       container
     } = model;
-    container.removeEventListener('contextmenu', preventDefault);
-    container.removeEventListener('wheel', publicAPI.handleWheel);
-    container.removeEventListener('DOMMouseScroll', publicAPI.handleWheel);
-    container.removeEventListener('pointerenter', publicAPI.handlePointerEnter);
-    container.removeEventListener('pointerleave', publicAPI.handlePointerLeave);
-    container.removeEventListener('pointermove', publicAPI.handlePointerMove, {
-      passive: false
-    });
-    container.removeEventListener('pointerdown', publicAPI.handlePointerDown, {
-      passive: false
-    });
-    container.removeEventListener('pointerup', publicAPI.handlePointerUp);
-    container.removeEventListener('pointercancel', publicAPI.handlePointerCancel);
+    if (container) {
+      container.removeEventListener('contextmenu', preventDefault);
+      container.removeEventListener('wheel', publicAPI.handleWheel);
+      container.removeEventListener('DOMMouseScroll', publicAPI.handleWheel);
+      container.removeEventListener('pointerenter', publicAPI.handlePointerEnter);
+      container.removeEventListener('pointerleave', publicAPI.handlePointerLeave);
+      container.removeEventListener('pointermove', publicAPI.handlePointerMove, {
+        passive: false
+      });
+      container.removeEventListener('pointerdown', publicAPI.handlePointerDown, {
+        passive: false
+      });
+      container.removeEventListener('pointerup', publicAPI.handlePointerUp);
+      container.removeEventListener('pointercancel', publicAPI.handlePointerCancel);
+    }
     document.removeEventListener('keypress', publicAPI.handleKeyPress);
     document.removeEventListener('keydown', publicAPI.handleKeyDown);
     document.removeEventListener('keyup', publicAPI.handleKeyUp);
     document.removeEventListener('pointerlockchange', publicAPI.handlePointerLockChange);
-    model.container = null;
     pointerCache.clear();
   };
+  publicAPI.unbindEvents = () => {
+    _unbindEvents();
+    superClass.setContainer(null);
+  };
   publicAPI.handleKeyPress = event => {
     const data = getKeysFor(event);
     publicAPI.keyPressEvent(data);
@@ -947,9 +980,16 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     model._forcedRenderer = !!r;
     model.currentRenderer = r;
   };
+  publicAPI.setContainer = container => {
+    _unbindEvents();
+    const res = superClass.setContainer(container ?? null);
+    if (res) {
+      _bindEvents();
+    }
+    return res;
+  };
 
   // Stop animating if the renderWindowInteractor is deleted.
-  const superDelete = publicAPI.delete;
   publicAPI.delete = () => {
     while (animationRequesters.size) {
       publicAPI.cancelAnimation(animationRequesters.values().next().value);
@@ -958,9 +998,9 @@ function vtkRenderWindowInteractor(publicAPI, model) {
       document.removeEventListener('visibilitychange', publicAPI.handleVisibilityChange);
     }
     if (model.container) {
-      publicAPI.unbindEvents();
+      publicAPI.setContainer(null);
     }
-    superDelete();
+    superClass.delete();
   };
 
   // Use the Page Visibility API to detect when we switch away from or back to
@@ -1017,10 +1057,10 @@ function extend(publicAPI, model) {
   handledEvents.forEach(eventName => macro.event(publicAPI, model, eventName));
 
   // Create get-only macros
-  macro.get(publicAPI, model, ['initialized', 'container', 'interactorStyle', 'lastFrameTime', 'recentAnimationFrameRate', '_view']);
+  macro.get(publicAPI, model, ['initialized', 'interactorStyle', 'lastFrameTime', 'recentAnimationFrameRate', '_view']);
 
   // Create get-set macros
-  macro.setGet(publicAPI, model, ['lightFollowCamera', 'enabled', 'enableRender', 'recognizeGestures', 'desiredUpdateRate', 'stillUpdateRate', 'picker', 'preventDefaultOnPointerDown', 'preventDefaultOnPointerUp', 'mouseScrollDebounceByPass']);
+  macro.setGet(publicAPI, model, ['container', 'lightFollowCamera', 'enabled', 'enableRender', 'recognizeGestures', 'desiredUpdateRate', 'stillUpdateRate', 'picker', 'preventDefaultOnPointerDown', 'preventDefaultOnPointerUp', 'mouseScrollDebounceByPass']);
   macro.moveToProtected(publicAPI, model, ['view']);
 
   // For more macro methods, see "Sources/macros.js"

package/Widgets/Manipulators/LineManipulator.js

@@ -1,8 +1,14 @@
 import { m as macro } from '../../macros2.js';
-import { s as subtract, j as cross, d as dot, w as multiplyScalar, k as add } from '../../Common/Core/Math/index.js';
+import { d as dot, s as subtract, j as cross, w as multiplyScalar, k as add } from '../../Common/Core/Math/index.js';
 import vtkAbstractManipulator from './AbstractManipulator.js';
+import { EPSILON } from '../../Common/Core/Math/Constants.js';
 
 function projectDisplayToLine(x, y, lineOrigin, lineDirection, renderer, glRenderWindow) {
+  // if the active camera viewPlaneNormal and line direction are parallel, no change is allowed
+  const dotProduct = Math.abs(dot(renderer.getActiveCamera().getViewPlaneNormal(), lineDirection));
+  if (1 - dotProduct < EPSILON) {
+    return [];
+  }
   const near = glRenderWindow.displayToWorld(x, y, 0, renderer);
   const far = glRenderWindow.displayToWorld(x, y, 1, renderer);
   const viewDir = [0, 0, 0];

package/Widgets/Manipulators/PickerManipulator.js

@@ -15,11 +15,13 @@ function vtkPickerManipulator(publicAPI, model) {
       pokedRenderer
     } = callData;
     model.picker.pick([position.x, position.y, 0.0], pokedRenderer);
-    if (model.picker.getActors().length > 0) {
+    if (model.picker.getPickedPositions().length > 0) {
       model.position = model.picker.getPickedPositions()[0];
+    } else {
+      model.position = null;
     }
     return {
-      worldCoords: model.position || null
+      worldCoords: model.position
     };
   };
 }

package/Widgets/Widgets3D/PaintWidget/behavior.js

@@ -3,8 +3,17 @@ import { vec3 } from 'gl-matrix';
 
 function widgetBehavior(publicAPI, model) {
   model.painting = model._factory.getPainting();
-  publicAPI.handleLeftButtonPress = () => {
-    if (!model.activeState || !model.activeState.getActive()) {
+  publicAPI.handleLeftButtonPress = callData => {
+    const manipulator = model.activeState?.getManipulator?.() ?? model.manipulator;
+    if (!(manipulator && model.activeState && model.activeState.getActive())) {
+      model.painting = false;
+      return macro.VOID;
+    }
+    const {
+      worldCoords
+    } = manipulator.handleEvent(callData, model._apiSpecificRenderWindow);
+    if (!worldCoords?.length) {
+      model.painting = false;
       return macro.VOID;
     }
     model.painting = true;
@@ -20,11 +29,12 @@ function widgetBehavior(publicAPI, model) {
       model.widgetState.clearTrailList();
     }
     model.painting = false;
-    return model.hasFocus ? macro.EVENT_ABORT : macro.VOID;
+    return macro.VOID;
   };
   publicAPI.handleEvent = callData => {
     const manipulator = model.activeState?.getManipulator?.() ?? model.manipulator;
     if (!(manipulator && model.activeState && model.activeState.getActive())) {
+      model.painting = false;
       return macro.VOID;
     }
     const normal = model._camera.getDirectionOfProjection();
@@ -37,7 +47,7 @@ function widgetBehavior(publicAPI, model) {
     const {
       worldCoords
     } = manipulator.handleEvent(callData, model._apiSpecificRenderWindow);
-    if (!worldCoords.length) {
+    if (!worldCoords?.length) {
       return macro.VOID;
     }
     model.widgetState.setTrueOrigin(...worldCoords);
@@ -45,6 +55,8 @@ function widgetBehavior(publicAPI, model) {
     if (model.painting) {
       const trailCircle = model.widgetState.addTrail();
       trailCircle.set(model.activeState.get('origin', 'up', 'right', 'direction', 'scale1'));
+    } else {
+      return macro.VOID;
     }
     publicAPI.invokeInteractionEvent();
     return macro.EVENT_ABORT;

package/Widgets/Widgets3D/SeedWidget/behavior.js

@@ -30,13 +30,13 @@ function widgetBehavior(publicAPI, model) {
     }
     const worldCoords = currentWorldCoords(e);
     if (model.activeState === moveHandle) {
-      if (!moveHandle.getOrigin()) {
+      if (!moveHandle.getOrigin() && worldCoords) {
         moveHandle.setOrigin(worldCoords);
+        model.previousPosition = [...worldCoords];
       }
     }
     model._isDragging = true;
     model._apiSpecificRenderWindow.setCursor('grabbing');
-    model.previousPosition = [...currentWorldCoords(e)];
     publicAPI.invokeStartInteractionEvent();
     return macro.EVENT_ABORT;
   };
@@ -63,8 +63,10 @@ function widgetBehavior(publicAPI, model) {
     }
     if (!model.activeState) throw Error('no activestate');
     const worldCoords = currentWorldCoords(e);
-    model.activeState.setOrigin(worldCoords);
-    model.previousPosition = worldCoords;
+    if (worldCoords) {
+      model.activeState.setOrigin(worldCoords);
+      model.previousPosition = worldCoords;
+    }
     return macro.VOID;
   };
   publicAPI.grabFocus = () => {

package/package.json

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