Merge branch 'master' into webgpu_update_jan22

Author: martinken

CONTRIBUTING.md

@@ -62,7 +62,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 Travis-CI to test proposed patches before they are merged.
+8. vtk.js uses GitHub for code review and Github Actions to validate proposed patches before they are merged.
 
 ## Release Channels
 
@@ -110,7 +110,7 @@ you are satisfied with the staging branch changes, you can then merge into eithe
 
 To create and debug a test:
 - Create a testFuncNameToTest.js in a "test" folder of the class to test.
-- Add the test path into Sources/tests.js and temporarily comment the other tests
+- If you want to run just your test, use `test.only(...)` instead of `test(...)`.
 - Run `npm run test:debug`
 - In the opened window, click the Debug button and place breakpoints in browser debugger.
 

Sources/Rendering/OpenGL/RenderWindow/index.js

@@ -19,6 +19,17 @@ const SCREENSHOT_PLACEHOLDER = {
   height: '100%',
 };
 
+const DEFAULT_RESET_FACTORS = {
+  vr: {
+    rescaleFactor: 1.0,
+    translateZ: -0.7, // 0.7 m forward from the 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) {
   // create temporary frame buffer and texture
   const framebuffer = gl.createFramebuffer();
@@ -315,6 +326,8 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
         model.xrReferenceSpace = refSpace;
       });
 
+      publicAPI.resetXRScene();
+
       model.renderable.getInteractor().switchToXRAnimation();
       model.xrSceneFrame = model.xrSession.requestAnimationFrame(
         publicAPI.xrRender
@@ -324,6 +337,46 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
     }
   };
 
+  publicAPI.resetXRScene = (
+    inputRescaleFactor = DEFAULT_RESET_FACTORS.vr.rescaleFactor,
+    inputTranslateZ = DEFAULT_RESET_FACTORS.vr.translateZ
+  ) => {
+    // Adjust world-to-physical parameters for different modalities
+    // Default parameter values are for VR (model.xrSessionIsAR == false)
+    let rescaleFactor = inputRescaleFactor;
+    let translateZ = inputTranslateZ;
+
+    if (
+      model.xrSessionIsAR &&
+      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
+    ) {
+      // Default closer to the camera in AR
+      translateZ = DEFAULT_RESET_FACTORS.ar.translateZ;
+    }
+
+    const ren = model.renderable.getRenderers()[0];
+    ren.resetCamera();
+
+    const camera = ren.getActiveCamera();
+    let physicalScale = camera.getPhysicalScale();
+    const physicalTranslation = camera.getPhysicalTranslation();
+
+    physicalScale /= rescaleFactor;
+    translateZ *= physicalScale;
+    physicalTranslation[2] += translateZ;
+
+    camera.setPhysicalScale(physicalScale);
+    camera.setPhysicalTranslation(physicalTranslation);
+  };
+
   publicAPI.stopXR = async () => {
     if (navigator.xr === undefined) {
       // WebXR polyfill not available so nothing to do