@kitware/vtk.js 31.1.0 → 32.0.0

package/BREAKING_CHANGES.md

@@ -1,3 +1,11 @@
+## 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.
+
+## From 30.x to 31
+
+- **Picking**: write to depth buffer for translucent pass when picking. This change fixes a picking issue with multiple translucent actors overlaid on top of each other. The hardware selector would just register the propID of the last rendered prop. This was because we explicitly turn off writing to the depth buffer when rendering translucent props as OIT doesn't need it. This change enables writing to the depth buffer when picking in the translucent pass. Applications relying on picked propID would see a difference in the IDs returned by the hardware selector.
+
 ## From 29.x to 30
 
 - **ResliceCursorWidget.interactionEvent**: no longer pass an object of `{computeFocalPointOffset, canUpdateFocalPoint}` but simply the type of the handle that triggers the event (e.g. `InteractionMethodsName.RotateLine`). The removed values can easily be recomputed by the consumers of the event by checking the type of the handle. Regarding `computeFocalPointOffset`, it is no longer advised to compute focal point offset for each interaction, instead observing `startInteraction()` should be considered (see ResliceCursorWidget example).

package/Common/Core/LookupTable.js

@@ -60,7 +60,8 @@ function vtkLookupTable(publicAPI, model) {
   publicAPI.usingLogScale = () => false;
 
   //----------------------------------------------------------------------------
-  publicAPI.getNumberOfAvailableColors = () => model.table.length / 4;
+  // Don't count special colors (min, max, NaN) as available colors
+  publicAPI.getNumberOfAvailableColors = () => model.table.length / 4 - 3;
 
   //----------------------------------------------------------------------------
   // Apply shift/scale to the scalar value v and return the index.

package/Rendering/Core/ColorTransferFunction.js

@@ -937,7 +937,9 @@ function vtkColorTransferFunction(publicAPI, model) {
       // has been called.
       return model.tableSize;
     }
-    return 16777216; // 2^24
+    const nNodes = model.nodes?.length ?? 0;
+    // The minimum is 4094 colors so that it fills in the 4096 texels texture in `mapScalarsToTexture`
+    return Math.max(4094, nNodes);
   };
 
   //----------------------------------------------------------------------------

package/Rendering/Core/ImageArrayMapper.d.ts

@@ -6,11 +6,9 @@ import { Bounds, Nullable } from './../../types';
 import { SlicingMode } from './ImageMapper/Constants';
 import vtkImageData from './../../Common/DataModel/ImageData';
 import vtkCollection from './../../Common/DataModel/Collection';
-
-interface ICoincidentTopology {
-  factor: number;
-  offset: number;
-}
+import CoincidentTopologyHelper, {
+  StaticCoincidentTopologyMethods,
+} from './Mapper/CoincidentTopologyHelper';
 
 interface ISliceToSubSlice {
   imageIndex: number;
@@ -23,7 +21,9 @@ export interface IImageArrayMapperInitialValues
   sliceToSubSliceMap: ISliceToSubSlice[];
 }
 
-export interface vtkImageArrayMapper extends vtkAbstractImageMapper {
+export interface vtkImageArrayMapper
+  extends vtkAbstractImageMapper,
+    CoincidentTopologyHelper {
   /**
    *
    * @param inputData set input as a vtkCollection of vtkImageData objects.
@@ -101,124 +101,6 @@ export interface vtkImageArrayMapper extends vtkAbstractImageMapper {
    */
   getSubSlice(slice?: number): number;
 
-  /**
-   *
-   */
-  getResolveCoincidentTopology(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyAsString(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyLineOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPointOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPolygonOffsetFaces(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPolygonOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyLineOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyPointOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyPolygonOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param resolveCoincidentTopology
-   * @default false
-   */
-  setResolveCoincidentTopology(resolveCoincidentTopology: boolean): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyLineOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyPointOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param value
-   */
-  setResolveCoincidentTopologyPolygonOffsetFaces(value: number): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyPolygonOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToDefault(): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToOff(): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToPolygonOffset(): boolean;
-
   /**
    * Set the slicing mode.
    * @param {Number} mode The slicing mode.
@@ -273,5 +155,5 @@ export declare const vtkImageArrayMapper: {
   newInstance: typeof newInstance;
   extend: typeof extend;
   SlicingMode: typeof SlicingMode;
-};
+} & StaticCoincidentTopologyMethods;
 export default vtkImageArrayMapper;

package/Rendering/Core/ImageCPRMapper.d.ts

@@ -9,11 +9,9 @@ import vtkImageData from './../../Common/DataModel/ImageData';
 import vtkPolyData from './../../Common/DataModel/PolyData';
 import vtkPolyLine from './../../Common/DataModel/PolyLine';
 import { ProjectionMode } from './ImageCPRMapper/Constants';
-
-interface ICoincidentTopology {
-  factor: number;
-  offset: number;
-}
+import CoincidentTopologyHelper, {
+  StaticCoincidentTopologyMethods,
+} from './Mapper/CoincidentTopologyHelper';
 
 type TOrientation = mat4 | mat3 | quat | vec3;
 
@@ -29,7 +27,9 @@ export interface IImageCPRMapperInitialValues
   normalDirection: vec3;
 }
 
-export interface vtkImageCPRMapper extends vtkAbstractMapper3D {
+export interface vtkImageCPRMapper
+  extends vtkAbstractMapper3D,
+    CoincidentTopologyHelper {
   /**
    * @returns the width of the image in model coordinates of the input volume
    */
@@ -307,124 +307,6 @@ export interface vtkImageCPRMapper extends vtkAbstractMapper3D {
    * @param imageData
    */
   setImageConnection(imageData: vtkOutputPort): void;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopology(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyAsString(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyLineOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPointOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPolygonOffsetFaces(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPolygonOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyLineOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyPointOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyPolygonOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param resolveCoincidentTopology
-   * @default false
-   */
-  setResolveCoincidentTopology(resolveCoincidentTopology: boolean): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyLineOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyPointOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param value
-   */
-  setResolveCoincidentTopologyPolygonOffsetFaces(value: number): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyPolygonOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToDefault(): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToOff(): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToPolygonOffset(): boolean;
 }
 
 /**
@@ -483,5 +365,5 @@ export function newInstance(
 export declare const vtkImageCPRMapper: {
   newInstance: typeof newInstance;
   extend: typeof extend;
-};
+} & StaticCoincidentTopologyMethods;
 export default vtkImageCPRMapper;

package/Rendering/Core/ImageMapper.d.ts

@@ -5,17 +5,15 @@ import vtkAbstractImageMapper, {
 import { Bounds, Nullable, Vector3 } from './../../types';
 import { SlicingMode } from './ImageMapper/Constants';
 import vtkImageData from './../../Common/DataModel/ImageData';
+import CoincidentTopologyHelper, {
+  StaticCoincidentTopologyMethods,
+} from './Mapper/CoincidentTopologyHelper';
 
 interface IClosestIJKAxis {
   ijkMode: SlicingMode;
   flip: boolean;
 }
 
-interface ICoincidentTopology {
-  factor: number;
-  offset: number;
-}
-
 export interface IImageMapperInitialValues
   extends IAbstractImageMapperInitialValues {
   closestIJKAxis?: IClosestIJKAxis;
@@ -23,7 +21,9 @@ export interface IImageMapperInitialValues
   sliceAtFocalPoint?: boolean;
 }
 
-export interface vtkImageMapper extends vtkAbstractImageMapper {
+export interface vtkImageMapper
+  extends vtkAbstractImageMapper,
+    CoincidentTopologyHelper {
   /**
    * Returns the IJK slice value from a world position or XYZ slice value
    * @param {Vector3 | number} [pos] World point or XYZ slice value
@@ -61,36 +61,6 @@ export interface vtkImageMapper extends vtkAbstractImageMapper {
    */
   getRenderToRectangle(): boolean;
 
-  /**
-   *
-   */
-  getResolveCoincidentTopology(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyAsString(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyLineOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPointOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPolygonOffsetFaces(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPolygonOffsetParameters(): ICoincidentTopology;
-
   /**
    * Return currently active image. By default, there can only be one image
    * for this mapper, if an input is set.
@@ -122,94 +92,6 @@ export interface vtkImageMapper extends vtkAbstractImageMapper {
    */
   setClosestIJKAxis(closestIJKAxis: IClosestIJKAxis): boolean;
 
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyLineOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyPointOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyPolygonOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param resolveCoincidentTopology
-   * @default false
-   */
-  setResolveCoincidentTopology(resolveCoincidentTopology: boolean): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyLineOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyPointOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param value
-   */
-  setResolveCoincidentTopologyPolygonOffsetFaces(value: number): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyPolygonOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToDefault(): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToOff(): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToPolygonOffset(): boolean;
-
   /**
    *
    * @param {Boolean} renderToRectangle
@@ -329,5 +211,5 @@ export declare const vtkImageMapper: {
   newInstance: typeof newInstance;
   extend: typeof extend;
   SlicingMode: typeof SlicingMode;
-};
+} & StaticCoincidentTopologyMethods;
 export default vtkImageMapper;

package/Rendering/Core/ImageResliceMapper.d.ts

@@ -6,11 +6,9 @@ import vtkPlane from './../../Common/DataModel/Plane';
 import vtkPolyData from './../../Common/DataModel/PolyData';
 import { Bounds, Nullable, Vector3 } from './../../types';
 import { SlabTypes } from './ImageResliceMapper/Constants';
-
-interface ICoincidentTopology {
-  factor: number;
-  offset: number;
-}
+import CoincidentTopologyHelper, {
+  StaticCoincidentTopologyMethods,
+} from './Mapper/CoincidentTopologyHelper';
 
 export interface IImageResliceMapperInitialValues
   extends IAbstractImageMapperInitialValues {
@@ -21,7 +19,9 @@ export interface IImageResliceMapperInitialValues
   slicePolyData?: vtkPolyData;
 }
 
-export interface vtkImageResliceMapper extends vtkAbstractImageMapper {
+export interface vtkImageResliceMapper
+  extends vtkAbstractImageMapper,
+    CoincidentTopologyHelper {
   /**
    * Get the bounds for this mapper as [xmin, xmax, ymin, ymax,zmin, zmax].
    * @return {Bounds} The bounds for the mapper.
@@ -33,36 +33,6 @@ export interface vtkImageResliceMapper extends vtkAbstractImageMapper {
    */
   getIsOpaque(): boolean;
 
-  /**
-   *
-   */
-  getResolveCoincidentTopology(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyAsString(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyLineOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPointOffsetParameters(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPolygonOffsetFaces(): ICoincidentTopology;
-
-  /**
-   *
-   */
-  getResolveCoincidentTopologyPolygonOffsetParameters(): ICoincidentTopology;
-
   /**
    *
    * Get the slab thickness in world space (mm).
@@ -93,94 +63,6 @@ export interface vtkImageResliceMapper extends vtkAbstractImageMapper {
    */
   getSlicePolyData(): vtkPolyData;
 
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyLineOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyPointOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setRelativeCoincidentTopologyPolygonOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param resolveCoincidentTopology
-   * @default false
-   */
-  setResolveCoincidentTopology(resolveCoincidentTopology: boolean): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyLineOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyPointOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   * @param value
-   */
-  setResolveCoincidentTopologyPolygonOffsetFaces(value: number): boolean;
-
-  /**
-   *
-   * @param {Number} factor
-   * @param {Number} offset
-   */
-  setResolveCoincidentTopologyPolygonOffsetParameters(
-    factor: number,
-    offset: number
-  ): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToDefault(): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToOff(): boolean;
-
-  /**
-   *
-   */
-  setResolveCoincidentTopologyToPolygonOffset(): boolean;
-
   /**
    *
    * Enable slab slicing mode and set the slab thickness in world space (mm).
@@ -266,5 +148,5 @@ export function newInstance(
 export declare const vtkImageResliceMapper: {
   newInstance: typeof newInstance;
   extend: typeof extend;
-};
+} & StaticCoincidentTopologyMethods;
 export default vtkImageResliceMapper;