fix(ImageSlice): typescript definitions

jadh4v · jadh4v · commit 1b1e75670313 · 2023-08-23T15:39:36.000Z
Fix typescript definition error when using vtkImageResliceMapper with
vtkImageSlice. Change vtkImageSlice to accept vtkAbstractImageMapper.

Fixes errors such as:
```
Argument of type 'vtkImageResliceMapper' is not assignable to parameter of type
'vtkImageMapper'. Type 'vtkImageResliceMapper' is missing the following
properties from type 'vtkImageMapper': getSliceAtPosition, getClosestIJKAxis,
getBoundsForSlice, getRenderToRectangle, and 15 more.
```
diff --git a/Sources/Rendering/Core/AbstractImageMapper/index.d.ts b/Sources/Rendering/Core/AbstractImageMapper/index.d.ts
@@ -1,6 +1,6 @@
 import vtkAbstractMapper3D, { IAbstractMapper3DInitialValues } from "../AbstractMapper3D";
 import vtkImageData from "../../../Common/DataModel/ImageData";
-import { Nullable } from "../../../types";
+import { Bounds, Extent, Nullable, RGBAColor } from "../../../types";
 
 
 export interface IAbstractImageMapperInitialValues extends IAbstractMapper3DInitialValues {
@@ -32,6 +32,45 @@ export interface vtkAbstractImageMapper extends vtkAbstractMapper3D {
 	 */
 	setSlice(slice: number): boolean;
 
+	/**
+	 * Get bounds for a specified slice.
+	 * To be implemented by derived classes.
+	 * @param {Number} slice The slice index. If undefined, the current slice is considered.
+	 * @param {Number} thickness The slice thickness. If undefined, 0 is considered.
+	 */
+	getBoundsForSlice(slice?: number, thickness?: number): Bounds;
+
+	/**
+	 * Return the currently set background color.
+	 */
+	getBackgroundColor(): RGBAColor;
+
+	/**
+	 * Return the currently set background color.
+	 */
+	getBackgroundColorByReference(): RGBAColor;
+
+	/**
+	 * @param r red component of background color
+	 * @param g green component of background color
+	 * @param b blue component of background color
+	 * @param a opacity component of background color
+	 */
+	setBackgroundColor(r: number, g: number, b: number, a: number): boolean;
+
+	/**
+	 *
+	 * @param color specify background color as an array of 4 values.
+	 */
+	setBackgroundColor(color: RGBAColor): boolean;
+
+	/**
+	 *
+	 * @param {RGBAColor} color specify the background color to use
+	 * in RGBA format as an array of 4 values. Values are copied.
+	 */
+	setBackgroundColorFrom(color: RGBAColor): boolean;
+
 	/**
 	 *
 	 */
@@ -43,6 +82,16 @@ export interface vtkAbstractImageMapper extends vtkAbstractMapper3D {
 	 */
 	setUseCustomExtents(useCustomExtents: boolean): boolean;
 
+	/**
+	 *
+	 */
+	getCustomDisplayExtent(): Extent;
+
+	/**
+	 *
+	 */
+	getCustomDisplayExtentByReference(): Extent;
+
 	/**
 	 *
 	 * @param {Number} x1 The x coordinate of the first point.
@@ -54,6 +103,12 @@ export interface vtkAbstractImageMapper extends vtkAbstractMapper3D {
 	 */
 	setCustomDisplayExtent(x1: number, x2: number, y1: number, y2: number, z1: number, z2: number): boolean;
 
+	/**
+	 *
+	 * @param extents specify extents as an array of 6 values [minx, maxx, ...]
+	 */
+	setCustomDisplayExtent(customDisplayExtent: Extent): boolean;
+
 	/**
 	 *
 	 * @param customDisplayExtent
diff --git a/Sources/Rendering/Core/AbstractImageMapper/index.js b/Sources/Rendering/Core/AbstractImageMapper/index.js
@@ -1,5 +1,6 @@
 import macro from 'vtk.js/Sources/macros';
 import vtkAbstractMapper3D from 'vtk.js/Sources/Rendering/Core/AbstractMapper3D';
+import { createUninitializedBounds } from 'vtk.js/Sources/Common/Core/Math';
 
 // ----------------------------------------------------------------------------
 // vtkAbstractImageMapper methods
@@ -11,6 +12,13 @@ function vtkAbstractImageMapper(publicAPI, model) {
   publicAPI.getIsOpaque = () => true;
 
   publicAPI.getCurrentImage = () => null;
+
+  publicAPI.getBoundsForSlice = () => {
+    macro.vtkErrorMacro(
+      'vtkAbstractImageMapper.getBoundsForSlice - NOT IMPLEMENTED'
+    );
+    return createUninitializedBounds();
+  };
 }
 
 // ----------------------------------------------------------------------------
diff --git a/Sources/Rendering/Core/AbstractMapper3D/index.js b/Sources/Rendering/Core/AbstractMapper3D/index.js
@@ -1,6 +1,7 @@
 import macro from 'vtk.js/Sources/macros';
 import vtkAbstractMapper from 'vtk.js/Sources/Rendering/Core/AbstractMapper';
 import vtkBoundingBox from 'vtk.js/Sources/Common/DataModel/BoundingBox';
+import { createUninitializedBounds } from 'vtk.js/Sources/Common/Core/Math';
 
 // ----------------------------------------------------------------------------
 // vtkAbstractMapper methods
@@ -9,6 +10,7 @@ import vtkBoundingBox from 'vtk.js/Sources/Common/DataModel/BoundingBox';
 function vtkAbstractMapper3D(publicAPI, model) {
   publicAPI.getBounds = () => {
     macro.vtkErrorMacro(`vtkAbstractMapper3D.getBounds - NOT IMPLEMENTED`);
+    return createUninitializedBounds();
   };
 
   publicAPI.getCenter = () => {
diff --git a/Sources/Rendering/Core/ImageArrayMapper/index.d.ts b/Sources/Rendering/Core/ImageArrayMapper/index.d.ts
@@ -52,9 +52,9 @@ export interface vtkImageArrayMapper extends vtkAbstractImageMapper {
 	 * @param {Number} [slice] The slice index. If undefined, the current slice is considered.
 	 * @param {Number} [halfThickness] Half the slice thickness in index space (unit voxel
 	 * spacing). If undefined, 0 is considered.
-	 * @return {Number[]} The bounds for a given slice.
+	 * @return {Bounds} The bounds for a given slice.
 	 */
-	getBoundsForSlice(slice?: number, halfThickness?: number): number[];
+	getBoundsForSlice(slice?: number, halfThickness?: number): Bounds;
 
 	/**
 	 * Get the closest IJK axis
diff --git a/Sources/Rendering/Core/ImageMapper/index.d.ts b/Sources/Rendering/Core/ImageMapper/index.d.ts
@@ -46,9 +46,9 @@ export interface vtkImageMapper extends vtkAbstractImageMapper {
 	 * @param {Number} [slice] The slice index. If undefined, the current slice is considered.
 	 * @param {Number} [halfThickness] Half the slice thickness in index space (unit voxel
 	 * spacing). If undefined, 0 is considered.
-	 * @return {Number[]} The bounds for a given slice.
+	 * @return {Bounds} The bounds for a given slice.
 	 */
-	getBoundsForSlice(slice?: number, halfThickness?: number): number[];
+	getBoundsForSlice(slice?: number, halfThickness?: number): Bounds;
 
 	/**
 	 *
diff --git a/Sources/Rendering/Core/ImageSlice/index.d.ts b/Sources/Rendering/Core/ImageSlice/index.d.ts
@@ -1,10 +1,10 @@
 import { Bounds } from "../../../types";
 import vtkImageProperty, { IImagePropertyInitialValues } from "../ImageProperty";
-import vtkImageMapper from "../ImageMapper";
+import vtkAbstractImageMapper from "../AbstractImageMapper";
 import vtkProp3D, { IProp3DInitialValues } from "../Prop3D";
 
 export interface IImageSliceInitialValues extends IProp3DInitialValues{
-	mapper?: vtkImageMapper;
+	mapper?: vtkAbstractImageMapper;
 	property?: vtkImageProperty;
 	bounds?: Bounds;
 }
@@ -55,7 +55,7 @@ export interface vtkImageSlice extends vtkProp3D {
 	/**
 	 * 
 	 */
-	getMapper(): vtkImageMapper;
+	getMapper(): vtkAbstractImageMapper;
 	
 	/**
 	 * Get the minimum X bound
@@ -126,9 +126,9 @@ export interface vtkImageSlice extends vtkProp3D {
 
 	/**
 	 * 
-	 * @param {vtkImageMapper} mapper The vtkImageMapper instance.
+	 * @param {vtkAbstractImageMapper} mapper An instance that derives from vtkAbstractImageMapper.
 	 */
-	setMapper(mapper: vtkImageMapper): boolean;
+	setMapper(mapper: vtkAbstractImageMapper): boolean;
 
 	/**
 	 * 
