@kitware/vtk.js 22.1.5 → 22.2.0

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

@@ -3,23 +3,23 @@ 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;
+	registerView: (viewId: string) => any;
+	unregisterView: (viewId: string) => any;
+	enableView: (viewId: string, 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;
+	invalidateCache: (viewId: string) => any;
+	setQuality: (viewId: string, quality: number, ratio?: number) => any;
+	setSize: (viewId: string, 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;
+	updateCamera: (viewId: string, focalPoint: Vector3, viewUp: Vector3, position: Vector3, forceUpdate?: boolean) => any;
 	updateCameraParameters: (viewId?: number, parameters?: {}, forceUpdate?: boolean) => any;
 }
 
-export default createMethods;
+export default createMethods;

package/IO/Core/ImageStream.d.ts

@@ -1,6 +1,6 @@
 import { vtkObject } from '@kitware/vtk.js/interfaces';
 import { Size } from '@kitware/vtk.js/types';
-
+import vtkViewStream from '@kitware/vtk.js/IO/Core/ImageStream/ViewStream';
 
 /**
  *
@@ -10,54 +10,56 @@ export interface IImageStreamInitialValues {
 	serverAnimationFPS?: number,
 }
 
+// Return type of wslink/src/WebsocketConnection, getSession() method.
+type WebsocketSession = any;
 
 export interface vtkImageStream extends vtkObject {
 
 	/**
-	 * 
+	 *
 	 */
-	connect(): void;
+	connect(session: WebsocketSession): void;
 
 	/**
-	 * 
-	 * @param {Number} [viewId] The ID of the view.
-	 * @param {Size} [size] The size of the view. 
+	 *
+	 * @param {String} [viewId] The ID of the view.
+	 * @param {Size} [size] The size of the view.
 	 */
-	createViewStream(viewId?: number, size?: Size): any;
+	createViewStream(viewId?: string, size?: Size): vtkViewStream;
 
 	/**
-	 * 
+	 *
 	 */
 	delete(): void;
 
 	/**
-	 * 
+	 *
 	 */
 	disconnect(): void;
 
 	/**
-	 * 
+	 *
 	 */
 	getProtocol(): any;
 
 	/**
-	 * 
+	 *
 	 */
 	getServerAnimationFPS(): number;
 
 	/**
-	 * 
+	 *
 	 */
 	registerViewStream(): void;
 
 	/**
-	 * 
-	 * @param serverAnimationFPS 
+	 *
+	 * @param serverAnimationFPS
 	 */
 	setServerAnimationFPS(serverAnimationFPS: number): boolean;
 
 	/**
-	 * 
+	 *
 	 */
 	unregisterViewStream(): void;
 }

package/Interaction/Manipulators/MouseBoxSelectorManipulator.js

@@ -56,9 +56,7 @@ function vtkMouseBoxSelectionManipulator(publicAPI, model) {
 
     var _container$getBoundin = container.getBoundingClientRect(),
         width = _container$getBoundin.width,
-        height = _container$getBoundin.height,
-        top = _container$getBoundin.top,
-        left = _container$getBoundin.left;
+        height = _container$getBoundin.height;
 
     var _getBounds = getBounds(),
         _getBounds2 = _slicedToArray(_getBounds, 4),
@@ -67,10 +65,8 @@ function vtkMouseBoxSelectionManipulator(publicAPI, model) {
         yMin = _getBounds2[2],
         yMax = _getBounds2[3];
 
-    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.left = "".concat(width * xMin / viewWidth, "px");
+    div.style.top = "".concat(height - height * yMax / viewHeight, "px");
     div.style.width = "".concat(width * (xMax - xMin) / viewWidth, "px");
     div.style.height = "".concat(height * (yMax - yMin) / viewHeight, "px");
   } //-------------------------------------------------------------------------
@@ -80,15 +76,21 @@ function vtkMouseBoxSelectionManipulator(publicAPI, model) {
     previousPosition = position;
 
     if (model.renderSelection) {
+      var _view;
+
       // Need window size and location to convert to style
       if (!view) {
         view = interactor.getView();
       }
 
-      if (!container && view) {
+      if (!container && (_view = view) !== null && _view !== void 0 && _view.getContainer) {
         container = view.getContainer();
       }
 
+      if (!container) {
+        container = model.container;
+      }
+
       if (!div) {
         div = document.createElement('div');
         applyStyle(div, model.selectionStyle);
@@ -155,6 +157,7 @@ function vtkMouseBoxSelectionManipulator(publicAPI, model) {
 
 function DEFAULT_VALUES(initialValues) {
   return _objectSpread(_objectSpread({
+    // container: null,
     renderSelection: true
   }, initialValues), {}, {
     selectionStyle: _objectSpread(_objectSpread({}, DEFAULT_STYLE), initialValues.selectionStyle)
@@ -172,7 +175,7 @@ function extend(publicAPI, model) {
 
   event(publicAPI, model, 'BoxSelectInput'); // Trigger while dragging
 
-  setGet(publicAPI, model, ['renderSelection', 'selectionStyle']); // Object specific methods
+  setGet(publicAPI, model, ['renderSelection', 'selectionStyle', 'container']); // Object specific methods
 
   vtkMouseBoxSelectionManipulator(publicAPI, model);
 } // ----------------------------------------------------------------------------

package/Rendering/Core/RenderWindowInteractor.js

@@ -328,8 +328,6 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     if (animationRequesters.size === 1 && !model.xrAnimation) {
       model._animationStartTime = Date.now();
       model._animationFrameCount = 0;
-      model.lastFrameTime = 0.1;
-      model.lastFrameStart = Date.now();
       model.animationRequest = requestAnimationFrame(publicAPI.handleAnimation);
       publicAPI.startAnimationEvent();
     }
@@ -375,7 +373,7 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     model.xrAnimation = false;
 
     if (animationRequesters.size !== 0) {
-      model.FrameTime = -1;
+      model.recentAnimationFrameRate = 10.0;
       model.animationRequest = requestAnimationFrame(publicAPI.handleAnimation);
     }
   };
@@ -456,19 +454,12 @@ function vtkRenderWindowInteractor(publicAPI, model) {
 
     if (currTime - model._animationStartTime > 1000.0 && model._animationFrameCount > 1) {
       model.recentAnimationFrameRate = 1000.0 * (model._animationFrameCount - 1) / (currTime - model._animationStartTime);
+      model.lastFrameTime = 1.0 / model.recentAnimationFrameRate;
       publicAPI.animationFrameRateUpdateEvent();
       model._animationStartTime = currTime;
       model._animationFrameCount = 1;
     }
 
-    if (model.FrameTime === -1.0) {
-      model.lastFrameTime = 0.1;
-    } else {
-      model.lastFrameTime = (currTime - model.lastFrameStart) / 1000.0;
-    }
-
-    model.lastFrameTime = Math.max(0.01, model.lastFrameTime);
-    model.lastFrameStart = currTime;
     publicAPI.animationEvent();
     forceRender();
     model.animationRequest = requestAnimationFrame(publicAPI.handleAnimation);
@@ -933,7 +924,6 @@ function vtkRenderWindowInteractor(publicAPI, model) {
   };
 
   publicAPI.handleVisibilityChange = function () {
-    model.lastFrameStart = Date.now();
     model._animationStartTime = Date.now();
     model._animationFrameCount = 0;
   };
@@ -957,7 +947,7 @@ function vtkRenderWindowInteractor(publicAPI, model) {
 
     superDelete();
   }; // Use the Page Visibility API to detect when we switch away from or back to
-  // this tab, and reset the lastFrameStart. When tabs are not active, browsers
+  // this tab, and reset the animationFrameStart. When tabs are not active, browsers
   // will stop calling requestAnimationFrame callbacks.
 
 

package/Rendering/Core/ScalarBarActor.d.ts

@@ -38,7 +38,10 @@ export interface IScalarBarActorInitialValues extends IActorInitialValues {
 	axisTitlePixelOffset?: number,
 	axisTextStyle?: IStyle,
 	tickLabelPixelOffset?: number,
-	tickTextStyle?: IStyle
+	tickTextStyle?: IStyle,
+	drawNanAnnotation?: boolean,
+	drawBelowRangeSwatch?: boolean,
+	drawAboveRangeSwatch?: boolean,
 }
 
 export interface vtkScalarBarActor extends vtkActor {
@@ -135,6 +138,21 @@ export interface vtkScalarBarActor extends vtkActor {
 	 */
 	getScalarsToColors(): vtkScalarsToColors;
 
+	/**
+	 *
+	 */
+	getDrawNanAnnotation(): boolean
+
+	/**
+	 *
+	 */
+	getDrawBelowRangeSwatch(): boolean
+
+	/**
+	 *
+	 */
+	getDrawAboveRangeSwatch(): boolean
+
 	/**
 	 * 
 	 */
@@ -212,8 +230,26 @@ export interface vtkScalarBarActor extends vtkActor {
 	setScalarsToColors(scalarsToColors: vtkScalarsToColors): boolean;
 
 	/**
-	 * 
-	 * @param tickLabelPixelOffset 
+	 * Set whether the NaN annotation should be rendered or not.
+	 * @param {Boolean} drawNanAnnotation
+	 */
+	 setDrawNanAnnotation(drawNanAnnotation: boolean): boolean;
+
+	/**
+	 * Set whether the Below range swatch should be rendered or not
+	 * @param {Boolean} drawBelowRangeSwatch
+	 */
+	setDrawBelowRangeSwatch(drawBelowRangeSwatch: boolean): boolean;
+
+	/**
+	 * Set whether the Above range swatch should be rendered or not
+	 * @param {Boolean} drawAboveRangeSwatch
+	 */
+	setDrawAboveRangeSwatch(drawAboveRangeSwatch: boolean): boolean;
+
+	/**
+	 *
+	 * @param tickLabelPixelOffset
 	 */
 	setTickLabelPixelOffset(tickLabelPixelOffset: number): boolean;
 

package/Rendering/Core/ScalarBarActor.js

@@ -319,6 +319,8 @@ function vtkScalarBarActor(publicAPI, model) {
 
 
   publicAPI.recomputeBarSegments = function (textSizes) {
+    var _model$scalarsToColor, _model$scalarsToColor2, _model$scalarsToColor3, _model$scalarsToColor4;
+
     // first compute the barSize/Position
     var segSize = publicAPI.computeBarSize(textSizes);
     model.barSegments = [];
@@ -337,22 +339,22 @@ function vtkScalarBarActor(publicAPI, model) {
       startPos[barAxis] += segSize[barAxis] + segSpace;
     }
 
-    if (typeof model.scalarsToColors.getNanColor === 'function') {
+    if (model.drawNanAnnotation && model.scalarsToColors.getNanColor) {
       pushSeg('NaN', [NaN, NaN, NaN, NaN]);
     }
 
-    if (typeof model.scalarsToColors.getUseBelowRangeColor === 'function' && model.scalarsToColors.getUseBelowRangeColor()) {
+    if (model.drawBelowRangeSwatch && (_model$scalarsToColor = (_model$scalarsToColor2 = model.scalarsToColors).getUseBelowRangeColor) !== null && _model$scalarsToColor !== void 0 && _model$scalarsToColor.call(_model$scalarsToColor2)) {
       pushSeg('Below', [-0.1, -0.1, -0.1, -0.1]);
     }
 
-    var haveAbove = typeof model.scalarsToColors.getUseAboveRangeColor === 'function' && model.scalarsToColors.getUseAboveRangeColor(); // extra space around the ticks section
+    var haveAbove = (_model$scalarsToColor3 = (_model$scalarsToColor4 = model.scalarsToColors).getUseAboveRangeColor) === null || _model$scalarsToColor3 === void 0 ? void 0 : _model$scalarsToColor3.call(_model$scalarsToColor4); // extra space around the ticks section
 
     startPos[barAxis] += segSpace;
     var oldSegSize = segSize[barAxis];
     segSize[barAxis] = haveAbove ? 1.0 - 2.0 * segSpace - segSize[barAxis] - startPos[barAxis] : 1.0 - segSpace - startPos[barAxis];
     pushSeg('ticks', model.vertical ? [0, 0, 0.995, 0.995] : [0, 0.995, 0.995, 0]);
 
-    if (haveAbove) {
+    if (model.drawAboveRangeSwatch && haveAbove) {
       segSize[barAxis] = oldSegSize;
       startPos[barAxis] += segSpace;
       pushSeg('Above', [1.1, 1.1, 1.1, 1.1]);
@@ -551,11 +553,26 @@ function vtkScalarBarActor(publicAPI, model) {
   };
 
   publicAPI.updatePolyDataForBarSegments = function () {
+    var _model$scalarsToColor5, _model$scalarsToColor6, _model$scalarsToColor7, _model$scalarsToColor8;
+
     var cmat = model.camera.getCompositeProjectionMatrix(model.lastAspectRatio, -1, 1);
     mat4.transpose(cmat, cmat);
     mat4.invert(invmat, cmat);
-    var haveExtraColors = typeof model.scalarsToColors.getNanColor === 'function' && typeof model.scalarsToColors.getAboveRangeColor === 'function' && typeof model.scalarsToColors.getBelowRangeColor === 'function';
-    var numPts = 4 + (haveExtraColors ? 12 : 0);
+    var numberOfExtraColors = 0;
+
+    if (model.drawNanAnnotation && model.scalarsToColors.getNanColor) {
+      numberOfExtraColors += 1;
+    }
+
+    if (model.drawBelowRangeSwatch && (_model$scalarsToColor5 = (_model$scalarsToColor6 = model.scalarsToColors).getUseBelowRangeColor) !== null && _model$scalarsToColor5 !== void 0 && _model$scalarsToColor5.call(_model$scalarsToColor6)) {
+      numberOfExtraColors += 1;
+    }
+
+    if (model.drawAboveRangeSwatch && (_model$scalarsToColor7 = (_model$scalarsToColor8 = model.scalarsToColors).getUseAboveRangeColor) !== null && _model$scalarsToColor7 !== void 0 && _model$scalarsToColor7.call(_model$scalarsToColor8)) {
+      numberOfExtraColors += 1;
+    }
+
+    var numPts = 4 * (1 + numberOfExtraColors);
     var numQuads = numPts; // handle vector component mode
 
     var numComps = 1;
@@ -667,7 +684,10 @@ function defaultValues(initialValues) {
       fontStyle: 'normal',
       fontSize: 14,
       fontFamily: 'serif'
-    }
+    },
+    drawNanAnnotation: true,
+    drawBelowRangeSwatch: true,
+    drawAboveRangeSwatch: true
   }, initialValues);
 } // ----------------------------------------------------------------------------
 
@@ -738,7 +758,7 @@ function extend(publicAPI, model) {
 
     publicAPI.update();
   });
-  macro.setGet(publicAPI, model, ['automated', 'autoLayout', 'axisTitlePixelOffset', 'axisLabel', 'scalarsToColors', 'tickLabelPixelOffset']);
+  macro.setGet(publicAPI, model, ['automated', 'autoLayout', 'axisTitlePixelOffset', 'axisLabel', 'scalarsToColors', 'tickLabelPixelOffset', 'drawNanAnnotation', 'drawBelowRangeSwatch', 'drawAboveRangeSwatch']);
   macro.get(publicAPI, model, ['axisTextStyle', 'tickTextStyle']);
   macro.getArray(publicAPI, model, ['boxPosition', 'boxSize']);
   macro.setArray(publicAPI, model, ['boxPosition', 'boxSize'], 2); // Object methods

package/Rendering/Misc/SynchronizableRenderWindow.d.ts

@@ -0,0 +1,73 @@
+import { vtkRenderWindow, IRenderWindowInitialValues } from '@kitware/vtk.js/Rendering/Rendering/Core/RenderWindow';
+
+// Keeps state for client / server scene synchronization.
+export interface SynchContext {
+    // Set a function that fetches the data array for the given object.
+    setFetchArrayFunction(fetcher: (hash: string, dataType: any) => Promise<ArrayBuffer>): void;
+    // Invokes the fetcher registered by setFetchArrayFunction.
+    getArray(sha: string, dataType: any, context: SynchContext): Promise<ArrayBuffer>;
+    emptyCachedArrays(): void;
+    freeOldArrays(threshold: number, context: SynchContext): void;
+
+    // instanceMap
+    getInstance(id: any): any;
+    getInstanceId(instance: any): any | null;
+    registerInstance(id: any, instance: any): void;
+    unregister(id: any): void;
+    emptyCachedInstances(): void;
+
+    // sceneMtimeHandler
+    getMtime(): number;
+    incrementMtime(viewId: string): number;
+    setActiveViewId(viewId: string): void;
+    getActiveViewId(): string;
+
+    // TODO: fill progresshandler
+}
+
+export interface IInitialValues extends IRenderWindowInitialValues {
+  synchronizerContextName?: string; // default: 'default':
+  synchronizerContext?: SynchContext | null;
+  synchronizedViewId?: string | null;
+}
+
+// Server-side view state.
+export interface ViewState {
+  id: ViewId;
+  // vtk object type.
+  type: string;
+  // vtk object mtime.
+  mtime: number;
+  // ID of the parent. Null for the root.
+  parent?: string | null;
+  properties?: {[key: string]: any};
+  // Child objects.
+  dependencies?: ViewState[];
+  extra?: any;
+  // List of [methodName, args] to be invoked on the object.
+  calls?: [string, string[]][];
+  // ViewState may contain other arbitrary key / value pairs.
+  [key: string]: any;
+}
+
+export interface vtkSynchronizableRenderWindowInstance extends vtkRenderWindow {
+  getSynchronizerContext(): SynchContext;
+
+  // methods added by createSyncFunction
+  synchronize(state: ViewState): Promise<boolean>;
+  setSynchronizedViewId(viewId: string): void;
+  getSynchronizedViewId(): string;
+  updateGarbageCollectorThreshold(v: number): void;
+  getManagedInstanceIds(): Array<string>;
+  clearOneTimeUpdaters(): void;
+}
+
+export function newInstance(props: IInitialValues): vtkSynchronizableRenderWindowInstance;
+export function getSynchronizerContext(name?: string): SynchContext;
+
+export const vtkSynchronizableRenderWindow: {
+  newInstance: typeof newInstance;
+  getSynchronizerContext: typeof getSynchronizerContext;
+};
+
+export default vtkSynchronizableRenderWindow;

package/Rendering/OpenGL/RenderWindow.d.ts

@@ -3,6 +3,7 @@ import { Size, Vector2, Vector3 } from '@kitware/vtk.js/types';
 import { vtkRenderer } from '@kitware/vtk.js/Rendering/Core/Renderer';
 import { VtkDataTypes } from '@kitware/vtk.js/Common/Core/DataArray';
 import vtkTexture from '@kitware/vtk.js/Rendering/Core/Texture';
+import vtkViewStream from '@kitware/vtk.js/IO/Core/ImageStream/ViewStream';
 
 /**
  *
@@ -18,7 +19,7 @@ export interface IOptions {
 	resetCamera: boolean,
 	size: Size,
 	scale: number
-} 
+}
 
 type vtkOpenGLRenderWindowBase = vtkObject & Omit<vtkAlgorithm,
 	| 'getInputData'
@@ -32,7 +33,7 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 
 	/**
 	 * Builds myself.
-	 * @param {Boolean} prepass 
+	 * @param {Boolean} prepass
 	 */
 	buildPass(prepass: boolean): void;
 
@@ -45,12 +46,12 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 	initialize(): void;
 
 	/**
-	 * 
+	 *
 	 */
 	makeCurrent(): void;
 
 	/**
-	 * 
+	 *
 	 * @param {HTMLElement} el The container element.
 	 */
 	setContainer(el: HTMLElement): void;
@@ -91,170 +92,170 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 	getViewportCenter(viewport: vtkRenderer): Vector2;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
 	 */
 	displayToNormalizedDisplay(x: number, y: number, z: number): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
 	 */
 	normalizedDisplayToDisplay(x: number, y: number, z: number): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
-	 * @param {vtkRenderer} renderer 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
+	 * @param {vtkRenderer} renderer
 	 */
 	worldToView(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
-	 * @param {vtkRenderer} renderer 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
+	 * @param {vtkRenderer} renderer
 	 */
 	viewToWorld(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
-	 * @param {vtkRenderer} renderer 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
+	 * @param {vtkRenderer} renderer
 	 */
 	worldToDisplay(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
-	 * @param {vtkRenderer} renderer 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
+	 * @param {vtkRenderer} renderer
 	 */
 	displayToWorld(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
-	 * @param {vtkRenderer} renderer 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
+	 * @param {vtkRenderer} renderer
 	 */
 	normalizedDisplayToViewport(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
-	 * @param {vtkRenderer} renderer 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
+	 * @param {vtkRenderer} renderer
 	 */
 	viewportToNormalizedViewport(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
 	 */
 	normalizedViewportToViewport(x: number, y: number, z: number): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
 	 */
 	displayToLocalDisplay(x: number, y: number, z: number): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
-	 * @param {Number} z 
-	 * @param {vtkRenderer} renderer 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
+	 * @param {Number} z
+	 * @param {vtkRenderer} renderer
 	 */
 	viewportToNormalizedDisplay(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
 
 	/**
-	 * 
-	 * @param {Number} x1 
-	 * @param {Number} y1 
-	 * @param {Number} x2 
-	 * @param {Number} y2 
+	 *
+	 * @param {Number} x1
+	 * @param {Number} y1
+	 * @param {Number} x2
+	 * @param {Number} y2
 	 */
 	getPixelData(x1: number, y1: number, x2: number, y2: number): Uint8Array;
 
 	/**
-	 * 
-	 * @param options 
+	 *
+	 * @param options
 	 */
 	get3DContext(options: object): WebGLRenderingContext | null;
 
 	/**
-	 * 
+	 *
 	 */
 	startVR(): void;
 
 	/**
-	 * 
+	 *
 	 */
 	stopVR(): void;
 
 	/**
-	 * 
+	 *
 	 */
 	vrRender(): void;
 
 	/**
-	 * 
+	 *
 	 */
 	restoreContext(): void;
 
 	/**
-	 * 
-	 * @param {vtkTexture} texture 
+	 *
+	 * @param {vtkTexture} texture
 	 */
 	activateTexture(texture: vtkTexture): void;
 
 	/**
-	 * 
-	 * @param {vtkTexture} texture 
+	 *
+	 * @param {vtkTexture} texture
 	 */
 	deactivateTexture(texture: vtkTexture): void;
 
 	/**
-	 * 
-	 * @param {vtkTexture} texture 
+	 *
+	 * @param {vtkTexture} texture
 	 */
 	getTextureUnitForTexture(texture: vtkTexture): number;
 
 	/**
-	 * 
-	 * @param vtktype 
-	 * @param numComps 
-	 * @param useFloat 
+	 *
+	 * @param vtktype
+	 * @param numComps
+	 * @param useFloat
 	 */
 	getDefaultTextureInternalFormat(vtktype: VtkDataTypes, numComps: number, useFloat: boolean): void;
 
 	/**
-	 * 
-	 * @param {HTMLImageElement} img 
+	 *
+	 * @param {HTMLImageElement} img
 	 */
 	setBackgroundImage(img: HTMLImageElement): void;
 
 	/**
-	 * 
-	 * @param {Boolean} value 
+	 *
+	 * @param {Boolean} value
 	 */
 	setUseBackgroundImage(value: boolean): void;
 
@@ -269,70 +270,70 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 	 * size.  If no `size` or `scale` are provided, the current renderwindow
 	 * size is assumed.  The default format is "image/png". Returns a promise
 	 * that resolves to the captured screenshot.
-	 * @param {String} format 
-	 * @param {IOptions} options 
+	 * @param {String} format
+	 * @param {IOptions} options
 	 */
 	captureNextImage(format: string, options: IOptions): Promise<string> | null;
 
 	/**
-	 * 
+	 *
 	 */
 	getGLInformations(): object;
 
 	/**
-	 * 
+	 *
 	 */
 	traverseAllPasses(): void;
 
 	/**
-	 * 
+	 *
 	 */
 	disableCullFace(): void;
 
 	/**
-	 * 
+	 *
 	 */
 	enableCullFace(): void;
 
 	/**
-	 * 
-	 * @param stream 
+	 *
+	 * @param stream
 	 */
-	setViewStream(stream: any): boolean;
+	setViewStream(stream: vtkViewStream): boolean;
 
 	/**
-	 * 
-	 * @param {Vector2} size 
+	 *
+	 * @param {Vector2} size
 	 */
 	setSize(size: Vector2): void;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y 
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
 	 */
 	setSize(x: number, y: number): void;
 
 	/**
-	 * 
+	 *
 	 */
 	getSize(): Vector2;
 
 	/**
-	 * 
-	 * @param {Vector2} size 
+	 *
+	 * @param {Vector2} size
 	 */
 	setVrResolution(size: Vector2): void;
 
 	/**
-	 * 
-	 * @param {Number} x 
-	 * @param {Number} y  
+	 *
+	 * @param {Number} x
+	 * @param {Number} y
 	 */
 	setVrResolution(x: number, y: number): void;
 
 	/**
-	 * 
+	 *
 	 */
 	getVrResolution(): Vector2;
 }
@@ -353,20 +354,20 @@ export function extend(publicAPI: object, model: object, initialValues?: IOpenGL
 export function newInstance(initialValues?: IOpenGLRenderWindowInitialValues): vtkOpenGLRenderWindow;
 
 /**
- * 
- * @param cb 
+ *
+ * @param cb
  */
 export function pushMonitorGLContextCount(cb: any): void;
 
 /**
- * 
- * @param cb 
+ *
+ * @param cb
  */
 export function popMonitorGLContextCount(cb: any): void;
 
 /**
  * WebGL rendering window
- * 
+ *
  * vtkOpenGLRenderWindow is designed to view/render a vtkRenderWindow.
  */
 export declare const vtkOpenGLRenderWindow: {

package/Rendering/OpenGL/VolumeMapper.js

@@ -1,5 +1,5 @@
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
-import { newInstance as newInstance$1, obj, setGet, vtkWarningMacro as vtkWarningMacro$1, vtkErrorMacro as vtkErrorMacro$1 } from '../../macros.js';
+import { newInstance as newInstance$1, obj, setGet, chain, vtkWarningMacro as vtkWarningMacro$1, vtkErrorMacro as vtkErrorMacro$1 } from '../../macros.js';
 import { mat4, mat3, vec3 } from 'gl-matrix';
 import vtkDataArray from '../../Common/Core/DataArray.js';
 import { VtkDataTypes } from '../../Common/Core/DataArray/Constants.js';
@@ -672,90 +672,86 @@ function vtkOpenGLVolumeMapper(publicAPI, model) {
       program.setUniform3fv("vClipPlaneNormals", clipPlaneNormals);
       program.setUniformfv("vClipPlaneDistances", clipPlaneDistances);
     }
-  };
+  }; // unsubscribe from our listeners
+
+
+  publicAPI.delete = chain(function () {
+    if (model._animationRateSubscription) {
+      model._animationRateSubscription.unsubscribe();
+
+      model._animationRateSubscription = null;
+    }
+  }, publicAPI.delete);
 
   publicAPI.getRenderTargetSize = function () {
-    if (model.lastXYF > 1.43) {
-      var sz = model.framebuffer.getSize();
-      return [model.fvp[0] * sz[0], model.fvp[1] * sz[1]];
+    if (model._useSmallViewport) {
+      return [model._smallViewportWidth, model._smallViewportHeight];
     }
 
     return model.openGLRenderWindow.getFramebufferSize();
   };
 
   publicAPI.renderPieceStart = function (ren, actor) {
-    if (model.renderable.getAutoAdjustSampleDistances()) {
-      var rwi = ren.getVTKWindow().getInteractor();
-      var rft = rwi.getLastFrameTime(); // console.log(`last frame time ${Math.floor(1.0 / rft)}`);
-      // frame time is typically for a couple frames prior
-      // which makes it messy, so keep long running averages
-      // of frame times and pixels rendered
-
-      model.avgFrameTime = 0.97 * model.avgFrameTime + 0.03 * rft;
-      model.avgWindowArea = 0.97 * model.avgWindowArea + 0.03 / (model.lastXYF * model.lastXYF);
-
-      if (ren.getVTKWindow().getInteractor().isAnimating()) {
-        // compute target xy factor
-        var txyf = Math.sqrt(model.avgFrameTime * rwi.getDesiredUpdateRate() / model.avgWindowArea); // limit subsampling to a factor of 10
-
-        if (txyf > 10.0) {
-          txyf = 10.0;
-        }
+    var rwi = ren.getVTKWindow().getInteractor();
+    model._useSmallViewport = false;
+
+    if (rwi.isAnimating() && model._lastScale > 1.5) {
+      model._useSmallViewport = true;
+    }
+
+    if (!model._animationRateSubscription) {
+      // when the animation frame rate changes recompute the scale factor
+      model._animationRateSubscription = rwi.onAnimationFrameRateUpdate(function () {
+        if (model.renderable.getAutoAdjustSampleDistances()) {
+          var frate = rwi.getRecentAnimationFrameRate();
+          var adjustment = rwi.getDesiredUpdateRate() / frate; // only change if we are off by 15%
+
+          if (adjustment > 1.15 || adjustment < 0.85) {
+            model._lastScale *= adjustment;
+          } // clamp scale to some reasonable values.
+          // Below 1.5 we will just be using full resolution as that is close enough
+          // Above 400 seems like a lot so we limit to that 1/20th per axis
 
-        model.targetXYF = txyf;
-      } else {
-        model.targetXYF = Math.sqrt(model.avgFrameTime * rwi.getStillUpdateRate() / model.avgWindowArea);
-      } // have some inertia to change states around 1.43
 
+          if (model._lastScale > 400) {
+            model._lastScale = 400;
+          }
+
+          if (model._lastScale < 1.5) {
+            model._lastScale = 1.5;
+          }
+        } else {
+          model._lastScale = model.renderable.getImageSampleDistance() * model.renderable.getImageSampleDistance();
+        }
+
+        var size = model.openGLRenderWindow.getFramebufferSize();
+        model._smallViewportWidth = Math.ceil(size[0] / Math.sqrt(model._lastScale));
+        model._smallViewportHeight = Math.ceil(size[1] / Math.sqrt(model._lastScale));
+      });
+    } // use/create/resize framebuffer if needed
 
-      if (model.targetXYF < 1.53 && model.targetXYF > 1.33) {
-        model.targetXYF = model.lastXYF;
-      } // and add some inertia to change at all
 
+    if (model._useSmallViewport) {
+      var size = model.openGLRenderWindow.getFramebufferSize(); // adjust viewportSize to always be at most the dest fo size
 
-      if (Math.abs(1.0 - model.targetXYF / model.lastXYF) < 0.1) {
-        model.targetXYF = model.lastXYF;
+      if (model._smallViewportHeight > size[1]) {
+        model._smallViewportHeight = size[1];
       }
 
-      model.lastXYF = model.targetXYF;
-    } else {
-      model.lastXYF = model.renderable.getImageSampleDistance();
-    } // only use FBO beyond this value
-
-
-    if (model.lastXYF <= 1.43) {
-      model.lastXYF = 1.0;
-    } // console.log(`last target  ${model.lastXYF} ${model.targetXYF}`);
-    // console.log(`awin aft  ${model.avgWindowArea} ${model.avgFrameTime}`);
-
-
-    var xyf = model.lastXYF;
-    var size = model.openGLRenderWindow.getFramebufferSize(); // const newSize = [
-    //   Math.floor((size[0] / xyf) + 0.5),
-    //   Math.floor((size[1] / xyf) + 0.5)];
-    // const diag = vtkBoundingBox.getDiagonalLength(model.currentInput.getBounds());
-    // // so what is the resulting sample size roughly
-    // console.log(`sam size ${diag / newSize[0]} ${diag / newSize[1]} ${model.renderable.getImageSampleDistance()}`);
-    // // if the sample distance is getting far from the image sample dist
-    // if (2.0 * diag / (newSize[0] + newSize[1]) > 4 * model.renderable.getSampleDistance()) {
-    //   model.renderable.setSampleDistance(4.0 * model.renderable.getSampleDistance());
-    // }
-    // if (2.0 * diag / (newSize[0] + newSize[1]) < 0.25 * model.renderable.getSampleDistance()) {
-    //   model.renderable.setSampleDistance(0.25 * model.renderable.getSampleDistance());
-    // }
-    // create/resize framebuffer if needed
+      if (model._smallViewportWidth > size[0]) {
+        model._smallViewportWidth = size[0];
+      }
 
-    if (xyf > 1.43) {
       model.framebuffer.saveCurrentBindingsAndBuffers();
 
       if (model.framebuffer.getGLFramebuffer() === null) {
-        model.framebuffer.create(Math.floor(size[0] * 0.7), Math.floor(size[1] * 0.7));
+        model.framebuffer.create(size[0], size[1]);
         model.framebuffer.populateFramebuffer();
       } else {
         var fbSize = model.framebuffer.getSize();
 
-        if (fbSize[0] !== Math.floor(size[0] * 0.7) || fbSize[1] !== Math.floor(size[1] * 0.7)) {
-          model.framebuffer.create(Math.floor(size[0] * 0.7), Math.floor(size[1] * 0.7));
+        if (fbSize[0] !== size[0] || fbSize[1] !== size[1]) {
+          model.framebuffer.create(size[0], size[1]);
           model.framebuffer.populateFramebuffer();
         }
       }
@@ -765,8 +761,8 @@ function vtkOpenGLVolumeMapper(publicAPI, model) {
       gl.clearColor(0.0, 0.0, 0.0, 0.0);
       gl.colorMask(true, true, true, true);
       gl.clear(gl.COLOR_BUFFER_BIT);
-      gl.viewport(0, 0, size[0] / xyf, size[1] / xyf);
-      model.fvp = [Math.floor(size[0] / xyf) / Math.floor(size[0] * 0.7), Math.floor(size[1] / xyf) / Math.floor(size[1] * 0.7)];
+      gl.viewport(0, 0, model._smallViewportWidth, model._smallViewportHeight);
+      model.fvp = [model._smallViewportWidth / size[0], model._smallViewportHeight / size[1]];
     }
 
     model.context.disable(model.context.DEPTH_TEST); // make sure the BOs are up to date
@@ -817,7 +813,7 @@ function vtkOpenGLVolumeMapper(publicAPI, model) {
       model.zBufferTexture.deactivate();
     }
 
-    if (model.lastXYF > 1.43) {
+    if (model._useSmallViewport) {
       // now copy the framebuffer with the volume into the
       // regular buffer
       model.framebuffer.restorePreviousBindingsAndBuffers();
@@ -1006,8 +1002,7 @@ function vtkOpenGLVolumeMapper(publicAPI, model) {
       var dims = image.getDimensions();
       model.scalarTexture.releaseGraphicsResources(model.openGLRenderWindow);
       model.scalarTexture.resetFormatAndType();
-      model.scalarTexture.create3DFilterableFromRaw(dims[0], dims[1], dims[2], numComp, scalars.getDataType(), scalars.getData(), model.renderable.getPreferSizeOverAccuracy()); // console.log(model.scalarTexture.get());
-
+      model.scalarTexture.create3DFilterableFromRaw(dims[0], dims[1], dims[2], numComp, scalars.getDataType(), scalars.getData(), model.renderable.getPreferSizeOverAccuracy());
       model.scalarTextureString = toString;
     }
 
@@ -1125,7 +1120,8 @@ function extend(publicAPI, model) {
   model.idxNormalMatrix = mat3.identity(new Float64Array(9));
   model.modelToView = mat4.identity(new Float64Array(16));
   model.projectionToView = mat4.identity(new Float64Array(16));
-  model.projectionToWorld = mat4.identity(new Float64Array(16)); // Build VTK API
+  model.projectionToWorld = mat4.identity(new Float64Array(16));
+  model._lastScale = 1.0; // Build VTK API
 
   setGet(publicAPI, model, ['context']); // Object methods
 

package/package.json

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