fix(ts): Add typescript specific to widget behavior

Sources/Common/Core/DataArray/index.d.ts

@@ -62,6 +62,15 @@ export interface vtkDataArray extends vtkObject {
 	 */
 	getData(): number[]|TypedArray;
 
+	/**
+	 * Call this method when the underlying data has changed
+	 * This method calls `modified()`
+	 * For example, when you need to modify chunks of the array, it is faster
+	 * to get the underlying array with `getData()`, modify it, and then call
+	 * `dataChange()`.
+	 */
+	dataChange(): void;
+
 	/**
 	 * Get the range of the given component.
 	 *

Sources/Widgets/Core/AbstractWidgetFactory/index.d.ts

@@ -12,15 +12,15 @@ export interface IGetWidgetForViewParams {
   initialValues?: object;
 }
 
-export interface vtkAbstractWidgetFactory extends vtkObject {
+export interface vtkAbstractWidgetFactory<WidgetInstance extends vtkAbstractWidget> extends vtkObject {
   /**
    * Will return the widget associated with the view with Id id `locator.viewId`. 
    * If there is no widget associated with the view, a new widget will be constructed, provided
    * that the renderer, viewType, and optionally initialValues are also provided.
    * 
    * @param {IGetWidgetForViewParams} locator
    */
-  getWidgetForView(locator: IGetWidgetForViewParams): Nullable<vtkAbstractWidget>;
+  getWidgetForView(locator: IGetWidgetForViewParams): Nullable<WidgetInstance>;
 
   /**
    * Get a list of all the view ids.
@@ -107,21 +107,43 @@ export interface vtkAbstractWidgetFactory extends vtkObject {
   invokeWidgetChangeEvent(...args: unknown[]): void;
 }
 
+/**
+ * This hack is to "remember" the generic type T that this function turn publicAPI into
+ * This is because typescript is completely "structural" and doesn't have any way to declare "nominal" types
+ * See: https://github.com/microsoft/TypeScript/issues/202
+ * For example, in this code, widgetInstance is a vtkResliceCursorWidgetCPRInstance:
+ * 
+ * import vtkResliceCursorWidget from '@kitware/vtk.js/Widgets/Widgets3D/ResliceCursorWidget';
+ * import widgetBehavior from '@kitware/vtk.js/Widgets/Widgets3D/ResliceCursorWidget/cprBehavior';
+ *
+ * const widget = vtkResliceCursorWidget.newInstance({
+ *   planes: ['Y', 'Z'],
+ *   behavior: widgetBehavior,
+ * });
+ * const widgetInstance = widgetManager.addWidget(widget);
+ */
+declare const ExtendSymbol: unique symbol;
+export type ExtendWidgetBehavior<WidgetInstance> = ((publicAPI: object, model: object) => void) & { [ExtendSymbol]: WidgetInstance };
+
+export interface IAbstractWidgetFactoryInitialValues<WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget> {
+  behavior?: ExtendWidgetBehavior<WidgetInstance>;
+}
+
 /**
  * Method used to decorate a given object (publicAPI+model) with vtkAbstractWidgetFactory 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? : object): void;
+export function extend<WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget>(publicAPI: object, model: object, initialValues?: IAbstractWidgetFactoryInitialValues<WidgetInstance>): void;
 
 /**
  * Method used to create a new instance of vtkAbstractWidgetFactory
  * 
  * @param initialValues for pre-setting some of its content
  */
-export function newInstance(initialValues?: object): vtkAbstractWidgetFactory;
+export function newInstance<WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget>(initialValues?: IAbstractWidgetFactoryInitialValues<WidgetInstance>): vtkAbstractWidgetFactory<WidgetInstance>;
 
 export declare const vtkAbstractWidgetFactory: {
 	newInstance: typeof newInstance,

Sources/Widgets/Core/WidgetManager/index.d.ts

@@ -129,11 +129,11 @@ export interface vtkWidgetManager extends vtkObject {
    * @param {ViewTypes} [viewType]
    * @param {Object} [initialValues]
    */
-  addWidget(
-    widget: vtkAbstractWidgetFactory,
+  addWidget<WidgetFactory extends vtkAbstractWidgetFactory<any>>(
+    widget: WidgetFactory,
     viewType?: ViewTypes,
     initialValues?: object
-  ): Nullable<vtkAbstractWidget>;
+  ): WidgetFactory extends vtkAbstractWidgetFactory<infer WidgetInstance> ? WidgetInstance : never;
 
   /**
    * Unregister all widgets from the widget manager.
@@ -145,7 +145,7 @@ export interface vtkWidgetManager extends vtkObject {
    * 
    * @param {vtkAbstractWidget | vtkAbstractWidgetFactory} widget The widget to remove
    */
-  removeWidget(widget: vtkAbstractWidget | vtkAbstractWidgetFactory): void;
+  removeWidget(widget: vtkAbstractWidget | vtkAbstractWidgetFactory<any>): void;
 
   /**
    * Given x and y parameter, get selected data.
@@ -165,7 +165,7 @@ export interface vtkWidgetManager extends vtkObject {
    * 
    * @param {vtkAbstractWidget | vtkAbstractWidgetFactory} widget The widget instance which should get the focus.
    */
-  grabFocus(widget: vtkAbstractWidget | vtkAbstractWidgetFactory): void;
+  grabFocus(widget: vtkAbstractWidget | vtkAbstractWidgetFactory<any>): void;
 
   /**
    * Release the focus.

Sources/Widgets/Widgets3D/InteractiveOrientationWidget/index.d.ts

@@ -1,8 +1,9 @@
-import vtkAbstractWidgetFactory from "../../Core/AbstractWidgetFactory";
+import { vtkAbstractWidgetFactory, IAbstractWidgetFactoryInitialValues } from "../../Core/AbstractWidgetFactory";
+import vtkAbstractWidget from '../../Core/AbstractWidget'
 import { Bounds } from "../../../types";
 import { ViewTypes } from "../../Core/WidgetManager/Constants";
 
-export interface vtkInteractiveOrientationWidget extends vtkAbstractWidgetFactory {
+export interface vtkInteractiveOrientationWidget<WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget> extends vtkAbstractWidgetFactory<WidgetInstance> {
   /**
    * Set the widget bounds
    * 
@@ -16,21 +17,23 @@ export interface vtkInteractiveOrientationWidget extends vtkAbstractWidgetFactor
   getRepresentationForViewType(viewType: ViewTypes): unknown;
 }
 
+export interface IInteractiveOrientationWidgetInitialValues<WidgetInstance extends vtkAbstractWidget> extends IAbstractWidgetFactoryInitialValues<WidgetInstance> {}
+
 /**
  * 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;
+export function extend<WidgetInstance extends vtkAbstractWidget>(publicAPI: object, model: object, initialValues? : IInteractiveOrientationWidgetInitialValues<WidgetInstance>): 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 function newInstance<WidgetInstance extends vtkAbstractWidget = vtkAbstractWidget>(initialValues? : IInteractiveOrientationWidgetInitialValues<WidgetInstance>): vtkInteractiveOrientationWidget<WidgetInstance>;
 
 export declare const vtkInteractiveOrientationWidget: {
 	newInstance: typeof newInstance,

Sources/Widgets/Widgets3D/ResliceCursorWidget/behavior.d.ts

@@ -0,0 +1,5 @@
+import vtkAbstractWidget from "../../Core/AbstractWidget";
+
+export default interface vtkResliceCursorWidgetDefaultInstance extends vtkAbstractWidget {
+    invokeInternalInteractionEvent: () => void;
+}

Sources/Widgets/Widgets3D/ResliceCursorWidget/index.d.ts

@@ -1,5 +1,7 @@
 import { mat4 } from 'gl-matrix';
-import vtkAbstractWidgetFactory from '../../Core/AbstractWidgetFactory';
+import { vtkAbstractWidgetFactory, IAbstractWidgetFactoryInitialValues } from '../../Core/AbstractWidgetFactory';
+import vtkResliceCursorWidgetDefaultInstance from './behavior';
+import vtkAbstractWidget from '../../Core/AbstractWidget'
 import vtkImageData from '../../../Common/DataModel/ImageData';
 import vtkImageReslice from '../../../Imaging/Core/ImageReslice';
 import vtkPlaneSource from '../../../Filters/Sources/PlaneSource';
@@ -16,7 +18,7 @@ export interface IDisplayScaleParams {
   rendererPixelDims: Vector2
 }
 
-export interface vtkResliceCursorWidget extends vtkAbstractWidgetFactory {
+export interface vtkResliceCursorWidget<WidgetInstance extends vtkAbstractWidget = vtkResliceCursorWidgetDefaultInstance> extends vtkAbstractWidgetFactory<WidgetInstance> {
 
   /**
    * @param {ViewTypes} viewType
@@ -81,7 +83,7 @@ export interface vtkResliceCursorWidget extends vtkAbstractWidgetFactory {
 
 }
 
-export interface IResliceCursorWidgetInitialValues {}
+export interface IResliceCursorWidgetInitialValues<WidgetInstance extends vtkAbstractWidget> extends IAbstractWidgetFactoryInitialValues<WidgetInstance> {}
 
 /**
  * Method used to decorate a given object (publicAPI+model) with vtkResliceCursorWidget characteristics.
@@ -90,18 +92,18 @@ export interface IResliceCursorWidgetInitialValues {}
  * @param model object on which data structure will be bounds (protected)
  * @param initialValues (default: {})
  */
-export function extend(
+export function extend<WidgetInstance extends vtkAbstractWidget>(
   publicAPI: object,
   model: object,
-  initialValues?: IResliceCursorWidgetInitialValues
-): vtkResliceCursorWidget;
+  initialValues?: IResliceCursorWidgetInitialValues<WidgetInstance>
+): void;
 
 /**
  * Method used to create a new instance of vtkResliceCursorWidget
  * 
  * @param initialValues for pre-setting some of its content
  */
-export function newInstance(initialValues?: IResliceCursorWidgetInitialValues): vtkResliceCursorWidget;
+export function newInstance<WidgetInstance extends vtkAbstractWidget = vtkResliceCursorWidgetDefaultInstance>(initialValues?: IResliceCursorWidgetInitialValues<WidgetInstance>): vtkResliceCursorWidget<WidgetInstance>;
 
 export declare const vtkResliceCursorWidget: {
   newInstance: typeof newInstance;