@kitware/vtk.js 30.1.2 → 30.2.0

package/BREAKING_CHANGES.md

@@ -4,6 +4,8 @@
 - **ResliceCursorWidget.invokeInternalInteractionEvent(methodName)**: has been removed and should be replaced by `ResliceCursorWidget.invokeInteractionEvent(methodName)`.
 - **ResliceCursorWidget.updateCameraPoints(renderer, viewType, resetFocalPoint, keepCenterFocalDistance, computeFocalPointOffset)** has lost the `keepCenterFocalDistance` parameter (because it was ALWAYS the negate of `computeFocalPointOffset`). The new signature is `ResliceCursorWidget.updateCameraPoints(renderer, viewType, resetFocalPoint, keepCenterFocalDistance, computeFocalPointOffset)`
 
+- **vtkAxesActor**: `setXAxisColor`, `setYAxisColor`, `setZAxisColor` now take a single `RGBColor` (array of 3 numbers) instead of 3 numbers for each color component. The `get*AxisColor` methods now return an array of 3 numbers instead of an object with `r`, `g`, `b` properties.
+
 ## 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))
@@ -83,9 +85,9 @@ SplineWidget's handles now scale up automatically.
 
 ## From 19.x to 20
 
-In ShapeWidget: 
-- `setLabelTextCallback` is replaced by `text` substate.  
-- `setPixelScale` has been removed. It should be replaced by point handle `scale1` mixin and `scaleInPixels`.  
+In ShapeWidget:
+- `setLabelTextCallback` is replaced by `text` substate.
+- `setPixelScale` has been removed. It should be replaced by point handle `scale1` mixin and `scaleInPixels`.
 - `useHandles` has been removed. It should be replaced by `setHandleVisibility`.
 - `resetAfterPointPlacement` is now false by default.
 

package/Rendering/Core/AxesActor.d.ts

@@ -1,99 +1,102 @@
 import vtkActor, { IActorInitialValues } from './Actor';
+import { RGBColor } from './../../types';
 
 /**
- * 
+ * Represents the initial values for the AxesActor.
  */
 export interface IAxesActorInitialValues extends IActorInitialValues {}
 
+/**
+ * Represents an actor that displays axes in a 3D scene.
+ */
 export interface vtkAxesActor extends vtkActor {
-
-	/**
-	 * 
-	 */
-	getConfig(): object;
-
-	/**
-	 * 
-	 */
-	getXConfig(): object;
-
-	/**
-	 * 
-	 */
-	getYConfig(): object;
-
-	/**
-	 * 
-	 */
-	getZConfig(): object;
-
-	/**
-	 * 
-	 */
-	getXAxisColor(): number[];
-
-	/**
-	 * 
-	 */
-	getYAxisColor(): number[];
-
-	/**
-	 * 
-	 */
-	getZAxisColor(): number[];
-
-	/**
-	 * 
-	 * @param config 
-	 */
-	setConfig(config: object): boolean;
-
-	/**
-	 * 
-	 * @param config 
-	 */
-	setXConfig(config: object): boolean;
-
-	/**
-	 * 
-	 * @param config 
-	 */
-	setYConfig(config: object): boolean;
-
-	/**
-	 * 
-	 * @param config 
-	 */
-	setZConfig(config: object): boolean;
-
-	/**
-	 * Set X axis color.
-	 * @param {Number} r Defines the red component (between 0 and 1).
-	 * @param {Number} g Defines the green component (between 0 and 1).
-	 * @param {Number} b Defines the blue component (between 0 and 1).
-	 */
-	setXAxisColor(r: number, g: number, b: number): boolean;
-
-	/**
-	 * Set Y axis color.
-	 * @param {Number} r Defines the red component (between 0 and 1).
-	 * @param {Number} g Defines the green component (between 0 and 1).
-	 * @param {Number} b Defines the blue component (between 0 and 1).
-	 */
-	setYAxisColor(r: number, g: number, b: number): boolean;
-
-	/**
-	 * Set Z axis color.
-	 * @param {Number} r Defines the red component (between 0 and 1).
-	 * @param {Number} g Defines the green component (between 0 and 1).
-	 * @param {Number} b Defines the blue component (between 0 and 1).
-	 */
-	setZAxisColor(r: number, g: number, b: number): boolean;
-
-	/**
-	 * 
-	 */
-	update(): void;
+  /**
+   * Get config object of the actor.
+   */
+  getConfig(): object;
+
+  /**
+   * Get config object of the X axis.
+   */
+  getXConfig(): object;
+
+  /**
+   * Get config object of the Y axis.
+   */
+  getYConfig(): object;
+
+  /**
+   * Get config object of the Z axis.
+   */
+  getZConfig(): object;
+
+  /**
+   * Retrieves the color of the X-axis.
+   *
+   * @return {RGBColor} The color of the X-axis.
+   */
+  getXAxisColor(): RGBColor;
+
+  /**
+   * Retrieves the color of the Y-axis.
+   *
+   * @return {RGBColor} The color of the Y-axis.
+   */
+  getYAxisColor(): RGBColor;
+
+  /**
+   * Retrieves the color of the Z-axis.
+   *
+   * @return {RGBColor} The color of the Z-axis.
+   */
+  getZAxisColor(): RGBColor;
+
+  /**
+   * Set config object of the actor.
+   * @param config
+   */
+  setConfig(config: object): boolean;
+
+  /**
+   * Set config object of the X axis.
+   * @param config
+   */
+  setXConfig(config: object): boolean;
+
+  /**
+   * Set config object of the Y axis.
+   * @param config
+   */
+  setYConfig(config: object): boolean;
+
+  /**
+   * Set config object of the Z axis.
+   * @param config
+   */
+  setZConfig(config: object): boolean;
+
+  /**
+   * Set X axis color.
+   * @param {RGBColor} rgb An Array of the RGB color.
+   */
+  setXAxisColor(rgb: RGBColor): boolean;
+
+  /**
+   * Set Y axis color.
+   * @param {RGBColor} rgb An Array of the RGB color.
+   */
+  setYAxisColor(rgb: RGBColor): boolean;
+
+  /**
+   * Set Z axis color.
+   * @param {RGBColor} rgb An Array of the RGB color.
+   */
+  setZAxisColor(rgb: RGBColor): boolean;
+
+  /**
+   * Update the actor.
+   */
+  update(): void;
 }
 
 /**
@@ -111,15 +114,15 @@ export function extend(publicAPI: object, model: object, initialValues?: IAxesAc
  */
 export function newInstance(initialValues?: IAxesActorInitialValues): vtkAxesActor;
 
-/** 
- * vtkAxesActor is a hybrid 2D/3D actor used to represent 3D axes in a scene. 
- * The user can define the geometry to use for the shaft or the tip, 
- * and the user can set the text for the three axes. The text will appear 
- * to follow the camera since it is implemented by means of vtkCaptionActor2D. 
- * All of the functionality of the underlying vtkCaptionActor2D objects are accessible so that, 
- * for instance, the font attributes of the axes text can be manipulated through vtkTextProperty. 
- * Since this class inherits from vtkProp3D, one can apply a user transform to the underlying 
- * geometry and the positioning of the labels. For example, a rotation transform could be used to 
+/**
+ * vtkAxesActor is a hybrid 2D/3D actor used to represent 3D axes in a scene.
+ * The user can define the geometry to use for the shaft or the tip,
+ * and the user can set the text for the three axes. The text will appear
+ * to follow the camera since it is implemented by means of vtkCaptionActor2D.
+ * All of the functionality of the underlying vtkCaptionActor2D objects are accessible so that,
+ * for instance, the font attributes of the axes text can be manipulated through vtkTextProperty.
+ * Since this class inherits from vtkProp3D, one can apply a user transform to the underlying
+ * geometry and the positioning of the labels. For example, a rotation transform could be used to
  * generate a left-handed axes representation.
  * @see [vtkAnnotatedCubeActor](./Rendering_Core_AnnotatedCubeActor.html)
  * @see [vtkOrientationMarkerWidget](./Interaction_Widgets_OrientationMarkerWidget.html)

package/Widgets/Core/WidgetManager.d.ts

@@ -171,6 +171,23 @@ export interface vtkWidgetManager extends vtkObject {
    * Release the focus.
    */
   releaseFocus(): void;
+
+  /**
+   * Sets the default cursor styles.
+   *
+   * Known style keys:
+   * - default: when not interacting with a widget
+   * - hover: when hovering over a widget.
+   *
+   * If a known style key is not present, the cursor style will not be changed.
+   * @param {Record<string, string>} cursorStyles
+   */
+  setCursorStyles(cursorStyles: Record<string, string>): boolean;
+
+  /**
+   * Retrieves the current cursor styles.
+   */
+  getCursorStyles(): Record<string, string>;
 }
 
 export interface IWidgetManagerInitialValues {

package/Widgets/Core/WidgetManager.js

@@ -157,7 +157,12 @@ function vtkWidgetManager(publicAPI, model) {
     }
 
     // Default cursor behavior
-    model._apiSpecificRenderWindow.setCursor(widget ? 'pointer' : 'default');
+    const cursorStyles = publicAPI.getCursorStyles();
+    const style = widget ? 'hover' : 'default';
+    const cursor = cursorStyles[style];
+    if (cursor) {
+      model._apiSpecificRenderWindow.setCursor(cursor);
+    }
     model.activeWidget = null;
     let wantRender = false;
     if (model.widgetInFocus === widget && widget.hasFocus()) {
@@ -407,30 +412,40 @@ function vtkWidgetManager(publicAPI, model) {
 // Object factory
 // ----------------------------------------------------------------------------
 
-const DEFAULT_VALUES = {
-  // _camera: null,
-  // _selector: null,
-  // _currentUpdateSelectionCallID: null,
-  viewId: null,
-  widgets: [],
-  activeWidget: null,
-  renderer: null,
-  viewType: ViewTypes.DEFAULT,
-  isAnimating: false,
-  pickingEnabled: true,
-  selections: null,
-  previousSelectedData: null,
-  widgetInFocus: null,
-  captureOn: CaptureOn.MOUSE_MOVE
+const defaultValues = function () {
+  let initialValues = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return {
+    // _camera: null,
+    // _selector: null,
+    // _currentUpdateSelectionCallID: null,
+    viewId: null,
+    widgets: [],
+    activeWidget: null,
+    renderer: null,
+    viewType: ViewTypes.DEFAULT,
+    isAnimating: false,
+    pickingEnabled: true,
+    selections: null,
+    previousSelectedData: null,
+    widgetInFocus: null,
+    captureOn: CaptureOn.MOUSE_MOVE,
+    ...initialValues,
+    cursorStyles: initialValues.cursorStyles ? {
+      ...initialValues.cursorStyles
+    } : {
+      default: 'default',
+      hover: 'pointer'
+    }
+  };
 };
 
 // ----------------------------------------------------------------------------
 
 function extend(publicAPI, model) {
   let initialValues = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-  Object.assign(model, DEFAULT_VALUES, initialValues);
+  Object.assign(model, defaultValues(initialValues));
   macro.obj(publicAPI, model);
-  macro.setGet(publicAPI, model, ['captureOn', {
+  macro.setGet(publicAPI, model, ['captureOn', 'cursorStyles', {
     type: 'enum',
     name: 'viewType',
     enum: ViewTypes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitware/vtk.js",
-  "version": "30.1.2",
+  "version": "30.2.0",
   "description": "Visualization Toolkit for the Web",
   "keywords": [
     "3d",

package/types.d.ts

@@ -56,7 +56,7 @@ declare type Matrix3x3 = [
   number
 ];
 /**
- * @deprecated The `Point` type is depracted, please use `Vector3` instead.
+ * @deprecated The `Point` type is deprecated, please use `Vector3` instead.
  */
 declare type Point = Vector3;
 declare type HSLColor = [number, number, number];