Merge pull request #2399 from daker/fix-ts-defs

jourdain · web-flow · commit a932c53eefc2 · 2022-05-05T20:24:20.000-06:00
docs(ts): fix typescript defs
diff --git a/Sources/Common/Core/ScalarsToColors/Constants.d.ts b/Sources/Common/Core/ScalarsToColors/Constants.d.ts
@@ -0,0 +1,18 @@
+export declare enum VectorMode {
+	MAGNITUDE = 0,
+	COMPONENT = 1,
+	RGBCOLORS = 2,
+}
+
+export declare enum ScalarMappingTarget {
+	LUMINANCE = 1,
+	LUMINANCE_ALPHA = 2,
+	RGB = 3,
+	RGBA = 4,
+}
+
+declare const _default: {
+	VectorMode: typeof VectorMode;
+	ScalarMappingTarget: typeof ScalarMappingTarget;
+};
+export default _default;
diff --git a/Sources/Common/Core/ScalarsToColors/index.d.ts b/Sources/Common/Core/ScalarsToColors/index.d.ts
@@ -1,19 +1,7 @@
-import { vtkObject } from "../../../interfaces" ;
-import { ColorMode } from "../../../Rendering/Core/Mapper";
-import { Range } from "../../../types" ;
-
-export enum VectorMode {
-	MAGNITUDE,
-	COMPONENT,
-	RGBCOLORS
-}
-
-export enum ScalarMappingTarget {
-	LUMINANCE,
-	LUMINANCE_ALPHA,
-	RGB,
-	RGBA
-}
+import { vtkObject } from "../../../interfaces";
+import { ColorMode } from "../../../Rendering/Core/Mapper/Constants";
+import { Range } from "../../../types";
+import { ScalarMappingTarget, VectorMode } from "./Constants";
 
 /**
  *
@@ -370,5 +358,7 @@ export function newInstance(initialValues?: IScalarsToColorsInitialValues): vtkS
 export declare const vtkScalarsToColors: {
 	newInstance: typeof newInstance;
 	extend: typeof extend;
+	VectorMode: typeof VectorMode;
+	ScalarMappingTarget: typeof VectorMode;
 }
 export default vtkScalarsToColors;
diff --git a/Sources/Common/DataModel/Box/index.d.ts b/Sources/Common/DataModel/Box/index.d.ts
@@ -1,5 +1,5 @@
-import { vtkObject } from "../../../interfaces" ;
-import { Bounds, Point } from "../../../types";
+import { vtkObject } from "../../../interfaces";
+import { Bounds, Vector3 } from "../../../types";
 
 
 export interface IBoxInitialValues {
@@ -22,9 +22,9 @@ export interface vtkBox extends vtkObject {
 
     /**
      * 
-     * @param {Point} x The point coordinate.
+     * @param {Vector3} x The point coordinate.
      */
-    evaluateFunction(x: Point): number;
+    evaluateFunction(x: Vector3): number;
 
     /**
      * 
diff --git a/Sources/Common/DataModel/ITKHelper/index.d.ts b/Sources/Common/DataModel/ITKHelper/index.d.ts
@@ -2,9 +2,9 @@ import vtkPolyData from "../PolyData";
 import vtkImageData from "../ImageData";
 
 export interface IOptions {
-	pointDataName: string;
-	scalarArrayName: string;
-	cellDataName: string;
+	pointDataName?: string;
+	scalarArrayName?: string;
+	cellDataName?: string;
 }
 
 /**
diff --git a/Sources/Common/DataModel/Line/index.d.ts b/Sources/Common/DataModel/Line/index.d.ts
@@ -77,7 +77,7 @@ export function newInstance(initialValues?: ILineInitialValues): vtkLine;
  *   t: tolerance of the distance
  *   distance: quared distance between closest point and x
  * }
- * 
+ * ```
  * @static
  * @param {Vector3} x 
  * @param {Vector3} p1 
diff --git a/Sources/Common/DataModel/PolyData/Constants.d.ts b/Sources/Common/DataModel/PolyData/Constants.d.ts
@@ -0,0 +1,6 @@
+export declare const POLYDATA_FIELDS : string[];
+
+declare const _default: {
+	POLYDATA_FIELDS: typeof POLYDATA_FIELDS;
+};
+export default _default;
diff --git a/Sources/Common/DataModel/Spline3D/Constants.d.ts b/Sources/Common/DataModel/Spline3D/Constants.d.ts
@@ -0,0 +1,9 @@
+export declare enum splineKind {
+	CARDINAL_SPLINE = 'CARDINAL_SPLINE',
+	KOCHANEK_SPLINE = 'KOCHANEK_SPLINE',
+}
+
+declare const _default: {
+	splineKind: typeof splineKind;
+};
+export default _default;
diff --git a/Sources/Common/DataModel/Spline3D/index.d.ts b/Sources/Common/DataModel/Spline3D/index.d.ts
@@ -1,10 +1,5 @@
-import { vtkObject } from "../../../interfaces" ;
-
-export enum splineKind {
-	CARDINAL_SPLINE,
-	KOCHANEK_SPLINE,
-}
-
+import { vtkObject } from "../../../interfaces";
+import { splineKind } from "./Constants";
 
 export interface ISpline3DInitialValues {
 	close?: boolean;
@@ -52,7 +47,7 @@ export function newInstance(initialValues?: ISpline3DInitialValues): vtkSpline3D
  * at any given point inside the spline intervals.
  */
 export declare const vtkSpline3D: {
-	newInstance: typeof newInstance,
-	extend: typeof extend
+	newInstance: typeof newInstance;
+	extend: typeof extend;
 };
 export default vtkSpline3D;
diff --git a/Sources/Filters/General/ImageCropFilter/index.d.ts b/Sources/Filters/General/ImageCropFilter/index.d.ts
@@ -1,10 +1,12 @@
 import { vtkAlgorithm, vtkObject } from "../../../interfaces";
 
+type CroppingPlanes = number[];
+
 /**
  *
  */
-interface IImageCropFilterInitialValues {
-	croppingPlanes?: any;
+export interface IImageCropFilterInitialValues {
+	croppingPlanes?: CroppingPlanes;
 }
 
 type vtkImageCropFilterBase = vtkObject & vtkAlgorithm;
@@ -15,18 +17,19 @@ export interface vtkImageCropFilter extends vtkImageCropFilterBase {
 	 * Get The cropping planes, in IJK space.
 	 * @default [0, 0, 0, 0, 0, 0].
 	 */
-	getCroppingPlanes(): number[];
+	getCroppingPlanes(): CroppingPlanes;
 
 	/**
 	 * Get The cropping planes, in IJK space.
 	 * @default [0, 0, 0, 0, 0, 0].
 	 */
-	getCroppingPlanesByReference(): number[];
+	getCroppingPlanesByReference(): CroppingPlanes;
 
 	/**
 	 *
 	 */
 	isResetAvailable(): boolean;
+
 	/**
 	 *
 	 */
@@ -43,13 +46,13 @@ export interface vtkImageCropFilter extends vtkImageCropFilterBase {
 	 *
 	 * @param croppingPlanes
 	 */
-	setCroppingPlanes(croppingPlanes: number[]): boolean;
+	setCroppingPlanes(croppingPlanes: CroppingPlanes): boolean;
 
 	/**
 	 *
 	 * @param croppingPlanes
 	 */
-	setCroppingPlanesFrom(croppingPlanes: number[]): boolean;
+	setCroppingPlanesFrom(croppingPlanes: CroppingPlanes): boolean;
 }
 
 /**
diff --git a/Sources/Interaction/Widgets/OrientationMarkerWidget/Constants.d.ts b/Sources/Interaction/Widgets/OrientationMarkerWidget/Constants.d.ts
@@ -0,0 +1,11 @@
+export declare enum Corners {
+	TOP_LEFT = 'TOP_LEFT',
+	TOP_RIGHT = 'TOP_RIGHT',
+	BOTTOM_LEFT = 'BOTTOM_LEFT',
+	BOTTOM_RIGHT = 'BOTTOM_RIGHT',
+}
+
+declare const _default: {
+	Corners: typeof Corners;
+};
+export default _default;
diff --git a/Sources/Interaction/Widgets/OrientationMarkerWidget/index.d.ts b/Sources/Interaction/Widgets/OrientationMarkerWidget/index.d.ts
@@ -4,13 +4,8 @@ import vtkAxesActor from "../../../Rendering/Core/AxesActor";
 import vtkRenderer from "../../../Rendering/Core/Renderer";
 import vtkRenderWindowInteractor from "../../../Rendering/Core/RenderWindowInteractor";
 import { Nullable } from "../../../types";
+import { Corners } from "./Constants";
 
-export enum Corners {
-	TOP_LEFT,
-	TOP_RIGHT,
-	BOTTOM_LEFT,
-	BOTTOM_RIGHT,
-}
 
 /**
  * 
@@ -177,5 +172,6 @@ export function newInstance(initialValues?: IOrientationMarkerWidgetInitialValue
 export declare const vtkOrientationMarkerWidget: {
 	newInstance: typeof newInstance;
 	extend: typeof extend;
+	Corners: typeof Corners;
 }
 export default vtkOrientationMarkerWidget;
diff --git a/Sources/Rendering/Core/Mapper/Constants.d.ts b/Sources/Rendering/Core/Mapper/Constants.d.ts
@@ -0,0 +1,26 @@
+export declare enum ColorMode {
+	DEFAULT = 0,
+	MAP_SCALARS = 1,
+	DIRECT_SCALARS = 2,
+}
+
+export declare enum ScalarMode {
+	DEFAULT = 0,
+	USE_POINT_DATA = 1,
+	USE_CELL_DATA = 2,
+	USE_POINT_FIELD_DATA = 3,
+	USE_CELL_FIELD_DATA = 4,
+	USE_FIELD_DATA = 5,
+}
+
+export declare enum GetArray {
+	BY_ID = 0,
+	BY_NAME = 1,
+}
+
+declare const _default: {
+	ColorMode: typeof ColorMode;
+	ScalarMode: typeof ScalarMode;
+	GetArray: typeof GetArray;
+};
+export default _default;
diff --git a/Sources/Rendering/Core/Mapper/index.d.ts b/Sources/Rendering/Core/Mapper/index.d.ts
@@ -1,25 +1,6 @@
 import { Bounds, Nullable, Range } from "../../../types";
 import vtkAbstractMapper3D, { IAbstractMapper3DInitialValues } from "../AbstractMapper3D";
-
-export enum ColorMode {
-	DEFAULT,
-	MAP_SCALARS,
-	DIRECT_SCALARS,
-}
-
-export enum ScalarMode {
-	DEFAULT,
-	USE_POINT_DATA,
-	USE_CELL_DATA,
-	USE_POINT_FIELD_DATA,
-	USE_CELL_FIELD_DATA,
-	USE_FIELD_DATA,
-}
-
-export enum GetArray {
-	BY_ID,
-	BY_NAME,
-}
+import { ColorMode, GetArray, ScalarMode } from "./Constants";
 
 interface IPrimitiveCount {
 	points: number;
@@ -166,7 +147,7 @@ export interface vtkMapper extends vtkAbstractMapper3D {
 	/**
 	 * Return the method of coloring scalar data.
 	 */
-	getColorMode(): number;
+	getColorMode(): ColorMode;
 
 	/**
 	 * Return the method of coloring scalar data.
@@ -643,5 +624,8 @@ export declare const vtkMapper: {
 	getResolveCoincidentTopologyLineOffsetParameters: typeof getResolveCoincidentTopologyLineOffsetParameters;
 	getResolveCoincidentTopologyPointOffsetParameters: typeof getResolveCoincidentTopologyPointOffsetParameters;
 	getResolveCoincidentTopologyPolygonOffsetParameters: typeof getResolveCoincidentTopologyPolygonOffsetParameters;
+	ColorMode: typeof ColorMode;
+	ScalarMode: typeof ScalarMode;
+	GetArray: typeof GetArray;
 }
 export default vtkMapper;
diff --git a/Sources/Rendering/Core/Property/Constants.d.ts b/Sources/Rendering/Core/Property/Constants.d.ts
@@ -0,0 +1,24 @@
+export declare enum Shading {
+	FLAT = 0,
+	GOURAUD = 1,
+	PHONG = 2,
+}
+
+export declare enum Representation {
+	POINTS = 0,
+	WIREFRAME = 1,
+	SURFACE = 2,
+}
+
+export declare enum Interpolation {
+	FLAT = 0,
+	GOURAUD = 1,
+	PHONG = 2,
+}
+
+declare const _default: {
+	Shading: typeof Shading;
+	Representation: typeof Representation;
+	Interpolation: typeof Interpolation;
+};
+export default _default;
diff --git a/Sources/Rendering/Core/Property/index.d.ts b/Sources/Rendering/Core/Property/index.d.ts
@@ -1,23 +1,6 @@
 import { vtkObject } from "../../../interfaces";
 import { RGBColor } from "../../../types";
-
-export enum Shading {
-	FLAT,
-	GOURAUD,
-	PHONG,
-}
-
-export enum Representation {
-	POINTS,
-	WIREFRAME,
-	SURFACE,
-}
-
-export enum Interpolation {
-	FLAT,
-	GOURAUD,
-	PHONG,
-}
+import { Interpolation, Representation, Shading } from "./Constants";
 
 export interface IPropertyInitialValues {
 	color?: RGBColor;
@@ -457,7 +440,10 @@ export function newInstance(initialValues?: IPropertyInitialValues): vtkProperty
  * manipulated with this object.
  */
 export declare const vtkProperty: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+	newInstance: typeof newInstance;
+	extend: typeof extend;
+	Shading: typeof Shading;
+	Representation: typeof Representation;
+	Interpolation: typeof Interpolation;
 };
 export default vtkProperty;
diff --git a/Sources/Rendering/Core/RenderWindowInteractor/Constants.d.ts b/Sources/Rendering/Core/RenderWindowInteractor/Constants.d.ts
@@ -0,0 +1,31 @@
+export declare enum Device {
+	Unknown = 0,
+	LeftController = 1,
+	RightController = 2,
+}
+
+export declare enum Input {
+	Unknown = 0,
+	Trigger = 1,
+	TrackPad = 2,
+	Grip = 3,
+	Thumbstick = 4,
+	A = 5,
+	B = 6,
+	ApplicationMenu = 7, // Not exposed in WebXR API
+}
+
+export declare enum Axis {
+	Unknown = 0,
+	TouchpadX = 1,
+	TouchpadY = 2,
+	ThumbstickX = 3,
+	ThumbstickY = 4,
+}
+
+declare const _default: {
+	Device: typeof Device;
+	Input: typeof Input;
+	Axis: typeof Axis;
+};
+export default _default;
diff --git a/Sources/Rendering/Core/RenderWindowInteractor/index.d.ts b/Sources/Rendering/Core/RenderWindowInteractor/index.d.ts
diff --git a/Sources/Rendering/Core/Viewport/index.d.ts b/Sources/Rendering/Core/Viewport/index.d.ts
diff --git a/Sources/Rendering/Core/VolumeMapper/Constants.d.ts b/Sources/Rendering/Core/VolumeMapper/Constants.d.ts
diff --git a/Sources/Rendering/Core/VolumeMapper/index.d.ts b/Sources/Rendering/Core/VolumeMapper/index.d.ts
diff --git a/Sources/Rendering/Core/VolumeProperty/index.d.ts b/Sources/Rendering/Core/VolumeProperty/index.d.ts
diff --git a/Sources/Rendering/Misc/FullScreenRenderWindow/index.d.ts b/Sources/Rendering/Misc/FullScreenRenderWindow/index.d.ts
diff --git a/Sources/Rendering/OpenGL/RenderWindow/index.d.ts b/Sources/Rendering/OpenGL/RenderWindow/index.d.ts
