Merge branch 'master' into fix-obbtree-tests

Author: floryst

.github/workflows/build-test.yml

@@ -15,13 +15,22 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node }}
-          cache: 'npm'
       - name: Install dependencies
         run: |
           npm ci
           sudo apt-get install xvfb
       - name: Build
         run: npm run build:release
+      - name: Archive build output
+        uses: actions/upload-artifact@v3
+        with:
+          name: build-results
+          path: dist
+          retention-days: 15
+      - name: Validate generated typescript definitions
+        run: |
+          npx tsc -p tsconfig.esm-check.json
+          npx tsc -p tsconfig.umd-check.json
       - name: Chrome and Firefox tests
         run: xvfb-run --auto-servernum npm run test -- --browsers Chrome,Firefox
       - name: Archive test results

.github/workflows/publish.yml

@@ -26,8 +26,12 @@ jobs:
           sudo apt-get install xvfb
       - name: Build
         run: npm run build:release
-      - name: Validate
+      - name: Validate code style
         run: npm run validate
+      - name: Validate generated typescript definitions
+        run: |
+          npx tsc -p tsconfig.esm-check.json
+          npx tsc -p tsconfig.umd-check.json
       - name: Chrome and Firefox tests
         run: xvfb-run --auto-servernum npm run test -- --browsers Chrome,Firefox
       - name: Archive test results

BREAKING_CHANGES.md

@@ -1,6 +1,6 @@
 ## From 23.x to 24
 
-All old-style widgets except OrientationMarkerWidget and PiecewiseGaussianWidget have been removed.
+- All old-style widgets except OrientationMarkerWidget and PiecewiseGaussianWidget have been removed.
 
 | **Old-style/deprecated widget**   | **New-style widget**            |
 |-----------------------------------|---------------------------------|
@@ -15,6 +15,16 @@ All old-style widgets except OrientationMarkerWidget and PiecewiseGaussianWidget
 | ResliceCursor                     | ResliceCursorWidget             |
 
 - In SVGLandmarkRepresentation: `model.showCircle` is replaced by `model.circleProps.visible`
+- In vtk.js subclasses, prefix with '_' the following "protected" model variables:
+  - vtk*: model.openglRenderWindow -> model._openglRenderWindow
+  - vtk*: model.openglRenderer -> model._openglRenderer
+  - vtkInteractorObserver, vtkOrientationMarkerWidget : model.interactor -> model._interactor
+  - vtkAbstractWidget, vtkViewNode: model.parent -> model._parent
+  - vtkProp: model.parentProp -> model._parentProp
+  - vtkRenderWindowInteractor: model.view -> model._view
+  - vtkRenderer: model.renderWindow -> model._renderWindow
+  - vtkHardwareSelector: model.renderer -> model._renderer
+  - vtkAbstractWidget: model.widgetManager -> model._widgetManager
 
 ## From 22.x to 23
 

Documentation/content/docs/develop_webxr.md

@@ -40,6 +40,7 @@ vtk.js supports virtual and augmented reality rendering via the [WebXR device AP
 
 [![VR Cone Example][VrCone]](../examples/VR.html)
 [![SkyboxViewer Example][SkyboxViewerVR]](../examples/SkyboxViewer.html?fileURL=https://data.kitware.com/api/v1/file/5ae8a89c8d777f0685796bae/download)
+[![XR Volume Example][WebXRVolume]](../examples/WebXRVolume.html)
 
 </div>
 
@@ -51,6 +52,7 @@ vtk.js supports virtual and augmented reality rendering via the [WebXR device AP
 [![GeometryViewer Example][GeometryViewer]](../examples/GeometryViewer.html?fileURL=https://data.kitware.com/api/v1/item/59de9de58d777f31ac641dc5/download)
 [![GeometryViewer Brain Blood Vessels][GeometryViewerBrainBloodVessels]](../examples/GeometryViewer/GeometryViewer.html?fileURL=[https://data.kitware.com/api/v1/file/61f041f14acac99f42c2ff9a/download,https://data.kitware.com/api/v1/file/61f042024acac99f42c2ffa6/download,https://data.kitware.com/api/v1/file/61f042b74acac99f42c30079/download])
 [![GeometryViewer Chest CT][GeometryViewerchestCT]](../examples/GeometryViewer/GeometryViewer.html?fileURL=[https://data.kitware.com/api/v1/file/61f044354acac99f42c30276/download,https://data.kitware.com/api/v1/file/61f0440f4acac99f42c30191/download,https://data.kitware.com/api/v1/file/61f044204acac99f42c30267/download])
+[![XR Volume Example][WebXRVolume]](../examples/WebXRVolume.html)
 
 </div>
 

Documentation/content/docs/gallery/WebXRVolume.png

@@ -1,4 +1,4 @@
-title: Using vtk.js as an ES6 dependency
+title: Using vtk.js as an ES dependency
 ---
 
 This guide illustrates how to consume vtk.js as an ES dependency.

Documentation/content/docs/intro_vtk_as_es6_dependency.md

@@ -22,7 +22,7 @@ sidebar:
     getting_started: Getting Started
     overview: Overview
     external: Script usage
-    es6_dep: ES6 usage
+    es6_dep: ESM usage
     tutorial: Tutorials and Training
     develop: Development
     requirement: Requirements

Documentation/tpl/__en__

@@ -39,8 +39,8 @@ fpsElm.style.bottom = '10px';
 fpsElm.style.background = 'rgba(255,255,255,0.5)';
 fpsElm.style.borderRadius = '5px';
 
-fpsMonitor.setContainer(document.querySelector('body'));
-fpsMonitor.setRenderWindow(renderWindow);
+// fpsMonitor.setContainer(document.querySelector('body'));
+// fpsMonitor.setRenderWindow(renderWindow);
 
 fullScreenRenderer.setResizeCallback(fpsMonitor.update);
 
@@ -92,10 +92,14 @@ mapper2D.setScalarVisibility(false);
 
 const actor = vtkActor.newInstance();
 actor.setMapper(mapper);
+actor.getProperty().setEdgeVisibility(true);
+actor.getProperty().setEdgeColor([0.5, 0, 0.6]);
+actor.getProperty().setLineWidth(3);
 const actor2D = vtkActor2D.newInstance();
 actor2D.setMapper(mapper2D);
 actor2D.getProperty().setColor([1, 0, 0]);
 actor2D.getProperty().setOpacity(0.5);
+actor2D.getProperty().setLineWidth(3);
 actor2D.getProperty().setDisplayLocation(DisplayLocation.FOREGROUND);
 actor2D.getProperty().setRepresentation(Representation.SURFACE);
 
@@ -116,13 +120,15 @@ const resolutionChange = document.querySelector('.resolution');
 representationSelector.addEventListener('change', (e) => {
   const newRepValue = Number(e.target.value);
   actor2D.getProperty().setRepresentation(newRepValue);
+  actor.getProperty().setRepresentation(newRepValue);
   renderWindow.render();
   fpsMonitor.update();
 });
 
 resolutionChange.addEventListener('input', (e) => {
   const resolution = Number(e.target.value);
   sphereSource.setThetaResolution(resolution);
+  coneSource.setResolution(resolution);
   renderWindow.render();
   fpsMonitor.update();
 });
@@ -135,5 +141,8 @@ resolutionChange.addEventListener('input', (e) => {
 global.source = coneSource;
 global.mapper = mapper;
 global.actor = actor;
+global.sphereSource = sphereSource;
+global.mapper2D = mapper2D;
+global.actor2D = actor2D;
 global.renderer = renderer;
 global.renderWindow = renderWindow;