Merge branch 'master' of https://github.com/rodrigobasilio2022/vtk-js …

…into feat/VolumePicker
Kitware · Oct 27, 2023 · 4f1d762 · 4f1d762
2 parents 1839b16 + d61d2e4
commit 4f1d762
Show file tree

Hide file tree

Showing 42 changed files with 535 additions and 810 deletions.
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-20.04]
-        node: [14, 16, 18]
+        node: [18, 20]
     name: ${{ matrix.os }} and node ${{ matrix.node }}
     steps:
       - uses: actions/checkout@v2

diff --git a/.github/workflows/pr-checks.yml b/.github/workflows/pr-checks.yml
@@ -14,7 +14,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v1
         with:
-          node-version: 16
+          node-version: 20
       - run: npm ci
       - name: Enforce code style
         run: npm run validate

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -21,7 +21,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v1
         with:
-          node-version: 16
+          node-version: 20
       - name: Install dependencies
         run: |
           npm ci

diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md
@@ -1,3 +1,10 @@
+## From 28.x to 29
+
+- **getOpenGLRenderWindow**: `getOpenGLRenderWindow` has been renamed to `getApiSpecificRenderWindow` in `vtkFullScreenRenderWindow`, `vtkGenericRenderWindow` and `vtkViewProxy` to support WebGL and WebGPU backend. ([#2816](https://github.com/Kitware/vtk-js/pull/2816))
+- **WidgetManager**: Deprecated APIs have been fully removed. ([#2910](https://github.com/Kitware/vtk-js/pull/2910))
+- **OpenGLRenderWindow**: WebXR API has been moved into a WebXR RenderWindowHelper. ([#2924](https://github.com/Kitware/vtk-js/pull/2924))
+- **DistanceWidget**: Removed from vtk.js in favor of vtkLineWidget ([#2945](https://github.com/Kitware/vtk-js/pull/2945))
+
 ## From 27.x to 28
 
 - **vtkManipulator.handleEvent**: Change all `handleEvent` signatures of manipulators. Used to be `handleEvent(callData, glRenderWindow): vec3`, it is now `handleEvent(callData, glRenderWindow): { worldCoords: Nullable<vec3>, worldDirection?: mat3 }`.

diff --git a/Examples/Applications/GeometryViewer/index.js b/Examples/Applications/GeometryViewer/index.js
@@ -14,11 +14,12 @@ import vtkScalarBarActor from '@kitware/vtk.js/Rendering/Core/ScalarBarActor';
 import vtkColorMaps from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction/ColorMaps';
 import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction';
 import vtkFullScreenRenderWindow from '@kitware/vtk.js/Rendering/Misc/FullScreenRenderWindow';
+import vtkWebXRRenderWindowHelper from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper';
 import vtkMapper from '@kitware/vtk.js/Rendering/Core/Mapper';
 import vtkURLExtract from '@kitware/vtk.js/Common/Core/URLExtract';
 import vtkXMLPolyDataReader from '@kitware/vtk.js/IO/XML/XMLPolyDataReader';
 import vtkFPSMonitor from '@kitware/vtk.js/Interaction/UI/FPSMonitor';
-import { XrSessionTypes } from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow/Constants';
+import { XrSessionTypes } from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper/Constants';
 
 // Force DataAccessHelper to have access to various data source
 import '@kitware/vtk.js/IO/Core/DataAccessHelper/HtmlDataAccessHelper';
@@ -36,6 +37,7 @@ let autoInit = true;
 let background = [0, 0, 0];
 let fullScreenRenderWindow;
 let renderWindow;
+let xrRenderWindowHelper;
 let renderer;
 let scalarBarActor;
 
@@ -162,6 +164,9 @@ function createViewer(container) {
   });
   renderer = fullScreenRenderWindow.getRenderer();
   renderWindow = fullScreenRenderWindow.getRenderWindow();
+  xrRenderWindowHelper = vtkWebXRRenderWindowHelper.newInstance({
+    renderWindow: fullScreenRenderWindow.getApiSpecificRenderWindow(),
+  });
   renderWindow.getInteractor().setDesiredUpdateRate(15);
 
   container.appendChild(rootControllerContainer);
@@ -252,7 +257,7 @@ function createPipeline(fileName, fileContents) {
 
   if (
     navigator.xr !== undefined &&
-    fullScreenRenderWindow.getApiSpecificRenderWindow().getXrSupported() &&
+    xrRenderWindowHelper.getXrSupported() &&
     requestedXrSessionType !== null
   ) {
     controlContainer.appendChild(immersionSelector);
@@ -431,17 +436,15 @@ function createPipeline(fileName, fileContents) {
 
   function toggleXR() {
     if (immersionSelector.textContent.startsWith('Start')) {
-      fullScreenRenderWindow
-        .getApiSpecificRenderWindow()
-        .startXR(requestedXrSessionType);
+      xrRenderWindowHelper.startXR(requestedXrSessionType);
       immersionSelector.textContent = [
         XrSessionTypes.HmdAR,
         XrSessionTypes.MobileAR,
       ].includes(requestedXrSessionType)
         ? 'Exit AR'
         : 'Exit VR';
     } else {
-      fullScreenRenderWindow.getApiSpecificRenderWindow().stopXR();
+      xrRenderWindowHelper.stopXR();
       immersionSelector.textContent = [
         XrSessionTypes.HmdAR,
         XrSessionTypes.MobileAR,

diff --git a/Examples/Applications/SkyboxViewer/index.js b/Examples/Applications/SkyboxViewer/index.js
@@ -10,10 +10,11 @@ import HttpDataAccessHelper from '@kitware/vtk.js/IO/Core/DataAccessHelper/HttpD
 import macro from '@kitware/vtk.js/macros';
 import vtkDeviceOrientationToCamera from '@kitware/vtk.js/Interaction/Misc/DeviceOrientationToCamera';
 import vtkFullScreenRenderWindow from '@kitware/vtk.js/Rendering/Misc/FullScreenRenderWindow';
+import vtkWebXRRenderWindowHelper from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper';
 import vtkSkybox from '@kitware/vtk.js/Rendering/Core/Skybox';
 import vtkSkyboxReader from '@kitware/vtk.js/IO/Misc/SkyboxReader';
 import vtkURLExtract from '@kitware/vtk.js/Common/Core/URLExtract';
-import { XrSessionTypes } from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow/Constants';
+import { XrSessionTypes } from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper/Constants';
 
 // Force DataAccessHelper to have access to various data source
 import '@kitware/vtk.js/IO/Core/DataAccessHelper/HtmlDataAccessHelper';
@@ -157,6 +158,9 @@ function createVisualization(container, mapReader) {
     containerStyle: { height: '100%', width: '100%', position: 'absolute' },
   });
   const renderWindow = fullScreenRenderer.getRenderWindow();
+  const xrRenderWindowHelper = vtkWebXRRenderWindowHelper.newInstance({
+    renderWindow: fullScreenRenderer.getApiSpecificRenderWindow(),
+  });
   const mainRenderer = fullScreenRenderer.getRenderer();
   const interactor = fullScreenRenderer.getInteractor();
   const actor = vtkSkybox.newInstance();
@@ -202,6 +206,7 @@ function createVisualization(container, mapReader) {
   // add vr option button if supported
   if (
     navigator.xr !== undefined &&
+    xrRenderWindowHelper.getXrSupported() &&
     navigator.xr.isSessionSupported('immersive-vr')
   ) {
     const button = document.createElement('button');
@@ -213,12 +218,10 @@ function createVisualization(container, mapReader) {
     document.querySelector('body').appendChild(button);
     button.addEventListener('click', () => {
       if (button.textContent === 'Send To VR') {
-        fullScreenRenderer
-          .getApiSpecificRenderWindow()
-          .startXR(XrSessionTypes.HmdVR);
+        xrRenderWindowHelper.startXR(XrSessionTypes.HmdVR);
         button.textContent = 'Return From VR';
       } else {
-        fullScreenRenderer.getApiSpecificRenderWindow().stopXR();
+        xrRenderWindowHelper.stopXR();
         button.textContent = 'Send To VR';
       }
     });
@@ -270,8 +273,8 @@ function createVisualization(container, mapReader) {
   }
 
   if (grid) {
-    console.log(fullScreenRenderer.getOpenGLRenderWindow().getSize());
-    createGrid(...fullScreenRenderer.getOpenGLRenderWindow().getSize());
+    console.log(fullScreenRenderer.getApiSpecificRenderWindow().getSize());
+    createGrid(...fullScreenRenderer.getApiSpecificRenderWindow().getSize());
   }
 }
 

diff --git a/Examples/Geometry/AR/index.js b/Examples/Geometry/AR/index.js
@@ -7,11 +7,12 @@ import vtkActor from '@kitware/vtk.js/Rendering/Core/Actor';
 import vtkCalculator from '@kitware/vtk.js/Filters/General/Calculator';
 import vtkConeSource from '@kitware/vtk.js/Filters/Sources/ConeSource';
 import vtkFullScreenRenderWindow from '@kitware/vtk.js/Rendering/Misc/FullScreenRenderWindow';
+import vtkWebXRRenderWindowHelper from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper';
 import vtkMapper from '@kitware/vtk.js/Rendering/Core/Mapper';
 import vtkURLExtract from '@kitware/vtk.js/Common/Core/URLExtract';
 import { AttributeTypes } from '@kitware/vtk.js/Common/DataModel/DataSetAttributes/Constants';
 import { FieldDataTypes } from '@kitware/vtk.js/Common/DataModel/DataSet/Constants';
-import { XrSessionTypes } from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow/Constants';
+import { XrSessionTypes } from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper/Constants';
 
 // Force DataAccessHelper to have access to various data source
 import '@kitware/vtk.js/IO/Core/DataAccessHelper/HtmlDataAccessHelper';
@@ -36,6 +37,9 @@ const fullScreenRenderer = vtkFullScreenRenderWindow.newInstance({
 });
 const renderer = fullScreenRenderer.getRenderer();
 const renderWindow = fullScreenRenderer.getRenderWindow();
+const xrRenderWindowHelper = vtkWebXRRenderWindowHelper.newInstance({
+  renderWindow: fullScreenRenderer.getApiSpecificRenderWindow(),
+});
 
 // ----------------------------------------------------------------------------
 // Example code
@@ -87,18 +91,14 @@ renderWindow.render();
 
 fullScreenRenderer.addController(controlPanel);
 const arbutton = document.querySelector('.arbutton');
-arbutton.disabled = !fullScreenRenderer
-  .getApiSpecificRenderWindow()
-  .getXrSupported();
+arbutton.disabled = !xrRenderWindowHelper.getXrSupported();
 
 arbutton.addEventListener('click', (e) => {
   if (arbutton.textContent === 'Start AR') {
-    fullScreenRenderer
-      .getApiSpecificRenderWindow()
-      .startXR(requestedXrSessionType);
+    xrRenderWindowHelper.startXR(requestedXrSessionType);
     arbutton.textContent = 'Exit AR';
   } else {
-    fullScreenRenderer.getApiSpecificRenderWindow().stopXR();
+    xrRenderWindowHelper.stopXR();
     arbutton.textContent = 'Start AR';
   }
 });

diff --git a/Examples/Geometry/LookingGlass/index.js b/Examples/Geometry/LookingGlass/index.js
@@ -10,10 +10,11 @@ import vtkActor from '@kitware/vtk.js/Rendering/Core/Actor';
 import vtkCalculator from '@kitware/vtk.js/Filters/General/Calculator';
 import vtkConeSource from '@kitware/vtk.js/Filters/Sources/ConeSource';
 import vtkFullScreenRenderWindow from '@kitware/vtk.js/Rendering/Misc/FullScreenRenderWindow';
+import vtkWebXRRenderWindowHelper from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper';
 import vtkMapper from '@kitware/vtk.js/Rendering/Core/Mapper';
 import { AttributeTypes } from '@kitware/vtk.js/Common/DataModel/DataSetAttributes/Constants';
 import { FieldDataTypes } from '@kitware/vtk.js/Common/DataModel/DataSet/Constants';
-import { XrSessionTypes } from 'vtk.js/Sources/Rendering/OpenGL/RenderWindow/Constants';
+import { XrSessionTypes } from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper/Constants';
 
 // Force DataAccessHelper to have access to various data source
 import '@kitware/vtk.js/IO/Core/DataAccessHelper/HtmlDataAccessHelper';
@@ -42,6 +43,9 @@ const fullScreenRenderer = vtkFullScreenRenderWindow.newInstance({
 });
 const renderer = fullScreenRenderer.getRenderer();
 const renderWindow = fullScreenRenderer.getRenderWindow();
+const xrRenderWindowHelper = vtkWebXRRenderWindowHelper.newInstance({
+  renderWindow: fullScreenRenderer.getApiSpecificRenderWindow(),
+});
 
 // ----------------------------------------------------------------------------
 // Example code
@@ -110,12 +114,10 @@ resolutionChange.addEventListener('input', (e) => {
 
 vrbutton.addEventListener('click', (e) => {
   if (vrbutton.textContent === 'Send To Looking Glass') {
-    fullScreenRenderer
-      .getApiSpecificRenderWindow()
-      .startXR(XrSessionTypes.LookingGlassVR);
+    xrRenderWindowHelper.startXR(XrSessionTypes.LookingGlassVR);
     vrbutton.textContent = 'Return From Looking Glass';
   } else {
-    fullScreenRenderer.getApiSpecificRenderWindow().stopXR();
+    xrRenderWindowHelper.stopXR();
     vrbutton.textContent = 'Send To Looking Glass';
   }
 });

diff --git a/Examples/Geometry/VR/index.js b/Examples/Geometry/VR/index.js
@@ -10,10 +10,11 @@ import vtkActor from '@kitware/vtk.js/Rendering/Core/Actor';
 import vtkCalculator from '@kitware/vtk.js/Filters/General/Calculator';
 import vtkConeSource from '@kitware/vtk.js/Filters/Sources/ConeSource';
 import vtkFullScreenRenderWindow from '@kitware/vtk.js/Rendering/Misc/FullScreenRenderWindow';
+import vtkWebXRRenderWindowHelper from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper';
 import vtkMapper from '@kitware/vtk.js/Rendering/Core/Mapper';
 import { AttributeTypes } from '@kitware/vtk.js/Common/DataModel/DataSetAttributes/Constants';
 import { FieldDataTypes } from '@kitware/vtk.js/Common/DataModel/DataSet/Constants';
-import { XrSessionTypes } from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow/Constants';
+import { XrSessionTypes } from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper/Constants';
 
 // Force DataAccessHelper to have access to various data source
 import '@kitware/vtk.js/IO/Core/DataAccessHelper/HtmlDataAccessHelper';
@@ -46,6 +47,9 @@ const fullScreenRenderer = vtkFullScreenRenderWindow.newInstance({
 });
 const renderer = fullScreenRenderer.getRenderer();
 const renderWindow = fullScreenRenderer.getRenderWindow();
+const XRHelper = vtkWebXRRenderWindowHelper.newInstance({
+  renderWindow: fullScreenRenderer.getApiSpecificRenderWindow(),
+});
 
 // ----------------------------------------------------------------------------
 // Example code
@@ -114,12 +118,10 @@ resolutionChange.addEventListener('input', (e) => {
 
 vrbutton.addEventListener('click', (e) => {
   if (vrbutton.textContent === 'Send To VR') {
-    fullScreenRenderer
-      .getApiSpecificRenderWindow()
-      .startXR(XrSessionTypes.HmdVR);
+    XRHelper.startXR(XrSessionTypes.HmdVR);
     vrbutton.textContent = 'Return From VR';
   } else {
-    fullScreenRenderer.getApiSpecificRenderWindow().stopXR();
+    XRHelper.stopXR();
     vrbutton.textContent = 'Send To VR';
   }
 });

diff --git a/Examples/Volume/WebXRChestCTBlendedCVR/index.js b/Examples/Volume/WebXRChestCTBlendedCVR/index.js
@@ -10,6 +10,7 @@ import '@kitware/vtk.js/IO/Core/DataAccessHelper/JSZipDataAccessHelper';
 
 import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction';
 import vtkFullScreenRenderWindow from '@kitware/vtk.js/Rendering/Misc/FullScreenRenderWindow';
+import vtkWebXRRenderWindowHelper from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper';
 import HttpDataAccessHelper from '@kitware/vtk.js/IO/Core/DataAccessHelper/HttpDataAccessHelper';
 import vtkPiecewiseFunction from '@kitware/vtk.js/Common/DataModel/PiecewiseFunction';
 import vtkURLExtract from '@kitware/vtk.js/Common/Core/URLExtract';
@@ -18,7 +19,7 @@ import vtkVolumeMapper from '@kitware/vtk.js/Rendering/Core/VolumeMapper';
 import vtkXMLImageDataReader from '@kitware/vtk.js/IO/XML/XMLImageDataReader';
 import vtkImageReslice from '@kitware/vtk.js/Imaging/Core/ImageReslice';
 import vtkMath from '@kitware/vtk.js/Common/Core/Math';
-import { XrSessionTypes } from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow/Constants';
+import { XrSessionTypes } from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper/Constants';
 
 import './WebXRVolume.module.css';
 
@@ -32,6 +33,9 @@ const fullScreenRenderer = vtkFullScreenRenderWindow.newInstance({
 });
 const renderer = fullScreenRenderer.getRenderer();
 const renderWindow = fullScreenRenderer.getRenderWindow();
+const xrRenderWindowHelper = vtkWebXRRenderWindowHelper.newInstance({
+  renderWindow: fullScreenRenderer.getApiSpecificRenderWindow(),
+});
 
 // ----------------------------------------------------------------------------
 // Set up pipeline objects
@@ -118,10 +122,7 @@ HttpDataAccessHelper.fetchBinary(fileURL).then((fileContents) => {
   let enterText = 'XR not available!';
   const exitText = 'Exit XR';
   xrButton.textContent = enterText;
-  if (
-    navigator.xr !== undefined &&
-    fullScreenRenderer.getApiSpecificRenderWindow().getXrSupported()
-  ) {
+  if (navigator.xr !== undefined && xrRenderWindowHelper.getXrSupported()) {
     navigator.xr.isSessionSupported('immersive-ar').then((arSupported) => {
       if (arSupported) {
         xrSessionType = XrSessionTypes.MobileAR;
@@ -140,10 +141,10 @@ HttpDataAccessHelper.fetchBinary(fileURL).then((fileContents) => {
   }
   xrButton.addEventListener('click', () => {
     if (xrButton.textContent === enterText) {
-      fullScreenRenderer.getApiSpecificRenderWindow().startXR(xrSessionType);
+      xrRenderWindowHelper.startXR(xrSessionType);
       xrButton.textContent = exitText;
     } else {
-      fullScreenRenderer.getApiSpecificRenderWindow().stopXR();
+      xrRenderWindowHelper.stopXR();
       xrButton.textContent = enterText;
     }
   });

diff --git a/Examples/Volume/WebXRHeadFullVolumeCVR/index.js b/Examples/Volume/WebXRHeadFullVolumeCVR/index.js
@@ -10,6 +10,7 @@ import '@kitware/vtk.js/IO/Core/DataAccessHelper/JSZipDataAccessHelper';
 
 import vtkColorTransferFunction from '@kitware/vtk.js/Rendering/Core/ColorTransferFunction';
 import vtkFullScreenRenderWindow from '@kitware/vtk.js/Rendering/Misc/FullScreenRenderWindow';
+import vtkWebXRRenderWindowHelper from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper';
 import HttpDataAccessHelper from '@kitware/vtk.js/IO/Core/DataAccessHelper/HttpDataAccessHelper';
 import vtkPiecewiseFunction from '@kitware/vtk.js/Common/DataModel/PiecewiseFunction';
 import vtkURLExtract from '@kitware/vtk.js/Common/Core/URLExtract';
@@ -18,7 +19,7 @@ import vtkVolumeMapper from '@kitware/vtk.js/Rendering/Core/VolumeMapper';
 import vtkXMLImageDataReader from '@kitware/vtk.js/IO/XML/XMLImageDataReader';
 import vtkImageReslice from '@kitware/vtk.js/Imaging/Core/ImageReslice';
 import vtkMath from '@kitware/vtk.js/Common/Core/Math';
-import { XrSessionTypes } from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow/Constants';
+import { XrSessionTypes } from '@kitware/vtk.js/Rendering/WebXR/RenderWindowHelper/Constants';
 
 import './WebXRVolume.module.css';
 
@@ -32,6 +33,9 @@ const fullScreenRenderer = vtkFullScreenRenderWindow.newInstance({
 });
 const renderer = fullScreenRenderer.getRenderer();
 const renderWindow = fullScreenRenderer.getRenderWindow();
+const xrRenderWindowHelper = vtkWebXRRenderWindowHelper.newInstance({
+  renderWindow: fullScreenRenderer.getApiSpecificRenderWindow(),
+});
 
 // ----------------------------------------------------------------------------
 // Set up pipeline objects
@@ -149,10 +153,7 @@ HttpDataAccessHelper.fetchBinary(fileURL).then((fileContents) => {
   let enterText = 'XR not available!';
   const exitText = 'Exit XR';
   xrButton.textContent = enterText;
-  if (
-    navigator.xr !== undefined &&
-    fullScreenRenderer.getApiSpecificRenderWindow().getXrSupported()
-  ) {
+  if (navigator.xr !== undefined && xrRenderWindowHelper.getXrSupported()) {
     enterText =
       requestedXrSessionType === XrSessionTypes.MobileAR
         ? 'Start AR'
@@ -161,12 +162,10 @@ HttpDataAccessHelper.fetchBinary(fileURL).then((fileContents) => {
   }
   xrButton.addEventListener('click', () => {
     if (xrButton.textContent === enterText) {
-      fullScreenRenderer
-        .getApiSpecificRenderWindow()
-        .startXR(requestedXrSessionType);
+      xrRenderWindowHelper.startXR(requestedXrSessionType);
       xrButton.textContent = exitText;
     } else {
-      fullScreenRenderer.getApiSpecificRenderWindow().stopXR();
+      xrRenderWindowHelper.stopXR();
       xrButton.textContent = enterText;
     }
   });