feat(WidgetManager): customize cursor styles

Kitware · Mar 25, 2024 · 14fabed · 14fabed
1 parent 723c19a
commit 14fabed
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 4 deletions.
diff --git a/Sources/Widgets/Core/WidgetManager/index.d.ts b/Sources/Widgets/Core/WidgetManager/index.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 {

diff --git a/Sources/Widgets/Core/WidgetManager/index.js b/Sources/Widgets/Core/WidgetManager/index.js
@@ -151,7 +151,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;
@@ -461,7 +466,7 @@ function vtkWidgetManager(publicAPI, model) {
 // Object factory
 // ----------------------------------------------------------------------------
 
-const DEFAULT_VALUES = {
+const defaultValues = (initialValues = {}) => ({
   // _camera: null,
   // _selector: null,
   // _currentUpdateSelectionCallID: null,
@@ -476,16 +481,25 @@ const DEFAULT_VALUES = {
   previousSelectedData: null,
   widgetInFocus: null,
   captureOn: CaptureOn.MOUSE_MOVE,
-};
+  ...initialValues,
+
+  cursorStyles: initialValues.cursorStyles
+    ? { ...initialValues.cursorStyles }
+    : {
+        default: 'default',
+        hover: 'pointer',
+      },
+});
 
 // ----------------------------------------------------------------------------
 
 export function extend(publicAPI, model, initialValues = {}) {
-  Object.assign(model, DEFAULT_VALUES, initialValues);
+  Object.assign(model, defaultValues(initialValues));
 
   macro.obj(publicAPI, model);
   macro.setGet(publicAPI, model, [
     'captureOn',
+    'cursorStyles',
     { type: 'enum', name: 'viewType', enum: ViewTypes },
   ]);
   macro.get(publicAPI, model, [