@kitware/vtk.js 24.18.6 → 24.18.9

package/Widgets/Core/WidgetManager.d.ts

@@ -0,0 +1,216 @@
+import vtkAbstractWidget from './AbstractWidget';
+import vtkAbstractWidgetFactory from './AbstractWidgetFactory';
+import vtkCamera from './../../Rendering/Core/Camera';
+import vtkProp from './../../Rendering/Core/Prop';
+import vtkRenderer from './../../Rendering/Core/Renderer';
+import vtkRenderWindow from './../../Rendering/Core/RenderWindow';
+import vtkRenderWindowInteractor from './../../Rendering/Core/RenderWindowInteractor';
+import vtkSelectionNode from './../../Common/DataModel/SelectionNode';
+import vtkWidgetRepresentation from './../Representations/WidgetRepresentation';
+import vtkWidgetState from './WidgetState';
+import { vtkObject } from './../../interfaces';
+import { CaptureOn, ViewTypes } from './WidgetManager/Constants';
+import { Nullable } from './../../types';
+
+export interface ISelectedData {
+  requestCount: number;
+  propID: number;
+  compositeID: number;
+  prop: vtkProp;
+  widget: vtkAbstractWidget;
+  representation: vtkWidgetRepresentation;
+  selectedState: vtkWidgetState;
+}
+
+export interface IRenderingComponents {
+  renderer: vtkRenderer;
+  renderWindow: vtkRenderWindow;
+  interactor: vtkRenderWindowInteractor;
+  apiSpecificRenderWindow: vtkRenderWindow;
+  camera: vtkCamera;
+}
+
+/**
+ * Extract the rendering components from the given renderer.
+ * 
+ * @param renderer
+ */
+export function extractRenderingComponents(renderer: vtkRenderer): IRenderingComponents;
+
+export interface vtkWidgetManager extends vtkObject {
+  /**
+   * The the captureOn value. 
+   * `CaptureOn.MOUSE_MOVE`: captures small region when moving mouse
+   * `CaptureOn.MOUSE_RELEASE`: captures entire region when mouse button is released
+   * 
+   * @param {CaptureOn} captureOn
+   */
+  setCaptureOn(captureOn: CaptureOn): boolean;
+
+  /**
+   * Get the captureOn value.
+   */
+  getCaptureOn(): CaptureOn;
+
+  /**
+   * The the view type.
+   * 
+   * @param {ViewTypes} type
+   */
+  setViewType(type: ViewTypes): boolean;
+
+  /**
+   * Get the view type.
+   */
+  getViewType(): ViewTypes;
+
+  /**
+   * Get the current selection.
+   */
+  getSelections(): vtkSelectionNode[];
+
+  /**
+   * Get all the underlying widgets.
+   */
+  getWidgets(): vtkAbstractWidget[];
+
+  /**
+   * Get the view id.
+   */
+  getViewId(): string;
+
+  /**
+   * Returns true if picking is enabled, false otherwise.
+   */
+  getPickingEnabled(): boolean;
+
+  /**
+   * @deprecated
+   */
+  getUseSvgLayer(): boolean;
+
+  /**
+   * @deprecated
+   */
+  setUseSvgLayer(use: boolean): boolean;
+
+  /**
+   * Enable the picking.
+   */
+  enablePicking(): void;
+
+  /**
+   * Renders all the widgets.
+   */
+  renderWidgets(): void;
+
+  /**
+   * Disable the picking.
+   */
+  disablePicking(): void;
+
+  /**
+   * Set the renderer.
+   * 
+   * @param {vtkRenderer} renderer
+   */
+  setRenderer(renderer: vtkRenderer): void;
+
+  /**
+   * Register a widget on the widget manager instance. 
+   * Please note that one should link the widget manager to a view before calling this method. 
+   * 
+   * @param {vtkAbstractWidgetFactory} widget The abstract widget factory.
+   * @param {ViewTypes} [viewType]
+   * @param {Object} [initialValues]
+   */
+  addWidget(
+    widget: vtkAbstractWidgetFactory,
+    viewType?: ViewTypes,
+    initialValues?: object
+  ): Nullable<vtkAbstractWidget>;
+
+  /**
+   * Unregister all widgets from the widget manager.
+   */
+  removeWidgets(): void;
+
+  /**
+   * Remove a widget from the widget manager.
+   * 
+   * @param {vtkAbstractWidget | vtkAbstractWidgetFactory} widget The widget to remove
+   */
+  removeWidget(widget: vtkAbstractWidget | vtkAbstractWidgetFactory): void;
+
+  /**
+   * Given x and y parameter, get selected data.
+   * 
+   * @param {Number} x
+   * @param {Number} y
+   */
+  getSelectedDataForXY(x: number, y: number): Promise<ISelectedData>;
+
+  /**
+   * @deprecated
+   */
+  updateSelectionFromXY(x: number, y: number): void;
+
+  /**
+   * @deprecated
+   */
+  updateSelectionFromMouseEvent(event: MouseEvent): void;
+
+  /**
+   * The all currently selected data.
+   */
+  getSelectedData(): ISelectedData | {};
+
+  /**
+   * Given the focus to the given widget instance.
+   * 
+   * @param {vtkAbstractWidget | vtkAbstractWidgetFactory} widget The widget instance which should get the focus.
+   */
+  grabFocus(widget: vtkAbstractWidget | vtkAbstractWidgetFactory): void;
+
+  /**
+   * Release the focus.
+   */
+  releaseFocus(): void;
+}
+
+export interface IWidgetManagerInitialValues {
+  captureOn?: CaptureOn;
+  viewType?: ViewTypes;
+  pickingEnabled?: boolean;
+  /**
+   * @deprecated
+   */
+  useSvgLayer?: boolean;
+}
+
+/**
+ * Method used to decorate a given object (publicAPI+model) with vtkWidgetManager characteristics.
+ *
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param initialValues (default: {})
+ */
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IWidgetManagerInitialValues
+): vtkWidgetManager;
+
+/**
+ * Method used to create a new instance of vtkCellArray
+ * 
+ * @param initialValues for pre-setting some of its content
+ */
+export function newInstance(initialValues?: IWidgetManagerInitialValues): vtkWidgetManager;
+
+export declare const vtkWidgetManager: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkWidgetManager;

package/Widgets/Core/WidgetState.d.ts

@@ -0,0 +1,81 @@
+import { vtkObject } from './../../interfaces';
+
+export interface vtkWidgetState extends vtkObject {
+  /**
+   * Set the active flag of the widget state instance
+   * 
+   * @param active The active flag
+   */
+  setActive(active: boolean): boolean;
+
+  /**
+   * Get the active flag of the widget state instance
+   */
+  getActive(): boolean;
+
+  /**
+   * Bind a state to one or more labels. If no label is provided, the default one will be used.
+   * 
+   * @param {vtkWidgetState} subState The state to bound.
+   * @param {String | String[]} [labels] The labels to which the state should be bound.
+   */
+  bindState(subState: vtkWidgetState, labels?: string | string[]): void;
+
+  /**
+   * Unbind a specific state from the widget state instance
+   * 
+   * @param {vtkWidgetState} subState The state to be unbound.
+   */
+  unbindState(subState: vtkWidgetState): void;
+
+  /**
+   * Unbind all states from the widget state instance
+   */
+  unbindAll(): void;
+
+  /**
+   * Activate the widget state instance. Same as calling `vtkWidgetState.setActive(true)`
+   */
+  activate(): void;
+
+  /**
+   * Deactivate thie widget state instance and all its sub states, except the `excludingState` argument.
+   * 
+   * @param {vtkWidgetState} [excludingState] A sub-state instance that should not be deactivated.
+   */
+  deactivate(excludingState?: vtkWidgetState): void;
+
+  /**
+   * Activate only the passed in sub state. Every other sub states will be deactivated.
+   * 
+   * @param {vtkWidgetState} subState The sub-state that should be activated.
+   */
+  activateOnly(subState: vtkWidgetState): void;
+
+  /**
+   * Get every states that are associated with the given label.
+   * 
+   * @param {String} label The label from which to retrieve the states.
+   */
+  getStatesWithLabel(label: string): vtkWidgetState[];
+
+  /**
+   * Get all the nested states on the widget state instance.
+   */
+  getAllNestedStates(): vtkWidgetState[];
+}
+
+/**
+ * Method use to decorate a given object (publicAPI+model) with vtkWidgetState characteristics.
+ *
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param {object} [initialValues] (default: {})
+ */
+export function extend(publicAPI: object, model: object, initialValues?: object): vtkWidgetState;
+
+export declare const vtkWidgetState: {
+  extend: typeof extend;
+};
+
+export default vtkWidgetState;

package/Widgets/Widgets3D/AngleWidget/behavior.js

@@ -5,7 +5,7 @@ import vtkPointPicker from '../../../Rendering/Core/PointPicker.js';
 var MAX_POINTS = 3;
 function widgetBehavior(publicAPI, model) {
   model.classHierarchy.push('vtkAngleWidgetProp');
-  var isDragging = null;
+  model._isDragging = false;
   var picker = vtkPointPicker.newInstance();
   picker.setPickFromList(1); // --------------------------------------------------------------------------
   // Display 2D
@@ -46,8 +46,8 @@ function widgetBehavior(publicAPI, model) {
       newHandle.setColor(moveHandle.getColor());
       newHandle.setScale1(moveHandle.getScale1());
       newHandle.setManipulator(manipulator);
-    } else {
-      isDragging = true;
+    } else if (model.dragable) {
+      model._isDragging = true;
 
       model._apiSpecificRenderWindow.setCursor('grabbing');
 
@@ -69,7 +69,8 @@ function widgetBehavior(publicAPI, model) {
     if (manipulator && model.pickable && model.dragable && model.activeState && model.activeState.getActive() && !ignoreKey(callData)) {
       var worldCoords = manipulator.handleEvent(callData, model._apiSpecificRenderWindow);
 
-      if (worldCoords.length && (model.activeState === model.widgetState.getMoveHandle() || isDragging)) {
+      if (worldCoords.length && (model.activeState === model.widgetState.getMoveHandle() || model._isDragging) && model.activeState.setOrigin // e.g. the line is pickable but not draggable
+      ) {
         model.activeState.setOrigin(worldCoords);
         publicAPI.invokeInteractionEvent();
         return macro.EVENT_ABORT;
@@ -87,32 +88,35 @@ function widgetBehavior(publicAPI, model) {
 
 
   publicAPI.handleLeftButtonRelease = function () {
-    if (isDragging && model.pickable) {
+    if (!model.activeState || !model.activeState.getActive() || !model.pickable) {
+      return macro.VOID;
+    }
+
+    if (model.hasFocus && model.widgetState.getHandleList().length === MAX_POINTS) {
+      publicAPI.loseFocus();
+      return macro.VOID;
+    }
+
+    if (model._isDragging) {
       model._apiSpecificRenderWindow.setCursor('pointer');
 
       model.widgetState.deactivate();
 
       model._interactor.cancelAnimation(publicAPI);
 
-      publicAPI.invokeEndInteractionEvent();
+      model._isDragging = false;
     } else if (model.activeState !== model.widgetState.getMoveHandle()) {
       model.widgetState.deactivate();
     }
 
     if (model.hasFocus && !model.activeState || model.activeState && !model.activeState.getActive()) {
-      publicAPI.invokeEndInteractionEvent();
-
       model._widgetManager.enablePicking();
 
       model._interactor.render();
-    } // Don't make any more points
-
-
-    if (model.widgetState.getHandleList().length === MAX_POINTS) {
-      publicAPI.loseFocus();
     }
 
-    isDragging = false;
+    publicAPI.invokeEndInteractionEvent();
+    return macro.EVENT_ABORT;
   }; // --------------------------------------------------------------------------
   // Focus API - modeHandle follow mouse when widget has focus
   // --------------------------------------------------------------------------

package/Widgets/Widgets3D/DistanceWidget/behavior.js

@@ -4,7 +4,7 @@ import macro from '../../../macros.js';
 var MAX_POINTS = 2;
 function widgetBehavior(publicAPI, model) {
   model.classHierarchy.push('vtkDistanceWidgetProp');
-  var isDragging = null; // --------------------------------------------------------------------------
+  model._isDragging = false; // --------------------------------------------------------------------------
   // Display 2D
   // --------------------------------------------------------------------------
 
@@ -41,8 +41,8 @@ function widgetBehavior(publicAPI, model) {
       newHandle.setColor(moveHandle.getColor());
       newHandle.setScale1(moveHandle.getScale1());
       newHandle.setManipulator(manipulator);
-    } else {
-      isDragging = true;
+    } else if (model.dragable) {
+      model._isDragging = true;
 
       model._apiSpecificRenderWindow.setCursor('grabbing');
 
@@ -59,17 +59,13 @@ function widgetBehavior(publicAPI, model) {
   publicAPI.handleMouseMove = function (callData) {
     var _model$activeState$ge3, _model$activeState2, _model$activeState2$g;
 
-    if (model.hasFocus && model.widgetState.getHandleList().length === MAX_POINTS) {
-      publicAPI.loseFocus();
-      return macro.VOID;
-    }
-
     var manipulator = (_model$activeState$ge3 = (_model$activeState2 = model.activeState) === null || _model$activeState2 === void 0 ? void 0 : (_model$activeState2$g = _model$activeState2.getManipulator) === null || _model$activeState2$g === void 0 ? void 0 : _model$activeState2$g.call(_model$activeState2)) !== null && _model$activeState$ge3 !== void 0 ? _model$activeState$ge3 : model.manipulator;
 
     if (manipulator && model.pickable && model.dragable && model.activeState && model.activeState.getActive() && !ignoreKey(callData)) {
       var worldCoords = manipulator.handleEvent(callData, model._apiSpecificRenderWindow);
 
-      if (worldCoords.length && (model.activeState === model.widgetState.getMoveHandle() || isDragging)) {
+      if (worldCoords.length && (model.activeState === model.widgetState.getMoveHandle() || model._isDragging) && model.activeState.setOrigin // e.g. the line is pickable but not draggable
+      ) {
         model.activeState.setOrigin(worldCoords);
         publicAPI.invokeInteractionEvent();
         return macro.EVENT_ABORT;
@@ -83,27 +79,35 @@ function widgetBehavior(publicAPI, model) {
 
 
   publicAPI.handleLeftButtonRelease = function () {
-    if (isDragging && model.pickable) {
+    if (!model.activeState || !model.activeState.getActive() || !model.pickable) {
+      return macro.VOID;
+    }
+
+    if (model.hasFocus && model.widgetState.getHandleList().length === MAX_POINTS) {
+      publicAPI.loseFocus();
+      return macro.VOID;
+    }
+
+    if (model._isDragging) {
       model._apiSpecificRenderWindow.setCursor('pointer');
 
       model.widgetState.deactivate();
 
       model._interactor.cancelAnimation(publicAPI);
 
-      publicAPI.invokeEndInteractionEvent();
+      model._isDragging = false;
     } else if (model.activeState !== model.widgetState.getMoveHandle()) {
       model.widgetState.deactivate();
     }
 
     if (model.hasFocus && !model.activeState || model.activeState && !model.activeState.getActive()) {
-      publicAPI.invokeEndInteractionEvent();
-
       model._widgetManager.enablePicking();
 
       model._interactor.render();
     }
 
-    isDragging = false;
+    publicAPI.invokeEndInteractionEvent();
+    return macro.EVENT_ABORT;
   }; // --------------------------------------------------------------------------
   // Focus API - modeHandle follow mouse when widget has focus
   // --------------------------------------------------------------------------

package/Widgets/Widgets3D/ImageCroppingWidget/behavior.js

@@ -3,7 +3,7 @@ import macro from '../../../macros.js';
 import { handleTypeFromName, AXES, transformVec3, rotateVec3 } from './helpers.js';
 
 function widgetBehavior(publicAPI, model) {
-  var isDragging = null;
+  model._isDragging = false;
 
   publicAPI.setDisplayCallback = function (callback) {
     return model.representations[0].setDisplayCallback(callback);
@@ -14,15 +14,19 @@ function widgetBehavior(publicAPI, model) {
       return macro.VOID;
     }
 
-    isDragging = true;
+    if (model.dragable) {
+      model._isDragging = true;
 
-    model._interactor.requestAnimation(publicAPI);
+      model._apiSpecificRenderWindow.setCursor('grabbing');
+
+      model._interactor.requestAnimation(publicAPI);
+    }
 
     return macro.EVENT_ABORT;
   };
 
   publicAPI.handleMouseMove = function (callData) {
-    if (isDragging && model.pickable && model.dragable) {
+    if (model._isDragging) {
       return publicAPI.handleEvent(callData);
     }
 
@@ -30,13 +34,19 @@ function widgetBehavior(publicAPI, model) {
   };
 
   publicAPI.handleLeftButtonRelease = function () {
-    if (isDragging && model.pickable) {
-      isDragging = false;
+    if (!model.activeState || !model.activeState.getActive() || !model.pickable) {
+      return macro.VOID;
+    }
+
+    if (model._isDragging) {
+      model._isDragging = false;
 
       model._interactor.cancelAnimation(publicAPI);
 
       model.widgetState.deactivate();
     }
+
+    return macro.EVENT_ABORT;
   };
 
   publicAPI.handleEvent = function (callData) {

package/Widgets/Widgets3D/ImplicitPlaneWidget.js

@@ -12,7 +12,7 @@ import { ViewTypes } from '../Core/WidgetManager/Constants.js';
 
 function widgetBehavior(publicAPI, model) {
   model.classHierarchy.push('vtkPlaneWidget');
-  var isDragging = null;
+  model._isDragging = false;
 
   publicAPI.setDisplayCallback = function (callback) {
     return model.representations[0].setDisplayCallback(callback);
@@ -47,19 +47,24 @@ function widgetBehavior(publicAPI, model) {
       return macro.VOID;
     }
 
-    isDragging = true;
     model.lineManipulator.setWidgetOrigin(model.widgetState.getOrigin());
     model.planeManipulator.setWidgetOrigin(model.widgetState.getOrigin());
     model.trackballManipulator.reset(callData); // setup trackball delta
 
-    model._interactor.requestAnimation(publicAPI);
+    if (model.dragable) {
+      model._isDragging = true;
+
+      model._apiSpecificRenderWindow.setCursor('grabbing');
+
+      model._interactor.requestAnimation(publicAPI);
+    }
 
     publicAPI.invokeStartInteractionEvent();
     return macro.EVENT_ABORT;
   };
 
   publicAPI.handleMouseMove = function (callData) {
-    if (isDragging && model.pickable) {
+    if (model._isDragging) {
       return publicAPI.handleEvent(callData);
     }
 
@@ -67,14 +72,19 @@ function widgetBehavior(publicAPI, model) {
   };
 
   publicAPI.handleLeftButtonRelease = function () {
-    if (isDragging && model.pickable) {
-      publicAPI.invokeEndInteractionEvent();
+    if (!model.activeState || !model.activeState.getActive() || !model.pickable) {
+      return macro.VOID;
+    }
 
+    if (model._isDragging) {
       model._interactor.cancelAnimation(publicAPI);
+
+      model._isDragging = false;
     }
 
-    isDragging = false;
     model.widgetState.deactivate();
+    publicAPI.invokeEndInteractionEvent();
+    return macro.EVENT_ABORT;
   };
 
   publicAPI.handleEvent = function (callData) {

package/Widgets/Widgets3D/InteractiveOrientationWidget.d.ts

@@ -0,0 +1,40 @@
+import vtkAbstractWidgetFactory from './../Core/AbstractWidgetFactory';
+import { Bounds } from './../../types';
+import { ViewTypes } from './../Core/WidgetManager/Constants';
+
+export interface vtkInteractiveOrientationWidget extends vtkAbstractWidgetFactory {
+  /**
+   * Set the widget bounds
+   * 
+   * @param {Bounds} bounds The widget bounds
+   */
+  setBounds(bounds: Bounds): void;
+
+  /**
+   * @param {ViewTypes} viewType
+   */
+  getRepresentationForViewType(viewType: ViewTypes): unknown;
+}
+
+/**
+ * Method use to decorate a given object (publicAPI+model) with vtkInteractiveOrientationWidget characteristics.
+ *
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param {object} [initialValues] (default: {})
+ */
+export function extend(publicAPI: object, model: object, initialValues? : Record<string, unknown>): void;
+
+/**
+ * Creates a new instance of vtkInteractiveOrientationWidget
+ * 
+ * @param {object} [initialValues] for pre-setting some of its content
+ */
+export function newInstance(initialValues? : Record<string, unknown>): vtkInteractiveOrientationWidget;
+
+export declare const vtkInteractiveOrientationWidget: {
+	newInstance: typeof newInstance,
+	extend: typeof extend,
+};
+
+export default vtkInteractiveOrientationWidget;

package/Widgets/Widgets3D/LabelWidget/behavior.js

@@ -6,7 +6,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function widgetBehavior(publicAPI, model) {
   model.classHierarchy.push('vtkLabelWidgetProp');
-  model.isDragging = null; // --------------------------------------------------------------------------
+  model._isDragging = false; // --------------------------------------------------------------------------
   // Public methods
   // --------------------------------------------------------------------------
 
@@ -56,8 +56,8 @@ function widgetBehavior(publicAPI, model) {
       moveHandle.setOrigin(worldCoords);
       model.widgetState.getText().setOrigin(moveHandle.getOrigin());
       publicAPI.loseFocus();
-    } else {
-      model.isDragging = true;
+    } else if (model.dragable) {
+      model._isDragging = true;
 
       model._apiSpecificRenderWindow.setCursor('grabbing');
 
@@ -72,27 +72,30 @@ function widgetBehavior(publicAPI, model) {
 
 
   publicAPI.handleLeftButtonRelease = function () {
-    if (model.isDragging && model.pickable) {
+    if (!model.activeState || !model.activeState.getActive() || !model.pickable) {
+      return macro.VOID;
+    }
+
+    if (model._isDragging) {
       model._apiSpecificRenderWindow.setCursor('pointer');
 
       model.widgetState.deactivate();
 
       model._interactor.cancelAnimation(publicAPI);
 
-      publicAPI.invokeEndInteractionEvent();
+      model._isDragging = false;
     } else if (model.activeState !== model.widgetState.getMoveHandle()) {
       model.widgetState.deactivate();
     }
 
     if (model.hasFocus && !model.activeState || model.activeState && !model.activeState.getActive()) {
-      publicAPI.invokeEndInteractionEvent();
-
       model._widgetManager.enablePicking();
 
       model._interactor.render();
     }
 
-    model.isDragging = false;
+    publicAPI.invokeEndInteractionEvent();
+    return macro.EVENT_ABORT;
   }; // --------------------------------------------------------------------------
   // Mouse move: Drag selected handle / Handle follow the mouse
   // --------------------------------------------------------------------------
@@ -106,7 +109,7 @@ function widgetBehavior(publicAPI, model) {
     if (manipulator && model.pickable && model.dragable && model.activeState && model.activeState.getActive() && !ignoreKey(callData)) {
       var worldCoords = manipulator.handleEvent(callData, model._apiSpecificRenderWindow);
 
-      if (worldCoords.length && (model.activeState === model.widgetState.getMoveHandle() || model.isDragging)) {
+      if (worldCoords.length && (model.activeState === model.widgetState.getMoveHandle() || model._isDragging)) {
         model.activeState.setOrigin(worldCoords);
         model.widgetState.getText().setOrigin(model.activeState.getOrigin());
         publicAPI.invokeInteractionEvent();