@kitware/vtk.js 21.1.3 → 21.2.1

package/Filters/Sources/PlaneSource.d.ts

@@ -1,5 +1,6 @@
 import { vec3 } from 'gl-matrix';
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
+import { Vector3 } from '@kitware/vtk.js/types';
 
 /**
  * 
@@ -7,9 +8,9 @@ import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
 export interface IPlaneSourceInitialValues {
 	xResolution?: number;
 	yResolution?: number;
-	origin?: number[];
-	point1?: number[];
-	point2?: number[];
+	origin?: Vector3;
+	point1?: Vector3;
+	point2?: Vector3;
 	pointType?: string;
 }
 
@@ -27,56 +28,56 @@ export interface vtkPlaneSource extends vtkPlaneSourceBase {
 	 * Get the center of the plane.
 	 * @default [0, 0, 0]
 	 */
-	getCenter(): number[];
+	getCenter(): Vector3;
 
 	/**
 	 * Get the center of the plane.
 	 */
-	getCenterByReference(): number[];
+	getCenterByReference(): Vector3;
 
 	/**
 	 * Get the normal of the plane.
 	 * @default [0, 0, 1]
 	 */
-	getNormal(): number[];
+	getNormal(): Vector3;
 
 	/**
 	 * Get the normal of the plane.
 	 */
-	getNormalByReference(): number[];
+	getNormalByReference(): Vector3;
 
 	/**
 	 * Get the origin of the plane, lower-left corner.
 	 * @default [0, 0, 0]
 	 */
-	getOrigin(): number[];
+	getOrigin(): Vector3;
 
 	/**
 	 * Get the origin of the plane, lower-left corner.
 	 */
-	getOriginByReference(): number[];
+	getOriginByReference(): Vector3;
 
 	/**
 	 * Get the x axes of the plane.
 	 * @default [1, 0, 0]
 	 */
-	getPoint1(): number[];
+	getPoint1(): Vector3;
 
 	/**
 	 * Get the x axes of the plane.
 	 */
-	getPoint1ByReference(): number[];
+	getPoint1ByReference(): Vector3;
 
 	/**
 	 * Get the y axes of the plane.
 	 * @default [0, 1, 0]
 	 */
-	getPoint2(): number[];
+	getPoint2(): Vector3;
 
 	/**
 	 * Get the y axes of the plane.
 	 */
-	getPoint2ByReference(): number[];
+	getPoint2ByReference(): Vector3;
 
 	/**
 	 * Get the x resolution of the plane.
@@ -114,15 +115,15 @@ export interface vtkPlaneSource extends vtkPlaneSourceBase {
 
 	/**
 	 * Set the center of the plane.
-	 * @param {Number[]} center The coordinate of the center point.
+	 * @param {Vector3} center The coordinate of the center point.
 	 */
-	setCenter(center: number[]): void;
+	setCenter(center: Vector3): void;
 
 	/**
 	 * Set the normal of the plane.
-	 * @param {Number[]} normal The normal coordinate.
+	 * @param {Vector3} normal The normal coordinate.
 	 */
-	setNormal(normal: number[]): boolean;
+	setNormal(normal: Vector3): boolean;
 
 	/**
 	 * Set the normal of the plane.
@@ -134,15 +135,15 @@ export interface vtkPlaneSource extends vtkPlaneSourceBase {
 
 	/**
 	 * Set the normal of the plane.
-	 * @param {Number[]} normal The normal coordinate.
+	 * @param {Vector3} normal The normal coordinate.
 	 */
-	setNormalFrom(normal: number[]): boolean;
+	setNormalFrom(normal: Vector3): boolean;
 
 	/**
 	 * Set the origin of the plane.
-	 * @param {Number[]} origin The coordinate of the origin point.
+	 * @param {Vector3} origin The coordinate of the origin point.
 	 */
-	setOrigin(origin: number[]): boolean;
+	setOrigin(origin: Vector3): boolean;
 
 	/**
 	 * Set the origin of the plane.
@@ -154,9 +155,9 @@ export interface vtkPlaneSource extends vtkPlaneSourceBase {
 
 	/**
 	 * Set the origin of the plane.
-	 * @param {Number[]} origin The coordinate of the origin point.
+	 * @param {Vector3} origin The coordinate of the origin point.
 	 */
-	setOriginFrom(origin: number[]): boolean;
+	setOriginFrom(origin: Vector3): boolean;
 
 	/**
 	 * Specify a point defining the first axis of the plane.
@@ -168,9 +169,9 @@ export interface vtkPlaneSource extends vtkPlaneSourceBase {
 
 	/**
 	 * Specify a point defining the first axis of the plane.
-	 * @param {Number[]} point1 
+	 * @param {Vector3} point1 
 	 */
-	setPoint1(point1: number[]): boolean;
+	setPoint1(point1: Vector3): boolean;
 
 	/**
 	 * Specify a point defining the second axis of the plane.
@@ -182,9 +183,9 @@ export interface vtkPlaneSource extends vtkPlaneSourceBase {
 
 	/**
 	 * Specify a point defining the second axis of the plane.
-	 * @param {Number[]} point2 
+	 * @param {Vector3} point2 
 	 */
-	setPoint2(point2: number[]): boolean;
+	setPoint2(point2: Vector3): boolean;
 
 	/**
 	 * Set the number of facets used to represent the cone.
@@ -234,7 +235,7 @@ export function newInstance(initialValues?: IPlaneSourceInitialValues): vtkPlane
  * 
  * @example
  * ```js
- * import vtkPlaneSource from 'vtk.js/Sources/Filters/Sources/PlaneSource';
+ * import vtkPlaneSource from '@kitware/vtk.js/Filters/Sources/PlaneSource';
  * 
  * const plane = vtkPlaneSource.newInstance({ xResolution: 10, yResolution: 10 });
  * const polydata = plane.getOutputData();

package/Filters/Sources/PointSource.d.ts

@@ -1,11 +1,12 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
+import { Vector3 } from '@kitware/vtk.js/types';
 
 /**
  * 
  */
 export interface IPointSourceInitialValues {
 	numberOfPoints?: number;
-	center?: number[];
+	center?: Vector3;
 	radius?: number;
 	pointType?: string;
 }
@@ -24,12 +25,12 @@ export interface vtkPointSource extends vtkPointSourceBase {
 	 * Get the center of the plane.
 	 * @default [0, 0, 0]
 	 */
-	getCenter(): number[];
+	getCenter(): Vector3;
 
 	/**
 	 * Get the center of the plane.
 	 */
-	getCenterByReference(): number[];
+	getCenterByReference(): Vector3;
 
 	/**
 	 * Get the number of points to generate.
@@ -60,15 +61,15 @@ export interface vtkPointSource extends vtkPointSourceBase {
 
 	/**
 	 * Set the center of the point cloud.
-	 * @param {Number[]} center The center point's coordinates.
+	 * @param {Vector3} center The center point's coordinates.
 	 */
-	setCenter(center: number[]): boolean;
+	setCenter(center: Vector3): boolean;
 
 	/**
 	 * Set the center of the point cloud.
-	 * @param {Number[]} center The center point's coordinates.
+	 * @param {Vector3} center The center point's coordinates.
 	 */
-	setCenterFrom(center: number[]): boolean;
+	setCenterFrom(center: Vector3): boolean;
 
 	/**
 	 * Set the number of points to generate.
@@ -110,7 +111,7 @@ export function newInstance(initialValues?: IPointSourceInitialValues): vtkPoint
  * 
  * @example
  * ```js
- * import vtkPointSource from 'vtk.js/Sources/Filters/Sources/PointSource';
+ * import vtkPointSource from '@kitware/vtk.js/Filters/Sources/PointSource';
  * 
  * const point = vtkPointSource.newInstance({ numberOfPoints: 10 });
  * const polydata = point.getOutputData();

package/Filters/Sources/SphereSource.d.ts

@@ -1,4 +1,5 @@
 import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
+import { Vector3 } from '@kitware/vtk.js/types';
 
 /**
  * 
@@ -12,7 +13,7 @@ export interface ISphereSourceInitialValues {
 	phiResolution?: number;
 	startPhi?: number;
 	endPhi?: number;
-	center?: number[];
+	center?: Vector3;
 	pointType?: string;
 }
 
@@ -30,12 +31,12 @@ export interface vtkSphereSource extends vtkSphereSourceBase {
 	 * Get the center of the sphere.
 	 * @default [0, 0, 0]
 	 */
-	getCenter(): number[];
+	getCenter(): Vector3;
 
 	/**
 	 * Get the center of the sphere.
 	 */
-	getCenterByReference(): number[];
+	getCenterByReference(): Vector3;
 
 
 	/**
@@ -103,15 +104,15 @@ export interface vtkSphereSource extends vtkSphereSourceBase {
 
 	/**
 	 * Set the center of the sphere.
-	 * @param {Number[]} center The center point's coordinates.
+	 * @param {Vector3} center The center point's coordinates.
 	 */
-	setCenter(center: number[]): boolean;
+	setCenter(center: Vector3): boolean;
 
 	/**
 	 * Set the center of the sphere.
-	 * @param {Number[]} center The center point's coordinates.
+	 * @param {Vector3} center The center point's coordinates.
 	 */
-	setCenterFrom(center: number[]): boolean;
+	setCenterFrom(center: Vector3): boolean;
 
 	/**
 	 * Set the ending latitude angle.
@@ -192,7 +193,7 @@ export function newInstance(initialValues?: ISphereSourceInitialValues): vtkSphe
  * 
  * @example
  * ```js
- * import vtkSphereSource from 'vtk.js/Sources/Filters/Sources/SphereSource';
+ * import vtkSphereSource from '@kitware/vtk.js/Filters/Sources/SphereSource';
  * 
  * const sphere = vtkSphereSource.newInstance();
  * const polydata = sphere.getOutputData();

package/IO/Core/ImageStream/DefaultProtocol.d.ts

@@ -0,0 +1,25 @@
+import { Size, Vector3 } from '@kitware/vtk.js/types';
+
+declare function createMethods(session: any): {
+	subscribeToImageStream: (callback: any) => any;
+	unsubscribeToImageStream: (subscription: any) => any;
+	registerView: (viewId: number) => any;
+	unregisterView: (viewId: number) => any;
+	enableView: (viewId: number, enabled: boolean) => any;
+	render: (options?: {
+			size: Size;
+			view: number;
+	}) => any;
+	resetCamera: (view?: number) => any;
+	invalidateCache: (viewId: number) => any;
+	setQuality: (viewId: number, quality: number, ratio?: number) => any;
+	setSize: (viewId: number, width?: number, height?: number) => any;
+	setServerAnimationFPS: (fps?: number) => any;
+	getServerAnimationFPS: () => number;
+	startAnimation: (viewId?: number) => any;
+	stopAnimation: (viewId?: number) => any;
+	updateCamera: (viewId: number, focalPoint: Vector3, viewUp: Vector3, position: Vector3, forceUpdate?: boolean) => any;
+	updateCameraParameters: (viewId?: number, parameters?: {}, forceUpdate?: boolean) => any;
+}
+
+export default createMethods;

package/IO/Core/ImageStream/ViewStream.d.ts

@@ -0,0 +1,256 @@
+import { vtkObject } from '@kitware/vtk.js/interfaces';
+import { Size } from '@kitware/vtk.js/types';
+import vtkCamera from '@kitware/vtk.js/Rendering/Core/Camera';
+import DefaultProtocol from '@kitware/vtk.js/IO/Core/ImageStream/DefaultProtocol';
+/**
+ *
+ */
+export interface IViewStreamInitialValues {
+  protocol?: typeof DefaultProtocol;
+  api?: any;
+  cameraUpdateRate?: number;
+  decodeImage?: boolean;
+  fpsWindowSize?: number;
+  interactiveQuality?: number;
+  interactiveRatio?: number;
+  isAnimating?: boolean;
+  mimeType?: string;
+  size?: Size;
+  stillQuality?: number;
+  stillRatio?: number;
+  useCameraParameters?: boolean;
+  viewId?: string;
+}
+
+interface IMetaData {
+  size: Size,
+  id: string,
+  memory: number,
+  workTime: number,
+}
+
+interface IEvent {
+  url: string,
+  fps: number[],
+  metadata: IMetaData,
+}
+
+export interface vtkViewStream extends vtkObject {
+  /**
+   *
+   * @param callback
+   */
+  onImageReady(callback: () => void): any;
+
+  /**
+   *
+   */
+  getViewId(): string;
+
+  /**
+   *
+   */
+  getSize(): Size;
+
+  /**
+   *
+   */
+  getFps(): number[];
+
+  /**
+   *
+   */
+  getLastImageEvent(): IEvent;
+
+  /**
+   *
+   */
+  getCamera(): vtkCamera;
+
+  /**
+   *
+   * @param camera
+   */
+  setCamera(camera: vtkCamera): boolean;
+
+  /**
+   *
+   */
+  getCameraUpdateRate(): number;
+
+  /**
+   *
+   * @param cameraUpdateRate
+   */
+  setCameraUpdateRate(cameraUpdateRate: number): boolean;
+
+  /**
+   *
+   */
+  getDecodeImage(): boolean;
+
+  /**
+   *
+   * @param decodeImage
+   */
+  setDecodeImage(decodeImage: boolean): boolean;
+
+  /**
+   *
+   */
+  getFpsWindowSize(): number;
+
+  /**
+   *
+   * @param fpsWindowSize
+   */
+  setFpsWindowSize(fpsWindowSize: number): boolean;
+
+  /**
+   *
+   */
+  getInteractiveQuality(): number;
+
+  /**
+   *
+   * @param interactiveQuality
+   */
+  setInteractiveQuality(interactiveQuality: number): boolean;
+
+  /**
+   *
+   */
+  getInteractiveRatio(): number;
+
+  /**
+   *
+   * @param interactiveRatio
+   */
+  setInteractiveRatio(interactiveRatio: number): boolean;
+
+  /**
+   *
+   */
+  getStillQuality(): number;
+
+  /**
+   *
+   * @param stillQuality
+   */
+  setStillQuality(stillQuality: number): boolean;
+
+  /**
+   *
+   */
+  getStillRatio(): number;
+
+  /**
+   *
+   * @param stillRatio
+   */
+  setStillRatio(stillRatio: number): boolean;
+
+  /**
+   *
+   */
+  getUseCameraParameters(): boolean;
+
+  /**
+   *
+   * @param useCameraParameters
+   */
+  setUseCameraParameters(useCameraParameters: boolean): boolean;
+
+  /**
+   *
+   */
+  pushCamera(): any;
+
+  /**
+   *
+   */
+  invalidateCache(): any;
+
+  /**
+   *
+   */
+  render(): any;
+
+  /**
+   *
+   */
+  resetCamera(): any;
+
+  /**
+   *
+   */
+  startAnimation(): any;
+
+  /**
+   *
+   */
+  stopAnimation(): any;
+
+  /**
+   *
+   * @param width
+   * @param height
+   */
+  setSize(width: number, height: number): any;
+
+  /**
+   *
+   */
+  startInteraction(): any;
+
+  /**
+   *
+   */
+  endInteraction(): any;
+
+  /**
+   *
+   * @param viewId
+   */
+  setViewId(viewId: string): boolean;
+
+  /**
+   *
+   * @param msg
+   */
+  processMessage(msg: any): void;
+
+  /**
+   *
+   */
+  delete(): void;
+}
+
+/**
+ * Method used to decorate a given object (publicAPI+model) with vtkViewStream characteristics.
+ * @param publicAPI
+ * @param model
+ * @param initialValues
+ */
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IViewStreamInitialValues
+): void;
+
+/**
+ * Method used to create a new instance of vtkViewStream
+ * @param {IViewStreamInitialValues} [initialValues] for pre-setting some of its content
+ */
+export function newInstance(
+  initialValues?: IViewStreamInitialValues
+): vtkViewStream;
+
+/**
+ * IViewStreamInitialValues provides a way to create a remote view.
+ */
+export declare const vtkViewStream: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+export default vtkViewStream;

package/IO/Core/WSLinkClient.d.ts

@@ -15,7 +15,6 @@ import { vtkObject, vtkSubscription } from '@kitware/vtk.js/interfaces';
  */
 export function setSmartConnectClass(smartConnectClass: object): void;
 
-
 export interface vtkWSLinkClient extends vtkObject {
 
   /**
@@ -117,21 +116,45 @@ export interface vtkWSLinkClient extends vtkObject {
    */
   getConfigDecorator(): (config: object) => object;
 
-  getConnection(): object;
-  getCongig(): object;
+  /**
+   *
+   */
+  getConnection(): any;
+
+  /**
+   *
+   */
+  getConfig(): object;
+
+  /**
+   *
+   */
   getRemote(): object;
+
+  /**
+   *
+   */
   getImageStream(): object;
 
+  /**
+   *
+   * @param callback
+   * @param priority
+   */
   onBusyChange(callback: Function, priority: number): vtkSubscription;
+
+  /**
+   *
+   */
   invokeBusyChange(): void;
 
-  onConnectionReady(callback: () => void): vtkSubscription;
+  onConnectionReady(callback: (httpReq: any) => void): vtkSubscription;
   // invokeConnectionReady(): void
 
-  onConnectionError(callback: () => void): vtkSubscription;
+  onConnectionError(callback: (httpReq: any) => void): vtkSubscription;
   // invokeConnectionError(): void
 
-  onConnectionClose(callback: () => void): vtkSubscription;
+  onConnectionClose(callback: (httpReq: any) => void): vtkSubscription;
   // invokeConnectionClose(): void
 }
 

package/Interaction/Manipulators/MouseBoxSelectorManipulator.js

@@ -56,7 +56,9 @@ function vtkMouseBoxSelectionManipulator(publicAPI, model) {
 
     var _container$getBoundin = container.getBoundingClientRect(),
         width = _container$getBoundin.width,
-        height = _container$getBoundin.height;
+        height = _container$getBoundin.height,
+        top = _container$getBoundin.top,
+        left = _container$getBoundin.left;
 
     var _getBounds = getBounds(),
         _getBounds2 = _slicedToArray(_getBounds, 4),
@@ -65,8 +67,10 @@ function vtkMouseBoxSelectionManipulator(publicAPI, model) {
         yMin = _getBounds2[2],
         yMax = _getBounds2[3];
 
-    div.style.left = "".concat(width * xMin / viewWidth, "px");
-    div.style.top = "".concat(height - height * yMax / viewHeight, "px");
+    var xShift = left + window.scrollX;
+    var yShift = top + window.scrollY;
+    div.style.left = "".concat(xShift + width * xMin / viewWidth, "px");
+    div.style.top = "".concat(yShift + height - height * yMax / viewHeight, "px");
     div.style.width = "".concat(width * (xMax - xMin) / viewWidth, "px");
     div.style.height = "".concat(height * (yMax - yMin) / viewHeight, "px");
   } //-------------------------------------------------------------------------

package/Rendering/Core/AbstractMapper.js

@@ -14,6 +14,7 @@ function vtkAbstractMapper(publicAPI, model) {
     }
 
     model.clippingPlanes.push(plane);
+    publicAPI.modified();
   };
 
   publicAPI.getNumberOfClippingPlanes = function () {