@kitware/vtk.js 29.4.0 → 29.4.2

package/IO/Geometry/PLYWriter.js

@@ -216,9 +216,9 @@ function writePLY(polyData, format, dataByteOrder, headerComments, textureFileNa
       b = scalars.getData()[i * 3 + 2];
     }
     if (normals) {
-      nx = normals.getData()[i * 2];
-      ny = normals.getData()[i * 2 + 1];
-      nz = normals.getData()[i * 2 + 2];
+      nx = normals.getData()[i * 3];
+      ny = normals.getData()[i * 3 + 1];
+      nz = normals.getData()[i * 3 + 2];
     }
     writer.writeVertice(x, y, z, nx, ny, nz, u, v, r, g, b);
   }

package/Rendering/Core/Picker.d.ts

@@ -1,8 +1,9 @@
-import { Vector3 } from './../../types';
+import { Vector3, Nullable } from './../../types';
 import vtkAbstractPicker, { IAbstractPickerInitialValues } from './AbstractPicker';
 import vtkActor from './Actor';
 import vtkMapper from './Mapper';
 import vtkRenderer from './Renderer';
+import { vtkSubscription } from './../../interfaces';
 
 
 export interface IPickerInitialValues extends IAbstractPickerInitialValues {
@@ -13,6 +14,8 @@ export interface IPickerInitialValues extends IAbstractPickerInitialValues {
 	globalTMin?: number;
 }
 
+type OnPickChangeCallback = (pickedPositions: Vector3[]) => void
+
 export interface vtkPicker extends vtkAbstractPicker {
 
 	/**
@@ -21,29 +24,29 @@ export interface vtkPicker extends vtkAbstractPicker {
 	getActors(): vtkActor[];
 
 	/**
-	 * Get a pointer to the dataset that was picked (if any).
+	 * Get the dataset that was picked (if any).
 	 */
 	getDataSet(): any;
 
 	/**
 	 * Get mapper that was picked (if any)
 	 */
-	getMapper(): null | vtkMapper;
+	getMapper(): Nullable<vtkMapper>;
 
 	/**
 	 * Get position in mapper (i.e., non-transformed) coordinates of pick point.
 	 */
-	getMapperPosition(): number[];
+	getMapperPosition(): Vector3;
 
 	/**
-	 * 
+	 * Get position in mapper (i.e., non-transformed) coordinates of pick point.
 	 */
-	getMapperPositionByReference(): number[];
+	getMapperPositionByReference(): Vector3;
 
 	/**
-	 * Get a list of the points the actors returned by GetProp3Ds were intersected at.
+	 * Get a list of the points the actors returned by getActors were intersected at.
 	 */
-	getPickedPositions(): number[];
+	getPickedPositions(): Vector3[];
 
 	/**
 	 * Get tolerance for performing pick operation.
@@ -51,14 +54,18 @@ export interface vtkPicker extends vtkAbstractPicker {
 	getTolerance(): number;
 
 	/**
-	 * FIXME: this needs to be check again
+	 * Invoke a pick change event with the list of picked points.
+	 * This function is called internally by VTK.js and is not intended for public use.
+	 * @param {Vector3[]} pickedPositions
 	 */
-	//invokePickChange(pickedPositions: number[]): any;
+	invokePickChange(pickedPositions: Vector3[]): void;
 
 	/**
-	 * FIXME: this needs to be check again
+	 * Execute the given callback when the pickChange event is fired.
+	 * The callback receives an array of picked point positions.
+	 * @param {OnPickChangeCallback}
 	 */
-	//onPickChange(pickedPositions: number[]): any;
+	onPickChange(callback: OnPickChangeCallback): vtkSubscription;
 
 	/**
 	 * Intersect data with specified ray.
@@ -72,10 +79,10 @@ export interface vtkPicker extends vtkAbstractPicker {
 
 	/**
 	 * Perform pick operation with selection point provided.
-	 * @param selection 
-	 * @param {vtkRenderer} renderer The vtkRenderer instance.
+	 * @param {Vector3} selection First two values should be x-y pixel coordinate, the third is usually zero.
+	 * @param {vtkRenderer} renderer The renderer on which you want to do picking.
 	 */
-	pick(selection: any, renderer: vtkRenderer): any;
+	pick(selection: Vector3, renderer: vtkRenderer): void;
 
 	/**
 	 * Set position in mapper coordinates of pick point.
@@ -92,7 +99,9 @@ export interface vtkPicker extends vtkAbstractPicker {
 	setMapperPositionFrom(mapperPosition: Vector3): boolean;
 
 	/**
-	 * Specify tolerance for performing pick operation.
+	 * Specify tolerance for performing pick operation. Tolerance is specified
+	 * as fraction of rendering window size. (Rendering window size is measured
+	 * across diagonal.)
 	 * @param {Number} tolerance The tolerance value.
 	 */
 	setTolerance(tolerance: number): boolean;
@@ -127,6 +136,11 @@ export function newInstance(initialValues?: IPickerInitialValues): vtkPicker;
  * the prop itself, the data set, and the mapper. 
  * For vtkPicker the closest prop is the one whose center point (i.e., center of bounding box) projected on the view ray is closest
  * to the camera. Subclasses of vtkPicker use other methods for computing the pick point.
+ * 
+ * vtkPicker is used for quick geometric picking. If you desire more precise
+ * picking of points or cells based on the geometry of any vtkProp3D, use the
+ * subclasses vtkPointPicker or vtkCellPicker.  For hardware-accelerated
+ * picking of any type of vtkProp, use vtkPropPicker or vtkWorldPointPicker.
  */
 export declare const vtkPicker: {
 	newInstance: typeof newInstance,

package/Widgets/Widgets3D/ResliceCursorWidget/Constants.d.ts

@@ -1,5 +1,16 @@
+import { Vector3 } from '../../../types';
 import { ViewTypes } from '../../Core/WidgetManager/Constants';
 
+// Different types of plane from ViewTypes:
+export type PlaneViewType = ViewTypes.YZ_PLANE | ViewTypes.XZ_PLANE | ViewTypes.XY_PLANE;
+
+// 0, 1, 2 for X, Y, Z
+export type AxisIndex = 0 | 1 | 2;
+
+// Should be X, Y, Z
+export type PlaneName = typeof planeNames extends (infer U)[] ? U : never;
+
+
 export declare enum ScrollingMethods {
   MIDDLE_MOUSE_BUTTON = 0,
   LEFT_MOUSE_BUTTON = 1,
@@ -15,48 +26,29 @@ export declare enum InteractionMethodsName {
   TranslateCenterAndUpdatePlanes = 'translateCenterAndUpdatePlanes',
 }
 
-export declare type defaultViewUpFromViewType = {
-  [ViewTypes.YZ_PLANE]: [0, 0, 1], // Sagittal
-  [ViewTypes.XZ_PLANE]: [0, 0, 1], // Coronal
-  [ViewTypes.XY_PLANE]: [0, -1, 0], // Axial
-}
+export declare const defaultViewUpFromViewType: { [plane in PlaneViewType]: Vector3 };
 
-export declare type xyzToViewType = [
-  ViewTypes.YZ_PLANE,
-  ViewTypes.XZ_PLANE,
-  ViewTypes.XY_PLANE,
-];
+export declare const xyzToViewType: [PlaneViewType, PlaneViewType, PlaneViewType];
 
-export declare type viewTypeToXYZ = {
-  [ViewTypes.YZ_PLANE]: 0,
-  [ViewTypes.XZ_PLANE]: 1,
-  [ViewTypes.XY_PLANE]: 2,
-}
+export declare const viewTypeToXYZ: { [plane in PlaneViewType]: AxisIndex };
 
-export declare type planeNames = ['X', 'Y', 'Z'];
+export declare const planeNames: ['X', 'Y', 'Z'];
 
-export declare type viewTypeToPlaneName = {
-  [ViewTypes.YZ_PLANE]: 'X',
-  [ViewTypes.XZ_PLANE]: 'Y',
-  [ViewTypes.XY_PLANE]: 'Z',
-}
+export declare const viewTypeToPlaneName: { [plane in PlaneViewType]: PlaneName };
 
-export declare type planeNameToViewType = {
-  X: ViewTypes.YZ_PLANE,
-  Y: ViewTypes.XZ_PLANE,
-  Z: ViewTypes.XY_PLANE,
-}
-export declare type lineNames = ['YinX', 'ZinX', 'XinY', 'ZinY', 'XinZ', 'YinZ'];
+export declare const planeNameToViewType: { [planeName in PlaneName]: PlaneViewType };
+
+export declare const lineNames: ['YinX', 'ZinX', 'XinY', 'ZinY', 'XinZ', 'YinZ'];
 
 declare const _default: {
   ScrollingMethods: typeof ScrollingMethods;
   InteractionMethodsName: typeof InteractionMethodsName;
-  xyzToViewType: xyzToViewType;
-  viewTypeToXYZ: viewTypeToXYZ;
-  planeNames: planeNames;
-  viewTypeToPlaneName: viewTypeToPlaneName;
-  planeNameToViewType: planeNameToViewType;
-  lineNames: lineNames;
-}
+  xyzToViewType: typeof xyzToViewType;
+  viewTypeToXYZ: typeof viewTypeToXYZ;
+  planeNames: typeof planeNames;
+  viewTypeToPlaneName: typeof viewTypeToPlaneName;
+  planeNameToViewType: typeof planeNameToViewType;
+  lineNames: typeof lineNames;
+};
 
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitware/vtk.js",
-  "version": "29.4.0",
+  "version": "29.4.2",
   "description": "Visualization Toolkit for the Web",
   "keywords": [
     "3d",