@kitware/vtk.js 33.1.1 → 34.0.0-beta.1

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;
 }
 
 /**

package/Rendering/Core/Prop3D.js

@@ -121,6 +121,54 @@ function vtkProp3D(publicAPI, model) {
       model.matrixMTime.modified();
     }
   };
+  publicAPI.getBoundsByReference = () => {
+    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]) {
+      // No need to copy bds, a new array is created when calling getBounds()
+      model.mapperBounds = bds;
+      model.bounds = [...vtkBoundingBox.INIT_BOUNDS];
+      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.every((_, i) => bds[i] === model.mapperBounds[i]) || publicAPI.getMTime() > model.boundsMTime.getMTime()) {
+      macro.vtkDebugMacro('Recomputing bounds...');
+      // No need to copy bds, a new array is created when calling getBounds()
+      model.mapperBounds = bds;
+
+      // Compute actor bounds from matrix and mapper bounds
+      publicAPI.computeMatrix();
+      const transposedMatrix = new Float64Array(16);
+      mat4.transpose(transposedMatrix, model.matrix);
+      vtkBoundingBox.transformBounds(bds, transposedMatrix, model.bounds);
+      model.boundsMTime.modified();
+    }
+    return model.bounds;
+  };
+  publicAPI.getBounds = () => {
+    const bounds = publicAPI.getBoundsByReference();
+    // Handle case when bounds are not iterable (for example null or undefined)
+    try {
+      return [...bounds];
+    } catch {
+      return bounds;
+    }
+  };
   publicAPI.getCenter = () => vtkBoundingBox.getCenter(model.bounds);
   publicAPI.getLength = () => vtkBoundingBox.getLength(model.bounds);
   publicAPI.getXRange = () => vtkBoundingBox.getXRange(model.bounds);
@@ -131,6 +179,35 @@ function vtkProp3D(publicAPI, model) {
     publicAPI.computeMatrix();
   }
   publicAPI.onModified(updateIdentityFlag);
+  publicAPI.getProperty = function () {
+    let mapperInputPort = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+    if (model.properties[mapperInputPort] == null) {
+      model.properties[mapperInputPort] = publicAPI.makeProperty?.();
+    }
+    return model.properties[mapperInputPort];
+  };
+  publicAPI.setProperty = (firstArg, secondArg) => {
+    // Two options for argument layout:
+    // - (mapperInputPort, property)
+    // - (property)
+    const useInputPortArgument = Number.isInteger(firstArg);
+    const [mapperInputPort, property] = useInputPortArgument ? [firstArg, secondArg] : [0, firstArg];
+    if (model.properties[mapperInputPort] === property) {
+      return false;
+    }
+    model.properties[mapperInputPort] = property;
+    return true;
+  };
+  publicAPI.getMTime = () => {
+    let mt = model.mtime;
+    model.properties.forEach(property => {
+      if (property !== null) {
+        const time = property.getMTime();
+        mt = time > mt ? time : mt;
+      }
+    });
+    return mt;
+  };
 }
 
 // ----------------------------------------------------------------------------
@@ -143,7 +220,8 @@ const DEFAULT_VALUES = {
   orientation: [0, 0, 0],
   rotation: null,
   scale: [1, 1, 1],
-  bounds: [1, -1, 1, -1, 1, -1],
+  bounds: [...vtkBoundingBox.INIT_BOUNDS],
+  properties: [],
   userMatrix: null,
   userMatrixMTime: null,
   cachedProp3D: null,
@@ -163,9 +241,10 @@ function extend(publicAPI, model) {
   macro.obj(model.matrixMTime);
 
   // Build VTK API
-  macro.get(publicAPI, model, ['bounds', 'isIdentity']);
+  macro.get(publicAPI, model, ['isIdentity']);
   macro.getArray(publicAPI, model, ['orientation']);
   macro.setGetArray(publicAPI, model, ['origin', 'position', 'scale'], 3);
+  macro.setGet(publicAPI, model, ['properties']);
 
   // Object internal instance
   model.matrix = mat4.identity(new Float64Array(16));

package/Rendering/Core/Property.d.ts

@@ -1,5 +1,5 @@
 import { vtkObject } from './../../interfaces';
-import { RGBColor } from './../../types';
+import { Nullable, RGBColor } from './../../types';
 import { Interpolation, Representation, Shading } from './Property/Constants';
 import { vtkTexture } from './Texture';
 
@@ -14,6 +14,8 @@ export interface IPropertyInitialValues {
   normalTexture?: vtkTexture;
   ambientOcclusionTexture?: vtkTexture;
   emissionTexture?: vtkTexture;
+  RMTexture?: vtkTexture;
+  ORMTexture?: vtkTexture;
   edgeColor?: RGBColor;
   ambient?: number;
   diffuse?: number;
@@ -216,32 +218,42 @@ export interface vtkProperty extends vtkObject {
   /**
    * Get the diffuse texture.
    */
-  getDiffuseTexture(): vtkTexture;
+  getDiffuseTexture(): Nullable<vtkTexture>;
 
   /**
    * Get the metallic texture.
    */
-  getMetallicTexture(): vtkTexture;
+  getMetallicTexture(): Nullable<vtkTexture>;
+
+  /**
+   * Get the roughness & metallic texture.
+   */
+  getRMTexture(): Nullable<vtkTexture>;
+
+  /**
+   * Get the occlusion, roughness & metallic texture.
+   */
+  getORMTexture(): Nullable<vtkTexture>;
 
   /**
    * Get the roughness texture.
    */
-  getRoughnessTexture(): vtkTexture;
+  getRoughnessTexture(): Nullable<vtkTexture>;
 
   /**
    * Get the normal texture.
    */
-  getNormalTexture(): vtkTexture;
+  getNormalTexture(): Nullable<vtkTexture>;
 
   /**
    * Get the ambient occlusion texture.
    */
-  getAmbientOcclusionTexture(): vtkTexture;
+  getAmbientOcclusionTexture(): Nullable<vtkTexture>;
 
   /**
    * Get the emission texture.
    */
-  getEmissionTexture(): vtkTexture;
+  getEmissionTexture(): Nullable<vtkTexture>;
 
   /**
    * Set the ambient lighting coefficient.
@@ -500,6 +512,18 @@ export interface vtkProperty extends vtkObject {
    */
   setRoughnessTexture(roughnessTexture: vtkTexture): boolean;
 
+  /**
+   * Set the roughness & metallic texture.
+   * @param {vtkTexture} RMTexture
+   */
+  setRMTexture(RMTexture: vtkTexture): boolean;
+
+  /**
+   * Set the occlusion, roughness & metallic texture.
+   * @param {vtkTexture} ORMTexture
+   */
+  setORMTexture(ORMTexture: vtkTexture): boolean;
+
   /**
    * Set the normal texture.
    * @param {vtkTexture} normalTexture

package/Rendering/Core/Property.js

@@ -94,7 +94,9 @@ const DEFAULT_VALUES = {
   lineWidth: 1,
   lighting: true,
   shading: false,
-  materialName: null
+  materialName: null,
+  ORMTexture: null,
+  RMTexture: null
 };
 
 // ----------------------------------------------------------------------------
@@ -105,7 +107,7 @@ function extend(publicAPI, model) {
 
   // Build VTK API
   macro.obj(publicAPI, model);
-  macro.setGet(publicAPI, model, ['lighting', 'interpolation', 'ambient', 'diffuse', 'metallic', 'roughness', 'normalStrength', 'emission', 'baseIOR', 'specular', 'specularPower', 'opacity', 'edgeVisibility', 'lineWidth', 'pointSize', 'backfaceCulling', 'frontfaceCulling', 'representation', 'diffuseTexture', 'metallicTexture', 'roughnessTexture', 'normalTexture', 'ambientOcclusionTexture', 'emissionTexture']);
+  macro.setGet(publicAPI, model, ['lighting', 'interpolation', 'ambient', 'diffuse', 'metallic', 'roughness', 'normalStrength', 'emission', 'baseIOR', 'specular', 'specularPower', 'opacity', 'edgeVisibility', 'lineWidth', 'pointSize', 'backfaceCulling', 'frontfaceCulling', 'representation', 'diffuseTexture', 'metallicTexture', 'roughnessTexture', 'normalTexture', 'ambientOcclusionTexture', 'emissionTexture', 'ORMTexture', 'RMTexture']);
   macro.setGetArray(publicAPI, model, ['ambientColor', 'specularColor', 'diffuseColor', 'edgeColor'], 3);
 
   // Object methods

package/Rendering/Core/RenderWindowInteractor.d.ts

@@ -974,6 +974,12 @@ export interface vtkRenderWindowInteractor extends vtkObject {
   /**
    * Add an HTMLElement as the new container for the interactor.
    * All events will be bound to this new container.
+   *
+   * container will gain the tabIndex=0 attribute to catch keyboard events.
+   * container must have focus (manually via click or tab, or programmatically
+   * via `.focus()`) to receive keypress events
+   * Outline on focus can be customized with CSS :focus pseudo-class.
+   *
    * Any old container will be removed along with its listeners.
    */
   setContainer(container: Nullable<HTMLElement>): boolean;

package/Rendering/Core/RenderWindowInteractor.js

@@ -188,11 +188,13 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     });
     container.addEventListener('pointerup', publicAPI.handlePointerUp);
     container.addEventListener('pointercancel', publicAPI.handlePointerCancel);
-    document.addEventListener('keypress', publicAPI.handleKeyPress);
-    document.addEventListener('keydown', publicAPI.handleKeyDown);
+    container.addEventListener('keypress', publicAPI.handleKeyPress);
+    container.addEventListener('keydown', publicAPI.handleKeyDown);
+    // Observe keyup on document in case the focus changes
+    // between keydown and keyup.
     document.addEventListener('keyup', publicAPI.handleKeyUp);
     document.addEventListener('pointerlockchange', publicAPI.handlePointerLockChange);
-
+    container.tabIndex = 0; // to receive key events
     // using touchAction is more performant than preventDefault
     // in a touchstart handler.
     container.style.touchAction = 'none';
@@ -237,8 +239,8 @@ function vtkRenderWindowInteractor(publicAPI, model) {
       container.removeEventListener('pointerup', publicAPI.handlePointerUp);
       container.removeEventListener('pointercancel', publicAPI.handlePointerCancel);
     }
-    document.removeEventListener('keypress', publicAPI.handleKeyPress);
-    document.removeEventListener('keydown', publicAPI.handleKeyDown);
+    container.removeEventListener('keypress', publicAPI.handleKeyPress);
+    container.removeEventListener('keydown', publicAPI.handleKeyDown);
     document.removeEventListener('keyup', publicAPI.handleKeyUp);
     document.removeEventListener('pointerlockchange', publicAPI.handlePointerLockChange);
     pointerCache.clear();

package/Rendering/Core/Volume.d.ts

@@ -29,22 +29,6 @@ export interface vtkVolume extends vtkProp3D {
    */
   getVolumes(): vtkVolume[];
 
-  /**
-   * Get the volume property
-   */
-  getProperty(): vtkVolumeProperty;
-
-  /**
-   * 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 as [xmin, xmax, ymin, ymax, zmin, zmax].
-   */
-  getBoundsByReference(): Bounds;
-
   /**
    * Get the `Modified Time` which is a monotonic increasing integer
    * global for all vtkObjects.
@@ -75,11 +59,12 @@ export interface vtkVolume extends vtkProp3D {
    */
   setMapper(mapper: vtkVolumeMapper): boolean;
 
-  /**
-   * Set the volume property
-   * @param {vtkVolumeProperty} property
-   */
+  // Inherited from vtkProp3D, but takes a vtkVolumeProperty instead of a generic vtkObject
+  getProperty(mapperInputPort?: number): vtkVolumeProperty;
+  getProperties(): vtkVolumeProperty[];
+  setProperty(mapperInputPort: number, property: vtkVolumeProperty): boolean;
   setProperty(property: vtkVolumeProperty): boolean;
+  setProperties(properties: vtkVolumeProperty[]): boolean;
 }
 
 /**

package/Rendering/Core/Volume.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 vtkVolumeProperty from './VolumeProperty.js';
 
-const {
-  vtkDebugMacro
-} = macro;
-
 // ----------------------------------------------------------------------------
 // vtkVolume methods
 // ----------------------------------------------------------------------------
@@ -15,66 +9,8 @@ const {
 function vtkVolume(publicAPI, model) {
   // Set our className
   model.classHierarchy.push('vtkVolume');
-  publicAPI.getVolumes = () => publicAPI;
+  publicAPI.getVolumes = () => [publicAPI];
   publicAPI.makeProperty = vtkVolumeProperty.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);
-      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 = 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) {
@@ -96,9 +32,7 @@ function vtkVolume(publicAPI, model) {
 // ----------------------------------------------------------------------------
 
 const DEFAULT_VALUES = {
-  mapper: null,
-  property: null,
-  bounds: [1, -1, 1, -1, 1, -1]
+  mapper: null
 };
 
 // ----------------------------------------------------------------------------
@@ -115,9 +49,7 @@ function extend(publicAPI, model) {
   macro.obj(model.boundsMTime);
 
   // Build VTK API
-  macro.set(publicAPI, model, ['property']);
   macro.setGet(publicAPI, model, ['mapper']);
-  macro.getArray(publicAPI, model, ['bounds'], 6);
 
   // Object methods
   vtkVolume(publicAPI, model);

package/Rendering/Core/VolumeMapper/Constants.d.ts

@@ -8,14 +8,7 @@ export declare enum BlendMode {
   LABELMAP_EDGE_PROJECTION_BLEND = 6,
 }
 
-export declare enum FilterMode {
-  OFF = 0,
-  NORMALIZED = 1,
-  RAW = 2,
-}
-
 declare const _default: {
   BlendMode: typeof BlendMode;
-  FilterMode: typeof FilterMode;
 };
 export default _default;

package/Rendering/Core/VolumeMapper/Constants.js

@@ -7,14 +7,8 @@ const BlendMode = {
   RADON_TRANSFORM_BLEND: 5,
   LABELMAP_EDGE_PROJECTION_BLEND: 6
 };
-const FilterMode = {
-  OFF: 0,
-  NORMALIZED: 1,
-  RAW: 2
-};
 var Constants = {
-  BlendMode,
-  FilterMode
+  BlendMode
 };
 
-export { BlendMode, FilterMode, Constants as default };
+export { BlendMode, Constants as default };