@kitware/vtk.js 26.7.0 → 26.8.0

package/Rendering/Core/RenderWindowInteractor.js

@@ -47,7 +47,9 @@ function vtkRenderWindowInteractor(publicAPI, model) {
 
   var animationRequesters = new Set(); // map from pointerId to { pointerId: number, position: [x, y] }
 
-  var pointerCache = new Map(); // Public API methods
+  var pointerCache = new Map(); // Factor to apply on wheel spin.
+
+  var wheelCoefficient = 1; // Public API methods
   //----------------------------------------------------------------------
 
   publicAPI.start = function () {
@@ -622,7 +624,27 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     var callData = _objectSpread(_objectSpread(_objectSpread({}, normalizeWheel(event)), getModifierKeysFor(event)), {}, {
       position: getScreenEventPositionFor(event),
       deviceType: getDeviceTypeFor(event)
-    });
+    }); // Wheel events are thought to scroll pages (i.e. multiple lines at once).
+    // See normalizeWheel() documentation for more context.
+    // While trackpad wheel events are many small (<1) wheel spins,
+    // mouse wheel events have absolute spin values higher than 1.
+    // Here the first spin value is "recorded", and used to normalize
+    // all the following mouse wheel events.
+
+
+    if (model.wheelTimeoutID === 0) {
+      // 0.4 is roughly half-way between a large trackpad first event and small
+      // mouse wheel first event.
+      if (Math.abs(callData.spinY) > 0.4) {
+        // Event is coming from mouse wheel
+        wheelCoefficient = Math.abs(callData.spinY);
+      } else {
+        // Event is coming from trackpad
+        wheelCoefficient = 1;
+      }
+    }
+
+    callData.spinY /= wheelCoefficient;
 
     if (model.wheelTimeoutID === 0) {
       publicAPI.startMouseWheelEvent(callData);

package/Rendering/OpenGL/RenderWindow/Constants.d.ts

@@ -0,0 +1,10 @@
+export declare enum XrSessionTypes {
+	HmdVR = 0,
+	MobileAR = 1,
+  LookingGlassVR = 2
+}
+
+declare const _default: {
+	XrSessionTypes: typeof XrSessionTypes;
+};
+export default _default;

package/Rendering/OpenGL/RenderWindow/Constants.js

@@ -0,0 +1,13 @@
+var XrSessionTypes = {
+  HmdVR: 0,
+  // Head-mounted display (HMD), two-camera virtual reality session
+  MobileAR: 1,
+  // Mobile device, single-camera augmented reality session
+  LookingGlassVR: 2 // Looking Glass hologram display, N-camera virtual reality session
+
+};
+var Constants = {
+  XrSessionTypes: XrSessionTypes
+};
+
+export { XrSessionTypes, Constants as default };

package/Rendering/OpenGL/RenderWindow.d.ts

@@ -232,19 +232,34 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 	get3DContext(options: I3DContextOptions): Nullable<WebGLRenderingContext>;
 
 	/**
-	 *
+	 * Request an XR session on the user device with WebXR,
+   * typically in response to a user request such as a button press.
 	 */
-	startVR(): void;
+	startXR(): void;
+
+  /**
+   * When an XR session is available, set up the XRWebGLLayer
+   * and request the first animation frame for the device
+   */
+   enterXR(): void,
+
+   /**
+    * Adjust world-to-physical parameters for different viewing modalities
+    *
+    * @param {Number} inputRescaleFactor
+    * @param {Number} inputTranslateZ
+    */
+   resetXRScene(inputRescaleFactor: number, inputTranslateZ: number): void,
 
 	/**
-	 *
+	 * Request to stop the current XR session
 	 */
-	stopVR(): void;
+	stopXR(): void;
 
 	/**
 	 *
 	 */
-	vrRender(): void;
+	xrRender(): void;
 
 	/**
 	 *

package/Rendering/OpenGL/RenderWindow.js

@@ -12,10 +12,12 @@ import vtkTextureUnitManager from './TextureUnitManager.js';
 import vtkViewNodeFactory from './ViewNodeFactory.js';
 import vtkRenderPass from '../SceneGraph/RenderPass.js';
 import vtkRenderWindowViewNode from '../SceneGraph/RenderWindowViewNode.js';
+import Constants from './RenderWindow/Constants.js';
 import { createContextProxyHandler, GET_UNDERLYING_CONTEXT } from './RenderWindow/ContextProxy.js';
 
 var vtkDebugMacro = macro.vtkDebugMacro,
     vtkErrorMacro = macro.vtkErrorMacro;
+var XrSessionTypes = Constants.XrSessionTypes;
 var SCREENSHOT_PLACEHOLDER = {
   position: 'absolute',
   top: 0,
@@ -266,12 +268,13 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
   // typically in response to a user request such as a button press
 
 
-  publicAPI.startXR = function (isAR) {
+  publicAPI.startXR = function (xrSessionType) {
     if (navigator.xr === undefined) {
       throw new Error('WebXR is not available');
     }
 
-    model.xrSessionIsAR = isAR;
+    model.xrSessionType = xrSessionType !== undefined ? xrSessionType : XrSessionTypes.HmdVR;
+    var isAR = xrSessionType === XrSessionTypes.MobileAR;
     var sessionType = isAR ? 'immersive-ar' : 'immersive-vr';
 
     if (!navigator.xr.isSessionSupported(sessionType)) {
@@ -348,16 +351,17 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
     var inputRescaleFactor = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_RESET_FACTORS.vr.rescaleFactor;
     var inputTranslateZ = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_RESET_FACTORS.vr.translateZ;
     // Adjust world-to-physical parameters for different modalities
-    // Default parameter values are for VR (model.xrSessionIsAR == false)
+    // Default parameter values are for HMD VR
     var rescaleFactor = inputRescaleFactor;
     var translateZ = inputTranslateZ;
+    var isXrSessionAR = model.xrSessionType === XrSessionTypes.MobileAR;
 
-    if (model.xrSessionIsAR && rescaleFactor === DEFAULT_RESET_FACTORS.vr.rescaleFactor) {
+    if (isXrSessionAR && rescaleFactor === DEFAULT_RESET_FACTORS.vr.rescaleFactor) {
       // Scale down by default in AR
       rescaleFactor = DEFAULT_RESET_FACTORS.ar.rescaleFactor;
     }
 
-    if (model.xrSessionIsAR && translateZ === DEFAULT_RESET_FACTORS.vr.translateZ) {
+    if (isXrSessionAR && translateZ === DEFAULT_RESET_FACTORS.vr.translateZ) {
       // Default closer to the camera in AR
       translateZ = DEFAULT_RESET_FACTORS.ar.translateZ;
     }
@@ -444,7 +448,7 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
               if (xrPose) {
                 gl = publicAPI.get3DContext();
 
-                if (model.xrSessionIsAR && model.oldCanvasSize !== undefined) {
+                if (model.xrSessionType === XrSessionTypes.MobileAR && model.oldCanvasSize !== undefined) {
                   gl.canvas.width = model.oldCanvasSize[0];
                   gl.canvas.height = model.oldCanvasSize[1];
                 }
@@ -452,16 +456,16 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
                 glLayer = xrSession.renderState.baseLayer;
                 gl.bindFramebuffer(gl.FRAMEBUFFER, glLayer.framebuffer);
                 gl.clear(gl.COLOR_BUFFER_BIT);
-                gl.clear(gl.DEPTH_BUFFER_BIT); // get the first renderer
+                gl.clear(gl.DEPTH_BUFFER_BIT);
+                publicAPI.setSize(glLayer.framebufferWidth, glLayer.framebufferHeight); // get the first renderer
 
                 ren = model.renderable.getRenderers()[0]; // Do a render pass for each eye
 
-                xrPose.views.forEach(function (view) {
-                  var viewport = glLayer.getViewport(view);
-                  gl.viewport(viewport.x, viewport.y, viewport.width, viewport.height); // TODO: Appropriate handling for AR passthrough on HMDs
+                xrPose.views.forEach(function (view, index) {
+                  var viewport = glLayer.getViewport(view); // TODO: Appropriate handling for AR passthrough on HMDs
                   // with two eyes will require further investigation.
 
-                  if (!model.xrSessionIsAR) {
+                  if (model.xrSessionType === XrSessionTypes.HmdVR) {
                     if (view.eye === 'left') {
                       ren.setViewport(0, 0, 0.5, 1.0);
                     } else if (view.eye === 'right') {
@@ -470,12 +474,24 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
                       // No handling for non-eye viewport
                       return;
                     }
+                  } else if (model.xrSessionType === XrSessionTypes.LookingGlassVR) {
+                    var startX = viewport.x / glLayer.framebufferWidth;
+                    var startY = viewport.y / glLayer.framebufferHeight;
+                    var endX = (viewport.x + viewport.width) / glLayer.framebufferWidth;
+                    var endY = (viewport.y + viewport.height) / glLayer.framebufferHeight;
+                    ren.setViewport(startX, startY, endX, endY);
+                  } else {
+                    ren.setViewport(0, 0, 1, 1);
                   }
 
                   ren.getActiveCamera().computeViewParametersFromPhysicalMatrix(view.transform.inverse.matrix);
                   ren.getActiveCamera().setProjectionMatrix(view.projectionMatrix);
                   publicAPI.traverseAllPasses();
-                });
+                }); // Reset scissorbox before any subsequent rendering to external displays
+                // on frame end, such as rendering to a Looking Glass display.
+
+                gl.scissor(0, 0, glLayer.framebufferWidth, glLayer.framebufferHeight);
+                gl.disable(gl.SCISSOR_TEST);
               }
 
             case 5:
@@ -919,7 +935,6 @@ var DEFAULT_VALUES = {
   // attempt webgl2 on by default
   activeFramebuffer: null,
   xrSession: null,
-  xrSessionIsAR: false,
   xrReferenceSpace: null,
   xrSupported: true,
   imageFormat: 'image/png',

package/index.d.ts

@@ -191,6 +191,7 @@
 /// <reference path="./Rendering/Misc/SynchronizableRenderWindow/ObjectManager.d.ts" />
 /// <reference path="./Rendering/Misc/SynchronizableRenderWindow.d.ts" />
 /// <reference path="./Rendering/Misc/TextureLODsDownloader.d.ts" />
+/// <reference path="./Rendering/OpenGL/RenderWindow/Constants.d.ts" />
 /// <reference path="./Rendering/OpenGL/RenderWindow.d.ts" />
 /// <reference path="./Rendering/SceneGraph/RenderPass.d.ts" />
 /// <reference path="./Rendering/SceneGraph/ViewNode.d.ts" />

package/package.json

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