@kitware/vtk.js 32.6.2 → 33.0.0-beta.2

package/BREAKING_CHANGES.md

@@ -1,3 +1,6 @@
+## From 32.x to 33
+
+- **vtkMapper**: many properties have moved to `vtkVolumeProperty`. The full list of changed methods is: `getAnisotropy`, `getComputeNormalFromOpacity`, `getFilterMode`, `getFilterModeAsString`, `getGlobalIlluminationReach`, `getIpScalarRange`, `getIpScalarRangeByReference`, `getLAOKernelRadius`, `getLAOKernelSize`, `getLocalAmbientOcclusion`, `getPreferSizeOverAccuracy`, `getVolumetricScatteringBlending`, `setAnisotropy`, `setAverageIPScalarRange`, `setComputeNormalFromOpacity`, `setFilterMode`, `setFilterModeToNormalized`, `setFilterModeToOff`, `setFilterModeToRaw`, `setGlobalIlluminationReach`, `setIpScalarRange`, `setIpScalarRangeFrom`, `setLAOKernelRadius`, `setLAOKernelSize`, `setLocalAmbientOcclusion`, `setPreferSizeOverAccuracy`, `setVolumetricScatteringBlending`.
 ## From 31.x to 32
 
 - **vtkMapper**: remove `mapScalarsToTexture` from the public API. The function becomes protected and its API changes. This shouldn't cause any issue in most cases.

package/IO/Image.js

@@ -1,9 +1,7 @@
 import vtkHDRReader from './Image/HDRReader.js';
-import vtkTGAReader from './Image/TGAReader.js';
 
 var index = {
-  vtkHDRReader,
-  vtkTGAReader
+  vtkHDRReader
 };
 
 export { index as default };

package/Interaction/Manipulators/KeyboardCameraManipulator.d.ts

@@ -0,0 +1,113 @@
+import { Vector3 } from './../../types';
+import { vtkObject } from './../../interfaces';
+import vtkCompositeKeyboardManipulator from './CompositeKeyboardManipulator';
+import vtkRenderWindowInteractor from './../../Rendering/Core/RenderWindowInteractor';
+import vtkCamera from './../../Rendering/Core/Camera';
+import vtkRenderer from './../../Rendering/Core/Renderer';
+
+export interface vtkKeyboardCameraManipulator
+  extends vtkObject,
+    vtkCompositeKeyboardManipulator {
+  /**
+   * Returns whether a movement is ongoing.
+   */
+  inMotion(): boolean;
+
+  /**
+   * Reset the movement speed to be proportional to the longest length of the renderer's bounds.
+   */
+  resetMovementSpeed(): void;
+
+  /**
+   * Initialize a movement of the current camera.
+   */
+  startMovement(): void;
+
+  /**
+   * Cancel any ongoing camera movement.
+   */
+  endMovement(): void;
+
+  /**
+   * Update active camera direction, depending on currently pressed keys.
+   */
+  calculateCurrentDirection(): void;
+
+  /**
+   * Returns the direction vector of the given camera for the given key.
+   * @param key the movedkey
+   * @param camera the camera
+   */
+  getDirectionFromKey(key: KeyboardEvent['key'], camera: vtkCamera): Vector3;
+
+  /**
+   * Moves the given camera, in the given direction, at the given speed.
+   * @param camera the moved camera
+   * @param direction the direction of the movemnt
+   * @param speed the speed
+   */
+  moveCamera(camera: vtkCamera, direction: Vector3, speed: number): void;
+
+  /**
+   * Handles a keypress event.
+   * @param interactor the interactor
+   * @param renderer the renderer
+   * @param key the key
+   */
+  onKeyPress(
+    interactor: vtkRenderWindowInteractor,
+    renderer: vtkRenderer,
+    key: KeyboardEvent['key']
+  ): void;
+
+  /**
+   * Handles a keydown event.
+   * @param interactor the interactor
+   * @param renderer the renderer
+   * @param key the key
+   */
+  onKeyDown(
+    interactor: vtkRenderWindowInteractor,
+    renderer: vtkRenderer,
+    key: KeyboardEvent['key']
+  ): void;
+
+  /**
+   * Handles a keyup event.
+   * @param interactor the interactor
+   * @param renderer the renderer
+   * @param key the key
+   */
+  onKeyUp(
+    interactor: vtkRenderWindowInteractor,
+    renderer: vtkRenderer,
+    key: KeyboardEvent['key']
+  ): void;
+}
+
+export interface IKeyboardCameraManipulatorInitialValues {
+  movementSpeed?: number;
+  moveForwardKeys?: KeyboardEvent['key'][];
+  moveLeftKeys?: KeyboardEvent['key'][];
+  moveBackwardKeys?: KeyboardEvent['key'][];
+  moveRightKeys?: KeyboardEvent['key'][];
+  moveUpKeys?: KeyboardEvent['key'][];
+  moveDownKeys?: KeyboardEvent['key'][];
+}
+
+export function newInstance(
+  initialValues?: IKeyboardCameraManipulatorInitialValues
+): vtkKeyboardCameraManipulator;
+
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IKeyboardCameraManipulatorInitialValues
+): void;
+
+export const vtkKeyboardCameraManipulator: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+
+export default vtkKeyboardCameraManipulator;

package/Rendering/Core/Actor.d.ts

@@ -36,12 +36,6 @@ export interface vtkActor extends vtkProp3D {
    */
   getBackfaceProperty(): vtkProperty;
 
-  /**
-   * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
-   * @return {Bounds} The bounds for the mapper.
-   */
-  getBounds(): Bounds;
-
   /**
    * Check whether the opaque is forced or not.
    */
@@ -63,16 +57,6 @@ export interface vtkActor extends vtkProp3D {
    */
   getMapper(): Nullable<vtkMapper>;
 
-  /**
-   * Get the property object that controls this actors surface
-   * properties. This should be an instance of a vtkProperty object. Every
-   * actor must have a property associated with it. If one isn’t specified,
-   * then one will be generated automatically. Multiple actors can share one
-   * property object.
-   * @return {vtkProperty} The property object
-   */
-  getProperty(): vtkProperty;
-
   /**
    * Check whether if the actor supports selection
    * @return {Boolean} true if the actor support selection.
@@ -111,11 +95,12 @@ export interface vtkActor extends vtkProp3D {
    */
   setMapper(mapper: vtkMapper): boolean;
 
-  /**
-   * Set the property object that controls this actors surface properties.
-   * @param {vtkProperty} property The vtkProperty instance.
-   */
+  // Inherited from vtkProp3D, but takes a vtkProperty instead of a generic vtkObject
+  getProperty(mapperInputPort?: number): vtkProperty;
+  getProperties(): vtkProperty[];
+  setProperty(mapperInputPort: number, property: vtkProperty): boolean;
   setProperty(property: vtkProperty): boolean;
+  setProperties(properties: vtkProperty[]): boolean;
 }
 
 /**

package/Rendering/Core/Actor.js

@@ -1,13 +1,7 @@
-import { mat4, vec3 } from 'gl-matrix';
 import { m as macro } from '../../macros2.js';
-import vtkBoundingBox from '../../Common/DataModel/BoundingBox.js';
 import vtkProp3D from './Prop3D.js';
 import vtkProperty from './Property.js';
 
-const {
-  vtkDebugMacro
-} = macro;
-
 // ----------------------------------------------------------------------------
 // vtkActor methods
 // ----------------------------------------------------------------------------
@@ -29,11 +23,11 @@ function vtkActor(publicAPI, model) {
       return false;
     }
     // make sure we have a property
-    if (!model.property) {
+    if (!model.properties[0]) {
       // force creation of a property
       publicAPI.getProperty();
     }
-    let isOpaque = model.property.getOpacity() >= 1.0;
+    let isOpaque = model.properties[0].getOpacity() >= 1.0;
 
     // are we using an opaque texture, if any?
     isOpaque = isOpaque && (!model.texture || !model.texture.isTranslucent());
@@ -47,71 +41,17 @@ function vtkActor(publicAPI, model) {
       return false;
     }
     // make sure we have a property
-    if (model.property === null) {
+    if (!model.properties[0]) {
       // force creation of a property
-      publicAPI.setProperty(publicAPI.makeProperty());
+      publicAPI.getProperty();
     }
 
     // is this actor opaque ?
     return !publicAPI.getIsOpaque();
   };
   publicAPI.makeProperty = vtkProperty.newInstance;
-  publicAPI.getProperty = () => {
-    if (model.property === null) {
-      model.property = publicAPI.makeProperty();
-    }
-    return model.property;
-  };
-  publicAPI.getBounds = () => {
-    if (model.mapper === null) {
-      return model.bounds;
-    }
-
-    // Check for the special case when the mapper's bounds are unknown
-    const bds = model.mapper.getBounds();
-    if (!bds || bds.length !== 6) {
-      return bds;
-    }
-
-    // Check for the special case when the actor is empty.
-    if (bds[0] > bds[1]) {
-      model.mapperBounds = bds.concat(); // copy the mapper's bounds
-      model.bounds = [1, -1, 1, -1, 1, -1];
-      model.boundsMTime.modified();
-      return bds;
-    }
-
-    // Check if we have cached values for these bounds - we cache the
-    // values returned by model.mapper.getBounds() and we store the time
-    // of caching. If the values returned this time are different, or
-    // the modified time of this class is newer than the cached time,
-    // then we need to rebuild.
-    if (!model.mapperBounds || bds[0] !== model.mapperBounds[0] || bds[1] !== model.mapperBounds[1] || bds[2] !== model.mapperBounds[2] || bds[3] !== model.mapperBounds[3] || bds[4] !== model.mapperBounds[4] || bds[5] !== model.mapperBounds[5] || publicAPI.getMTime() > model.boundsMTime.getMTime()) {
-      vtkDebugMacro('Recomputing bounds...');
-      model.mapperBounds = bds.concat(); // copy the mapper's bounds
-      const bbox = [];
-      vtkBoundingBox.getCorners(bds, bbox);
-      publicAPI.computeMatrix();
-      const tmp4 = new Float64Array(16);
-      mat4.transpose(tmp4, model.matrix);
-      bbox.forEach(pt => vec3.transformMat4(pt, pt, tmp4));
-
-      /* eslint-disable no-multi-assign */
-      model.bounds[0] = model.bounds[2] = model.bounds[4] = Number.MAX_VALUE;
-      model.bounds[1] = model.bounds[3] = model.bounds[5] = -Number.MAX_VALUE;
-      /* eslint-enable no-multi-assign */
-
-      model.bounds = model.bounds.map((d, i) => i % 2 === 0 ? bbox.reduce((a, b) => a > b[i / 2] ? b[i / 2] : a, d) : bbox.reduce((a, b) => a < b[(i - 1) / 2] ? b[(i - 1) / 2] : a, d));
-      model.boundsMTime.modified();
-    }
-    return model.bounds;
-  };
   publicAPI.getMTime = () => {
     let mt = superClass.getMTime();
-    if (model.property !== null) {
-      const time = model.property.getMTime();
-      mt = time > mt ? time : mt;
-    }
     if (model.backfaceProperty !== null) {
       const time = model.backfaceProperty.getMTime();
       mt = time > mt ? time : mt;
@@ -146,11 +86,9 @@ function vtkActor(publicAPI, model) {
 
 const DEFAULT_VALUES = {
   mapper: null,
-  property: null,
   backfaceProperty: null,
   forceOpaque: false,
-  forceTranslucent: false,
-  bounds: [1, -1, 1, -1, 1, -1]
+  forceTranslucent: false
 };
 
 // ----------------------------------------------------------------------------
@@ -167,7 +105,6 @@ function extend(publicAPI, model) {
   macro.obj(model.boundsMTime);
 
   // Build VTK API
-  macro.set(publicAPI, model, ['property']);
   macro.setGet(publicAPI, model, ['backfaceProperty', 'forceOpaque', 'forceTranslucent', 'mapper']);
 
   // Object methods

package/Rendering/Core/ImageProperty.d.ts

@@ -94,28 +94,6 @@ export interface vtkImageProperty extends vtkObject {
    */
   getScalarOpacity(idx?: number): vtkPiecewiseFunction;
 
-  /**
-   * Enable label outline rendering.
-   * @param {Boolean} useLabelOutline
-   */
-  setUseLabelOutline(useLabelOutline: boolean): boolean;
-
-  /**
-   * Check if label outline rendering.
-   */
-  getUseLabelOutline(): boolean;
-
-  /**
-   * Set the 0 to 1 opacity of the label outline.
-   * @param {Number} opacity
-   */
-  setLabelOutlineOpacity(opacity: number): boolean;
-
-  /**
-   * Get the 0 to 1 opacity of the label outline.
-   */
-  getLabelOutlineOpacity(): number;
-
   /**
    * gets the label outline thickness
    */

package/Rendering/Core/ImageSlice.d.ts

@@ -17,18 +17,6 @@ export interface vtkImageSlice extends vtkProp3D {
    */
   getActors(): any;
 
-  /**
-   * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
-   * @return {Bounds} The bounds for the mapper.
-   */
-  getBounds(): Bounds;
-
-  /**
-   * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
-   * @return {Bounds} The bounds for the mapper.
-   */
-  getBoundsByReference(): Bounds;
-
   /**
    * Get the bounds for a given slice as [xmin, xmax, ymin, ymax,zmin, zmax].
    * @param {Number} slice The slice index. If undefined, the current slice is considered.
@@ -47,11 +35,6 @@ export interface vtkImageSlice extends vtkProp3D {
    */
   getIsOpaque(): boolean;
 
-  /**
-   *
-   */
-  getProperty(): vtkImageProperty;
-
   /**
    *
    */
@@ -130,12 +113,6 @@ export interface vtkImageSlice extends vtkProp3D {
    */
   setMapper(mapper: vtkAbstractImageMapper): boolean;
 
-  /**
-   *
-   * @param {vtkImageProperty} property The vtkImageProperty instance.
-   */
-  setProperty(property: vtkImageProperty): boolean;
-
   /**
    *
    * @param {boolean} forceOpaque If true, render during opaque pass even if opacity value is below 1.0.
@@ -147,6 +124,13 @@ export interface vtkImageSlice extends vtkProp3D {
    * @param {boolean} forceTranslucent If true, render during translucent pass even if opacity value is 1.0.
    */
   setForceTranslucent(forceTranslucent: boolean): boolean;
+
+  // Inherited from vtkProp3D, but takes a vtkImageProperty instead of a generic vtkObject
+  getProperty(mapperInputPort?: number): vtkImageProperty;
+  getProperties(): vtkImageProperty[];
+  setProperty(mapperInputPort: number, property: vtkImageProperty): boolean;
+  setProperty(property: vtkImageProperty): boolean;
+  setProperties(properties: vtkImageProperty[]): boolean;
 }
 
 /**

package/Rendering/Core/ImageSlice.js

@@ -4,10 +4,6 @@ import vtkBoundingBox from '../../Common/DataModel/BoundingBox.js';
 import vtkProp3D from './Prop3D.js';
 import vtkImageProperty from './ImageProperty.js';
 
-const {
-  vtkDebugMacro
-} = macro;
-
 // ----------------------------------------------------------------------------
 // vtkImageSlice methods
 // ----------------------------------------------------------------------------
@@ -25,11 +21,11 @@ function vtkImageSlice(publicAPI, model) {
       return false;
     }
     // make sure we have a property
-    if (!model.property) {
+    if (!model.properties[0]) {
       // force creation of a property
       publicAPI.getProperty();
     }
-    let isOpaque = model.property.getOpacity() >= 1.0;
+    let isOpaque = model.properties[0].getOpacity() >= 1.0;
 
     // are we using an opaque scalar array, if any?
     isOpaque = isOpaque && (!model.mapper || model.mapper.getIsOpaque());
@@ -43,48 +39,6 @@ function vtkImageSlice(publicAPI, model) {
   // and the Renderer will do the images in their own pass.
   publicAPI.hasTranslucentPolygonalGeometry = () => false;
   publicAPI.makeProperty = vtkImageProperty.newInstance;
-  publicAPI.getProperty = () => {
-    if (model.property === null) {
-      model.property = publicAPI.makeProperty();
-    }
-    return model.property;
-  };
-  publicAPI.getBounds = () => {
-    if (model.mapper === null) {
-      return model.bounds;
-    }
-
-    // Check for the special case when the mapper's bounds are unknown
-    const bds = model.mapper.getBounds();
-    if (!bds || bds.length !== 6) {
-      return bds;
-    }
-
-    // Check for the special case when the actor is empty.
-    if (bds[0] > bds[1]) {
-      model.mapperBounds = bds.concat(); // copy the mapper's bounds
-      model.bounds = [1, -1, 1, -1, 1, -1];
-      model.boundsMTime.modified();
-      return bds;
-    }
-
-    // Check if we have cached values for these bounds - we cache the
-    // values returned by model.mapper.getBounds() and we store the time
-    // of caching. If the values returned this time are different, or
-    // the modified time of this class is newer than the cached time,
-    // then we need to rebuild.
-    const zip = rows => rows[0].map((_, c) => rows.map(row => row[c]));
-    if (!model.mapperBounds || !zip([bds, model.mapperBounds]).reduce((a, b) => a && b[0] === b[1], true) || publicAPI.getMTime() > model.boundsMTime.getMTime()) {
-      vtkDebugMacro('Recomputing bounds...');
-      model.mapperBounds = bds.map(x => x);
-      publicAPI.computeMatrix();
-      const tmp4 = new Float64Array(16);
-      mat4.transpose(tmp4, model.matrix);
-      vtkBoundingBox.transformBounds(bds, tmp4, model.bounds);
-      model.boundsMTime.modified();
-    }
-    return model.bounds;
-  };
   publicAPI.getBoundsForSlice = (slice, thickness) => {
     // Check for the special case when the mapper's bounds are unknown
     const bds = model.mapper.getBoundsForSlice(slice, thickness);
@@ -117,14 +71,6 @@ function vtkImageSlice(publicAPI, model) {
 
   // Get the maximum Z bound
   publicAPI.getMaxZBound = () => publicAPI.getBounds()[5];
-  publicAPI.getMTime = () => {
-    let mt = model.mtime;
-    if (model.property !== null) {
-      const time = model.property.getMTime();
-      mt = time > mt ? time : mt;
-    }
-    return mt;
-  };
   publicAPI.getRedrawMTime = () => {
     let mt = model.mtime;
     if (model.mapper !== null) {
@@ -137,14 +83,13 @@ function vtkImageSlice(publicAPI, model) {
         mt = time > mt ? time : mt;
       }
     }
-    if (model.property !== null) {
-      let time = model.property.getMTime();
-      mt = time > mt ? time : mt;
-      if (model.property.getRGBTransferFunction() !== null) {
-        time = model.property.getRGBTransferFunction().getMTime();
-        mt = time > mt ? time : mt;
+    model.properties.forEach(property => {
+      mt = Math.max(mt, property.getMTime());
+      const rgbFunc = property.getRGBTransferFunction();
+      if (rgbFunc !== null) {
+        mt = Math.max(mt, rgbFunc.getMTime());
       }
-    }
+    });
     return mt;
   };
   publicAPI.getSupportsSelection = () => model.mapper ? model.mapper.getSupportsSelection() : false;
@@ -156,10 +101,8 @@ function vtkImageSlice(publicAPI, model) {
 
 const DEFAULT_VALUES = {
   mapper: null,
-  property: null,
   forceOpaque: false,
-  forceTranslucent: false,
-  bounds: [...vtkBoundingBox.INIT_BOUNDS]
+  forceTranslucent: false
 };
 
 // ----------------------------------------------------------------------------
@@ -176,9 +119,7 @@ function extend(publicAPI, model) {
   macro.obj(model.boundsMTime);
 
   // Build VTK API
-  macro.set(publicAPI, model, ['property']);
   macro.setGet(publicAPI, model, ['mapper', 'forceOpaque', 'forceTranslucent']);
-  macro.getArray(publicAPI, model, ['bounds'], 6);
 
   // Object methods
   vtkImageSlice(publicAPI, model);

package/Rendering/Core/PointPicker.js

@@ -114,10 +114,7 @@ function vtkPointPicker(publicAPI, model) {
         }
       }
     }
-    if (minPtId > -1 && tMin < model.globalTMin) {
-      model.globalTMin = tMin;
-      model.pointId = minPtId;
-    }
+    model.pointId = minPtId;
     return tMin;
   };
 }

package/Rendering/Core/Prop3D.d.ts

@@ -1,6 +1,7 @@
 import { mat4, quat } from 'gl-matrix';
 import { Bounds, Vector3, Range } from './../../types';
 import vtkProp, { IPropInitialValues } from './Prop';
+import { vtkObject } from './../../interfaces';
 
 export interface IProp3DInitialValues extends IPropInitialValues {
   origin?: number[];
@@ -19,11 +20,17 @@ export interface vtkProp3D extends vtkProp {
   addPosition(deltaXYZ: number[]): void;
 
   /**
-   * Get the bounds as [xmin, xmax, ymin, ymax, zmin, zmax].
-   * @return {Bounds} The bounds for the mapper.
+   * Get the bounds of this actor as [xmin, xmax, ymin, ymax, zmin, zmax].
+   * They are the bounds of the underlying mapper, transformed using the actor's matrix.
+   * @return {Bounds} The bounds for the actor.
    */
   getBounds(): Bounds;
 
+  /**
+   * Same as getBounds() but the returned array is not copied, so it should not be written to.
+   */
+  getBoundsByReference(): Bounds;
+
   /**
    * Check if there was a modification or transformation.
    * @default null
@@ -131,6 +138,21 @@ export interface vtkProp3D extends vtkProp {
    */
   getUserMatrix(): mat4;
 
+  /**
+   * Get the actor property for the specified mapper input port, which defaults to 0
+   * It controls this actors rendering properties. If one isn’t specified,
+   * then one will be generated automatically. Multiple actors can share one
+   * property object.
+   * @param {number} mapperInputPort Defaults to 0
+   */
+  getProperty(mapperInputPort?: number): vtkObject;
+
+  /**
+   * Get the actor properties array
+   * Each element of the array corresponds to a mapper input port
+   */
+  getProperties(): vtkObject[];
+
   /**
    * Rotate the Prop3D in degrees about the X axis using the right hand
    * rule. The axis is the Prop3D’s X axis, which can change as other
@@ -256,6 +278,21 @@ export interface vtkProp3D extends vtkProp {
    * Generate the matrix based on internal model.
    */
   computeMatrix(): void;
+
+  /**
+   * Set the actor property for the specified mapper input port, which defaults to 0
+   * @param {vtkObject} property
+   * @param {number} mapperInputPort Is 0 when not given
+   */
+  setProperty(mapperInputPort: number, property: vtkObject): boolean;
+  setProperty(property: vtkObject): boolean;
+
+  /**
+   * Set the actor properties array
+   * Each element of the array corresponds to a mapper input port
+   * @param {vtkObject[]} properties
+   */
+  setProperties(properties: vtkObject[]): boolean;
 }
 
 /**