Merge branch 'master' into fix/imageMapper-RGB-opacity

Author: martinken

.github/workflows/build-test.yml

@@ -36,7 +36,8 @@ jobs:
       - name: Archive test results
         if: always()
         uses: actions/upload-artifact@v3
+        continue-on-error: true
         with:
           name: test-results
           path: Utilities/TestResults/Test-Report.html
-          retention-days: 15
+          retention-days: 15

Sources/Common/DataModel/DataSet/Constants.d.ts

@@ -0,0 +1,27 @@
+export declare enum FieldAssociations {
+	FIELD_ASSOCIATION_POINTS = 0,
+	FIELD_ASSOCIATION_CELLS = 1,
+	FIELD_ASSOCIATION_NONE = 2,
+	FIELD_ASSOCIATION_POINTS_THEN_CELLS = 3,
+	FIELD_ASSOCIATION_VERTICES = 4,
+	FIELD_ASSOCIATION_EDGES = 5,
+	FIELD_ASSOCIATION_ROWS = 6,
+	NUMBER_OF_ASSOCIATIONS = 7,
+}
+
+export declare enum FieldDataTypes {
+  UNIFORM = 0,
+  DATA_OBJECT_FIELD = 0,
+  COORDINATE = 1,
+  POINT_DATA = 1,
+  POINT = 2,
+  POINT_FIELD_DATA = 2, 
+  CELL = 3,
+  CELL_FIELD_DATA = 3,
+  VERTEX = 4,
+  VERTEX_FIELD_DATA = 4,
+  EDGE = 5,
+  EDGE_FIELD_DATA = 5,
+  ROW = 6,
+  ROW_DATA = 6,
+}

Sources/Common/DataModel/DataSet/index.d.ts

@@ -1,33 +1,6 @@
-import { vtkObject } from "../../../interfaces" ;
 import vtkDataSetAttributes from '../DataSetAttributes';
-
-export enum FieldDataTypes {
-	UNIFORM,
-	DATA_OBJECT_FIELD,
-	COORDINATE,
-	POINT_DATA,
-	POINT,
-	POINT_FIELD_DATA,
-	CELL,
-	CELL_FIELD_DATA,
-	VERTEX,
-	VERTEX_FIELD_DATA,
-	EDGE,
-	EDGE_FIELD_DATA,
-	ROW,
-	ROW_DATA,
-}
-
-export enum FieldAssociations {
-	FIELD_ASSOCIATION_POINTS,
-	FIELD_ASSOCIATION_CELLS,
-	FIELD_ASSOCIATION_NONE,
-	FIELD_ASSOCIATION_POINTS_THEN_CELLS,
-	FIELD_ASSOCIATION_VERTICES,
-	FIELD_ASSOCIATION_EDGES,
-	FIELD_ASSOCIATION_ROWS,
-	NUMBER_OF_ASSOCIATIONS,
-}
+import { vtkObject } from "../../../interfaces" ;
+import { FieldAssociations, FieldDataTypes } from "./Constants";
 
 /**
  *
@@ -102,7 +75,9 @@ export function newInstance(initialValues? : IDataSetInitialValues): vtkDataSet;
  * operate on cell data, both cell and point data, either one, or none.
  */
 export declare const vtkDataSet: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+	newInstance: typeof newInstance;
+	extend: typeof extend;
+	FieldAssociation: typeof FieldAssociations;
+	FieldDataTypes: typeof FieldDataTypes;
 };
 export default vtkDataSet;

Sources/Interaction/Widgets/OrientationMarkerWidget/index.d.ts

@@ -165,7 +165,6 @@ export function extend(publicAPI: object, model: object, initialValues?: IOrient
  */
 export function newInstance(initialValues?: IOrientationMarkerWidgetInitialValues): vtkOrientationMarkerWidget;
 
-
 /**
  * vtkOrientationMarkerWidget is a 2D widget for manipulating a marker prop
  */
@@ -174,4 +173,5 @@ export declare const vtkOrientationMarkerWidget: {
 	extend: typeof extend;
 	Corners: typeof Corners;
 }
+
 export default vtkOrientationMarkerWidget;

Sources/Rendering/Core/InteractorObserver/index.d.ts

@@ -0,0 +1,132 @@
+import vtkRenderer from '../Renderer';
+import vtkRenderWindowInteractor from '../RenderWindowInteractor';
+import { vtkObject, EventHandler, vtkSubscription } from '../../../interfaces';
+import { Vector3 } from '../../../types';
+
+export interface vtkInteractorObserver extends vtkObject {
+  /**
+   * Invoke an interaction event.
+   * 
+   * @param args Event payload.
+   */
+  invokeInteractionEvent(...args: unknown[]): void;
+
+  /**
+   * Registers a callback to be invoked when an interaction event occurs.
+   * 
+   * @param {EventHandler} cb The callback to be called.
+   * @param {Number} [priority] The priority of the event.
+   */
+  onInteractionEvent(cb: EventHandler, priority?: number): Readonly<vtkSubscription>;
+
+  /**
+   * Invoke a start interaction event.
+   * 
+   * @param args Event payload. 
+   */
+  invokeStartInteractionEvent(...args: unknown[]): void;
+
+  /**
+   * Registers a callback to be invoked when a start interaction event occurs.
+   * 
+   * @param {EventHandler} cb The callback to be called. 
+   * @param {Number} [priority] The callback to be called
+   */
+  onStartInteractionEvent(cb: EventHandler, priority?: number): Readonly<vtkSubscription>;
+
+  /**
+   * Invoke an end interaction event.
+   * 
+   * @param args Event payload. 
+   */
+  invokeEndInteractionEvent(...args: unknown[]): void;
+
+  /**
+   * Registers a callback to be invoked when an end interaction event occurs.
+   * 
+   * @param {EventHandler} cb The callback to be called. 
+   * @param {Number?} [priority] The callback to be called
+   */
+  onEndInteractionEvent(cb: EventHandler, priority?: number): Readonly<vtkSubscription>;
+
+  /** 
+   * Retrieve the render window interactor instance. 
+   */
+  getInteractor(): vtkRenderWindowInteractor;
+
+  /** 
+   * Get wether or not this InteractorObserver instance is enabled. 
+   */
+  getEnabled(): boolean;
+  
+  /**
+   * Enable/disable the interactor observer. Note that if you are enabling the interactor observer, an interactor instance must exists on the model.
+   * Typically you can call `setInteractor`
+   * 
+   * @param {Boolean} enable 
+   */
+  setEnabled(enable: boolean): void;
+
+  /**
+   * Set the priority.
+   * 
+   * @param {Number} priority The priority level.
+   */
+  setPriority(priority: number): void;
+
+  /**
+   * Get the priority.
+   */
+  getPriority(): number;
+
+  /**
+   * Set whether or not the interactor observer instance should process events.
+   * 
+   * @param {Boolean} processEvents 
+   */
+  setProcessEvents(processEvents: boolean): boolean;
+
+  /**
+   * Get whether or not the interactor observer instance should process events.
+   */
+  getProcessEvents(): boolean;
+
+  /**
+   * Set the interactor instance.
+   * 
+   * @param {vtkRenderWindowInteractor} interactor 
+   */
+  setInteractor(interactor: vtkRenderWindowInteractor): void;
+
+  /**
+   * Transform from world to display coordinates.
+   * 
+   * @param {vtkRenderer} renderer 
+   * @param {Number} x 
+   * @param {Number} y 
+   * @param {Number} z 
+   */
+  computeWorldToDisplay(
+    renderer: vtkRenderer,
+    x: number,
+    y: number,
+    z: number
+  ): Vector3;
+
+  /**
+   * Transform from display to world coordinates.
+   *
+   * @param {vtkRenderer} renderer 
+   * @param {Number} x 
+   * @param {Number} y 
+   * @param {Number} z 
+   */
+  computeDisplayToWorld(
+    renderer: vtkRenderer,
+    x: number,
+    y: number,
+    z: number
+  ): Vector3;
+}
+
+export default vtkInteractorObserver;

Sources/Rendering/Misc/SynchronizableRenderWindow/ObjectManager/index.d.ts

@@ -0,0 +1,80 @@
+import { vtkObject } from "../../../../interfaces" ;
+import { Nullable } from "../../../../types" ;
+import { ISynchronizerContext, IViewState } from "..";
+
+export type BuilderFunction = <T extends vtkObject>(type: string, initialProps?: Record<string, unknown>) => Nullable<T>;
+export type UpdaterFunction = (instance: vtkObject, state: IViewState, context: ISynchronizerContext) => void;
+
+export interface IObjectManager {
+  /**
+   * Build a vtkObject.
+   */
+  build: BuilderFunction;
+
+  /**
+   * @param {String} type The type to update 
+   * @param {vtkObject} instance The specific instance 
+   * @param {IViewState} props 
+   * @param {ISynchronizerContext} context 
+   */
+  update(type: string, instance: vtkObject, props: IViewState, context: ISynchronizerContext): Promise<Error | void>;
+
+  /**
+   * Defines a new type handler with the specified builder and updater functions
+   * 
+   * @param {String} type The type you wish to register
+   * @param {BuilderFunction} [buildFn] The builder function to associate with the type 
+   * @param {UpdaterFunction} [updateFn] The updater function to associate with the type 
+   */
+  setTypeMapping(type: string, buildFn?: BuilderFunction, updateFn?: UpdaterFunction): void;
+  
+  /**
+   * Clear all type mappings
+   */
+  clearTypeMapping(): void;
+ 
+  /**
+   * Get a list of all supported types
+   * 
+   * @returns {string[]}
+   */
+  getSupportedTypes(): string[];
+ 
+  /**
+   * Clear all one time updaters
+   */
+  clearOneTimeUpdaters(): void;
+ 
+  /**
+   * Update the associated render window
+   */
+  updateRenderWindow(): void;
+ 
+  /**
+   * Register a new type to exclude
+   * 
+   * @param {string} type The type to exclude 
+   * @param {string} propertyName The property name to exclude
+   * @param {unknown} propertyValue The property value to exclude 
+   */
+  excludeInstance(type: string, propertyName: string, propertyValue: unknown): void;
+ 
+  /**
+   * Set the default types mapping
+   * 
+   * @param {boolean} [reset] Clear all existing type mappings, defaults to true 
+   */
+  setDefaultMapping(reset?: boolean): void;
+ 
+  /**
+   * Apply the default aliases
+   */
+  applyDefaultAliases(): void;
+ 
+  /**
+   * Always update the camera
+   */
+  alwaysUpdateCamera(): void;
+}
+
+export default IObjectManager;

Sources/Rendering/Misc/SynchronizableRenderWindow/vtkObjectManager.js renamed to Sources/Rendering/Misc/SynchronizableRenderWindow/ObjectManager/index.js

@@ -1,7 +1,7 @@
 import * as macro from 'vtk.js/Sources/macros';
 import Base64 from 'vtk.js/Sources/Common/Core/Base64';
 import vtkRenderWindow from 'vtk.js/Sources/Rendering/Core/RenderWindow';
-import vtkObjectManager from './vtkObjectManager';
+import vtkObjectManager from './ObjectManager';
 
 const SYNCHRONIZER_CONTEXTS = {};
 

Sources/Rendering/Misc/SynchronizableRenderWindow/index.js

@@ -732,9 +732,18 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
     });
   };
 
+  let hardwareMaximumLineWidth;
   publicAPI.getHardwareMaximumLineWidth = () => {
+    // We cache the result of this function because `getParameter` is slow
+    if (hardwareMaximumLineWidth != null) {
+      return hardwareMaximumLineWidth;
+    }
+
     const gl = publicAPI.get3DContext();
     const lineWidthRange = gl.getParameter(gl.ALIASED_LINE_WIDTH_RANGE);
+
+    hardwareMaximumLineWidth = lineWidthRange[1];
+
     return lineWidthRange[1];
   };