@kitware/vtk.js 27.4.6 → 27.5.0

package/Rendering/OpenGL/RenderWindow/Constants.js

@@ -3,8 +3,9 @@ var XrSessionTypes = {
   // 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
-
+  LookingGlassVR: 2,
+  // Looking Glass hologram display, N-camera virtual reality session
+  HmdAR: 3
 };
 var Constants = {
   XrSessionTypes: XrSessionTypes

package/Rendering/OpenGL/RenderWindow.js

@@ -26,17 +26,10 @@ var SCREENSHOT_PLACEHOLDER = {
   height: '100%'
 };
 var DEFAULT_RESET_FACTORS = {
-  vr: {
-    rescaleFactor: 1.0,
-    translateZ: -0.7 // 0.7 m forward from the camera
+  rescaleFactor: 0.25,
+  // isotropic scale factor reduces apparent size of objects
+  translateZ: -1.5 // default translation initializes object in front of camera
 
-  },
-  ar: {
-    rescaleFactor: 0.25,
-    // scale down AR for viewing comfort by default
-    translateZ: -0.5 // 0.5 m forward from the camera
-
-  }
 };
 
 function checkRenderTargetSupport(gl, format, type) {
@@ -274,11 +267,11 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
     }
 
     model.xrSessionType = xrSessionType !== undefined ? xrSessionType : XrSessionTypes.HmdVR;
-    var isAR = xrSessionType === XrSessionTypes.MobileAR;
-    var sessionType = isAR ? 'immersive-ar' : 'immersive-vr';
+    var isXrSessionAR = [XrSessionTypes.HmdAR, XrSessionTypes.MobileAR].includes(model.xrSessionType);
+    var sessionType = isXrSessionAR ? 'immersive-ar' : 'immersive-vr';
 
     if (!navigator.xr.isSessionSupported(sessionType)) {
-      if (isAR) {
+      if (isXrSessionAR) {
         throw new Error('Device does not support AR session');
       } else {
         throw new Error('VR display is not available');
@@ -298,7 +291,7 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
 
   publicAPI.enterXR = /*#__PURE__*/function () {
     var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(xrSession) {
-      var gl, glLayer;
+      var gl, glLayer, isXrSessionAR, ren;
       return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) {
           switch (_context.prev = _context.next) {
@@ -307,7 +300,7 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
               model.oldCanvasSize = model.size.slice();
 
               if (!(model.xrSession !== null)) {
-                _context.next = 15;
+                _context.next = 17;
                 break;
               }
 
@@ -324,17 +317,26 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
               });
               model.xrSession.requestReferenceSpace('local').then(function (refSpace) {
                 model.xrReferenceSpace = refSpace;
-              });
+              }); // Initialize transparent background for augmented reality session
+
+              isXrSessionAR = [XrSessionTypes.HmdAR, XrSessionTypes.MobileAR].includes(model.xrSessionType);
+
+              if (isXrSessionAR) {
+                ren = model.renderable.getRenderers()[0];
+                model.preXrSessionBackground = ren.getBackground();
+                ren.setBackground([0, 0, 0, 0]);
+              }
+
               publicAPI.resetXRScene();
               model.renderable.getInteractor().switchToXRAnimation();
               model.xrSceneFrame = model.xrSession.requestAnimationFrame(publicAPI.xrRender);
-              _context.next = 16;
+              _context.next = 18;
               break;
 
-            case 15:
-              throw new Error('Failed to enter VR with a null xrSession.');
+            case 17:
+              throw new Error('Failed to enter XR with a null xrSession.');
 
-            case 16:
+            case 18:
             case "end":
               return _context.stop();
           }
@@ -348,32 +350,17 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
   }();
 
   publicAPI.resetXRScene = function () {
-    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;
+    var rescaleFactor = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_RESET_FACTORS.rescaleFactor;
+    var translateZ = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DEFAULT_RESET_FACTORS.translateZ;
     // Adjust world-to-physical parameters for different modalities
-    // Default parameter values are for HMD VR
-    var rescaleFactor = inputRescaleFactor;
-    var translateZ = inputTranslateZ;
-    var isXrSessionAR = model.xrSessionType === XrSessionTypes.MobileAR;
-
-    if (isXrSessionAR && rescaleFactor === DEFAULT_RESET_FACTORS.vr.rescaleFactor) {
-      // Scale down by default in AR
-      rescaleFactor = DEFAULT_RESET_FACTORS.ar.rescaleFactor;
-    }
-
-    if (isXrSessionAR && translateZ === DEFAULT_RESET_FACTORS.vr.translateZ) {
-      // Default closer to the camera in AR
-      translateZ = DEFAULT_RESET_FACTORS.ar.translateZ;
-    }
-
     var ren = model.renderable.getRenderers()[0];
     ren.resetCamera();
     var camera = ren.getActiveCamera();
     var physicalScale = camera.getPhysicalScale();
     var physicalTranslation = camera.getPhysicalTranslation();
+    var rescaledTranslateZ = translateZ * physicalScale;
     physicalScale /= rescaleFactor;
-    translateZ *= physicalScale;
-    physicalTranslation[2] += translateZ;
+    physicalTranslation[2] += rescaledTranslateZ;
     camera.setPhysicalScale(physicalScale);
     camera.setPhysicalTranslation(physicalTranslation); // Clip at 0.1m, 100.0m in physical space by default
 
@@ -420,12 +407,18 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
 
 
             ren = model.renderable.getRenderers()[0];
+
+            if (model.preXrSessionBackground != null) {
+              ren.setBackground(model.preXrSessionBackground);
+              model.preXrSessionBackground = null;
+            }
+
             ren.getActiveCamera().setProjectionMatrix(null);
             ren.resetCamera();
             ren.setViewport(0.0, 0, 1.0, 1.0);
             publicAPI.traverseAllPasses();
 
-          case 16:
+          case 17:
           case "end":
             return _context2.stop();
         }
@@ -435,12 +428,13 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
 
   publicAPI.xrRender = /*#__PURE__*/function () {
     var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(t, frame) {
-      var xrSession, xrPose, gl, glLayer, ren;
+      var xrSession, isXrSessionHMD, xrPose, gl, glLayer, ren;
       return _regeneratorRuntime.wrap(function _callee3$(_context3) {
         while (1) {
           switch (_context3.prev = _context3.next) {
             case 0:
               xrSession = frame.session;
+              isXrSessionHMD = [XrSessionTypes.HmdVR, XrSessionTypes.HmdAR].includes(model.xrSessionType);
               model.renderable.getInteractor().updateXRGamepads(xrSession, frame, model.xrReferenceSpace);
               model.xrSceneFrame = model.xrSession.requestAnimationFrame(publicAPI.xrRender);
               xrPose = frame.getViewerPose(model.xrReferenceSpace);
@@ -462,10 +456,9 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
                 ren = model.renderable.getRenderers()[0]; // Do a render pass for each eye
 
                 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.
+                  var viewport = glLayer.getViewport(view);
 
-                  if (model.xrSessionType === XrSessionTypes.HmdVR) {
+                  if (isXrSessionHMD) {
                     if (view.eye === 'left') {
                       ren.setViewport(0, 0, 0.5, 1.0);
                     } else if (view.eye === 'right') {
@@ -494,7 +487,7 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
                 gl.disable(gl.SCISSOR_TEST);
               }
 
-            case 5:
+            case 6:
             case "end":
               return _context3.stop();
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitware/vtk.js",
-  "version": "27.4.6",
+  "version": "27.5.0",
   "description": "Visualization Toolkit for the Web",
   "keywords": [
     "3d",
@@ -144,7 +144,8 @@
     "doc:publish": "kw-doc -c ./Documentation/config.js -mp",
     "doc:generate-api": "node ./Documentation/generate-api-docs.js",
     "example": "node ./Utilities/ExampleRunner/example-runner-cli.js -c ./Documentation/config.js",
-    "example:webgpu": "cross-env WEBGPU=1 NO_WEBGL=1 node ./Utilities/ExampleRunner/example-runner-cli.js -c ./Documentation/config.js",
+    "example:https": "node ./Utilities/ExampleRunner/example-runner-cli.js --server-type https -c ./Documentation/config.js",
+    "example:webgpu": "cross-env WEBGPU=1 NO_WEBGL=1 node ./Utilities/ExampleRunner/example-runner-cli.js --server-type https -c ./Documentation/config.js",
     "dev:esm": "npm run build:esm -- -w",
     "dev:umd": "webpack --watch --config webpack.dev.js --progress",
     "build": "npm run build:release",