@kitware/vtk.js 21.1.1 → 21.1.5

package/BREAKING_CHANGES.md

@@ -8,6 +8,10 @@ In ShapeWidget:
 
 RectangleWidget and EllipseWidget handles now scale up automatically.
 
+## From 19.2 to 19.3
+
+Node >=12 is required
+
 ## From 18.x to 19
 
 vtkWidgetRepresentation.updateActorVisibility(...) lost the widgetVisibility parameter.

package/Filters/General/TubeFilter.js

@@ -698,11 +698,6 @@ function vtkTubeFilter(publicAPI, model) {
       numberOfComponents: 3
     });
     var numNormals = 3 * numNewPts;
-
-    if (model.capping) {
-      numNormals = 3 * (numNewPts + 2 * model.numberOfSides);
-    }
-
     var newNormalsData = new Float32Array(numNormals);
     var newNormals = vtkDataArray.newInstance({
       numberOfComponents: 3,

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/Interaction/Manipulators/VRButtonPanManipulator.js

@@ -30,7 +30,7 @@ function vtkVRButtonPanManipulator(publicAPI, model) {
 
     var speed = data.gamepad.axes[1]; // 0.05 meters / frame movement
 
-    var pscale = speed * 0.05 / camera.getPhysicalScale(); // convert orientation to world coordinate direction
+    var pscale = speed * 0.05 * camera.getPhysicalScale(); // convert orientation to world coordinate direction
 
     var dir = camera.physicalOrientationToWorldDirection(data.orientation);
     camera.setPhysicalTranslation(oldTrans[0] + dir[0] * pscale, oldTrans[1] + dir[1] * pscale, oldTrans[2] + dir[2] * pscale);

package/Interaction/Style/InteractorStyleTrackballCamera.js

@@ -79,7 +79,7 @@ function vtkInteractorStyleTrackballCamera(publicAPI, model) {
 
     var speed = ed.gamepad.axes[1]; // 0.05 meters / frame movement
 
-    var pscale = speed * 0.05 / camera.getPhysicalScale(); // convert orientation to world coordinate direction
+    var pscale = speed * 0.05 * camera.getPhysicalScale(); // convert orientation to world coordinate direction
 
     var dir = camera.physicalOrientationToWorldDirection(ed.orientation);
     camera.setPhysicalTranslation(oldTrans[0] + dir[0] * pscale, oldTrans[1] + dir[1] * pscale, oldTrans[2] + dir[2] * pscale);

package/Rendering/Misc/RemoteView.d.ts

@@ -0,0 +1,199 @@
+import { vtkObject } from '@kitware/vtk.js/interfaces';
+import vtkCanvasView from '@kitware/vtk.js/Rendering/Misc/CanvasView';
+import vtkViewStream from '@kitware/vtk.js/IO/Core/ImageStream/ViewStream';
+
+interface IRemoteViewInitialValues {
+  viewId?: string;
+  interactiveQuality?: number;
+  interactiveRatio?: number;
+  stillQuality?: number;
+  stillRatio?: number;
+  rpcMouseEvent?: string;
+  rpcGestureEvent?: any;
+  rpcWheelEvent?: any;
+}
+
+export interface vtkRemoteView extends vtkObject {
+  /**
+   * Get container element
+   */
+  getContainer(): HTMLElement;
+
+  /**
+   *
+   */
+  getViewStream(): vtkViewStream;
+
+  /**
+   *
+   */
+  getCanvasView(): vtkCanvasView;
+
+  /**
+   *
+   */
+  getInteractor(): any;
+
+  /**
+   *
+   */
+  getInteractorStyle(): any;
+
+  /**
+   *
+   */
+  getInteractiveQuality(): number;
+
+  /**
+   *
+   */
+  getInteractiveRatio(): number;
+
+  /**
+   *
+   */
+  getStillQuality(): number;
+
+  /**
+   *
+   */
+  getStillRatio(): number;
+
+  /**
+   *
+   */
+  getSession(): any;
+
+  /**
+   *
+   * @param session
+   */
+  setSession(session: any): boolean;
+
+  /**
+   *
+   */
+  getRpcMouseEvent(): string;
+
+  /**
+   *
+   * @param rpcMouseEvent
+   */
+  setRpcMouseEvent(rpcMouseEvent: string): boolean;
+
+  /**
+   *
+   */
+  getRpcGestureEvent(): any;
+
+  /**
+   *
+   * @param rpcGestureEvent
+   */
+  setRpcGestureEvent(rpcGestureEvent: any): boolean;
+
+  /**
+   *
+   */
+  getRpcWheelEvent(): any;
+
+  /**
+   *
+   * @param rpcWheelEvent
+   */
+  setRpcWheelEvent(rpcWheelEvent: any): boolean;
+
+  /**
+   * Release GL context
+   */
+  delete(): void;
+
+  /**
+   *
+   * @param viewStream
+   */
+  setViewStream(viewStream: vtkViewStream): boolean;
+
+  /**
+   *
+   * @param viewId
+   */
+  setViewId(viewId: string): void;
+
+  /**
+   *
+   * @param {HTMLElement} container The container HTML element.
+   */
+  setContainer(container: HTMLElement): boolean;
+
+  /**
+   * Handle window resize
+   */
+  resize(): void;
+
+  /**
+   *
+   */
+  render(): void;
+
+  /**
+   *
+   */
+  resetCamera(): void;
+
+  /**
+   *
+   * @param interactiveQuality
+   */
+  setInteractiveQuality(interactiveQuality: number): boolean;
+
+  /**
+   *
+   * @param interactiveRatio
+   */
+  setInteractiveRatio(interactiveRatio: number): boolean;
+
+  /**
+   *
+   * @param stillQuality
+   */
+  setStillQuality(stillQuality: number): boolean;
+
+  /**
+   *
+   * @param stillRatio
+   */
+  setStillRatio(stillRatio: number): boolean;
+}
+
+/**
+ * Method used to decorate a given object (publicAPI+model) with vtkRemoteView characteristics.
+ *
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param {IRemoteViewInitialValues} [initialValues] (default: {})
+ */
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IRemoteViewInitialValues
+): void;
+
+/**
+ * Method used to create a new instance of vtkCanvasView
+ * @param {IRemoteViewInitialValues} [initialValues] for pre-setting some of its content
+ */
+export function newInstance(
+  initialValues?: IRemoteViewInitialValues
+): vtkRemoteView;
+
+export function connectImageStream(session: any): any;
+/**
+ * vtkRemoteView provides a way to create a remote view.
+ */
+export declare const vtkRemoteView: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+  connectImageStream: typeof connectImageStream;
+};
+export default vtkRemoteView;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitware/vtk.js",
-  "version": "21.1.1",
+  "version": "21.1.5",
   "description": "Visualization Toolkit for the Web",
   "keywords": [
     "3d",
@@ -131,7 +131,7 @@
     "xml2js": "0.4.23"
   },
   "peerDependencies": {
-    "wslink": "1.0.7"
+    "wslink": "^1.1.0"
   },
   "scripts": {
     "validate": "prettier --config ./prettier.config.js --list-different \"Sources/**/*.js\" \"Examples/**/*.js\"",