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

package/Rendering/Core/VolumeMapper.js

@@ -1,12 +1,11 @@
 import { m as macro } from '../../macros2.js';
-import { H as createUninitializedBounds, E as clampValue, K as floor } from '../../Common/Core/Math/index.js';
 import Constants from './VolumeMapper/Constants.js';
 import vtkAbstractMapper3D from './AbstractMapper3D.js';
+import vtkBoundingBox from '../../Common/DataModel/BoundingBox.js';
 import vtkPiecewiseFunction from '../../Common/DataModel/PiecewiseFunction.js';
 
 const {
-  BlendMode,
-  FilterMode
+  BlendMode
 } = Constants;
 function createRadonTransferFunction(firstAbsorbentMaterialHounsfieldValue, firstAbsorbentMaterialAbsorption, maxAbsorbentMaterialHounsfieldValue, maxAbsorbentMaterialAbsorption, outputTransferFunction) {
   let ofun = null;
@@ -21,6 +20,7 @@ function createRadonTransferFunction(firstAbsorbentMaterialHounsfieldValue, firs
   ofun.addPoint(maxAbsorbentMaterialHounsfieldValue, maxAbsorbentMaterialAbsorption);
   return ofun;
 }
+const methodNamesMovedToVolumeProperties = ['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'];
 
 // ----------------------------------------------------------------------------
 // Static API
@@ -41,20 +41,12 @@ function vtkVolumeMapper(publicAPI, model) {
     ...publicAPI
   };
   publicAPI.getBounds = () => {
-    const input = publicAPI.getInputData();
-    if (!input) {
-      model.bounds = createUninitializedBounds();
-    } else {
-      if (!model.static) {
-        publicAPI.update();
-      }
-      model.bounds = input.getBounds();
+    if (!model.static) {
+      publicAPI.update();
     }
+    model.bounds = [...publicAPI.getInputData().getBounds()];
     return model.bounds;
   };
-  publicAPI.update = () => {
-    publicAPI.getInputData();
-  };
   publicAPI.setBlendModeToComposite = () => {
     publicAPI.setBlendMode(BlendMode.COMPOSITE_BLEND);
   };
@@ -74,26 +66,15 @@ function vtkVolumeMapper(publicAPI, model) {
     publicAPI.setBlendMode(BlendMode.RADON_TRANSFORM_BLEND);
   };
   publicAPI.getBlendModeAsString = () => macro.enumToString(BlendMode, model.blendMode);
-  publicAPI.setAverageIPScalarRange = (min, max) => {
-    console.warn('setAverageIPScalarRange is deprecated use setIpScalarRange');
-    publicAPI.setIpScalarRange(min, max);
-  };
-  publicAPI.getFilterModeAsString = () => macro.enumToString(FilterMode, model.filterMode);
-  publicAPI.setFilterModeToOff = () => {
-    publicAPI.setFilterMode(FilterMode.OFF);
-  };
-  publicAPI.setFilterModeToNormalized = () => {
-    publicAPI.setFilterMode(FilterMode.NORMALIZED);
-  };
-  publicAPI.setFilterModeToRaw = () => {
-    publicAPI.setFilterMode(FilterMode.RAW);
-  };
-  publicAPI.setGlobalIlluminationReach = gl => superClass.setGlobalIlluminationReach(clampValue(gl, 0.0, 1.0));
-  publicAPI.setVolumetricScatteringBlending = vsb => superClass.setVolumetricScatteringBlending(clampValue(vsb, 0.0, 1.0));
   publicAPI.setVolumeShadowSamplingDistFactor = vsdf => superClass.setVolumeShadowSamplingDistFactor(vsdf >= 1.0 ? vsdf : 1.0);
-  publicAPI.setAnisotropy = at => superClass.setAnisotropy(clampValue(at, -0.99, 0.99));
-  publicAPI.setLAOKernelSize = ks => superClass.setLAOKernelSize(floor(clampValue(ks, 1, 32)));
-  publicAPI.setLAOKernelRadius = kr => superClass.setLAOKernelRadius(kr >= 1 ? kr : 1);
+
+  // Instead of a "undefined is not a function" error, give more context and advice for these widely used methods
+  methodNamesMovedToVolumeProperties.forEach(removedMethodName => {
+    const removedMethod = () => {
+      throw new Error(`The method "volumeMapper.${removedMethodName}()" doesn't exist anymore. ` + `It is a rendering property that has been moved to the volume property. ` + `Replace your code with:\n` + `volumeActor.getProperty().${removedMethodName}()\n`);
+    };
+    publicAPI[removedMethodName] = removedMethod;
+  });
 }
 
 // ----------------------------------------------------------------------------
@@ -102,7 +83,7 @@ function vtkVolumeMapper(publicAPI, model) {
 
 // TODO: what values to use for averageIPScalarRange to get GLSL to use max / min values like [-Math.inf, Math.inf]?
 const defaultValues = initialValues => ({
-  bounds: [1, -1, 1, -1, 1, -1],
+  bounds: [...vtkBoundingBox.INIT_BOUNDS],
   sampleDistance: 1.0,
   imageSampleDistance: 1.0,
   maximumSamplesPerRay: 1000,
@@ -110,22 +91,7 @@ const defaultValues = initialValues => ({
   initialInteractionScale: 1.0,
   interactionSampleDistanceFactor: 1.0,
   blendMode: BlendMode.COMPOSITE_BLEND,
-  ipScalarRange: [-1000000.0, 1000000.0],
-  filterMode: FilterMode.OFF,
-  // ignored by WebGL so no behavior change
-  preferSizeOverAccuracy: false,
-  // Whether to use halfFloat representation of float, when it is inaccurate
-  computeNormalFromOpacity: false,
-  // volume shadow parameters
-  volumetricScatteringBlending: 0.0,
-  globalIlluminationReach: 0.0,
   volumeShadowSamplingDistFactor: 5.0,
-  anisotropy: 0.0,
-  // local ambient occlusion
-  localAmbientOcclusion: false,
-  LAOKernelSize: 15,
-  LAOKernelRadius: 7,
-  updatedExtents: [],
   colorTextureWidth: 1024,
   opacityTextureWidth: 1024,
   labelOutlineTextureWidth: 1024,
@@ -138,8 +104,7 @@ function extend(publicAPI, model) {
   let initialValues = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   Object.assign(model, defaultValues(initialValues));
   vtkAbstractMapper3D.extend(publicAPI, model, initialValues);
-  macro.setGet(publicAPI, model, ['sampleDistance', 'imageSampleDistance', 'maximumSamplesPerRay', 'autoAdjustSampleDistances', 'initialInteractionScale', 'interactionSampleDistanceFactor', 'blendMode', 'filterMode', 'preferSizeOverAccuracy', 'computeNormalFromOpacity', 'volumetricScatteringBlending', 'globalIlluminationReach', 'volumeShadowSamplingDistFactor', 'anisotropy', 'localAmbientOcclusion', 'LAOKernelSize', 'LAOKernelRadius', 'updatedExtents', 'colorTextureWidth', 'opacityTextureWidth', 'labelOutlineTextureWidth']);
-  macro.setGetArray(publicAPI, model, ['ipScalarRange'], 2);
+  macro.setGet(publicAPI, model, ['sampleDistance', 'imageSampleDistance', 'maximumSamplesPerRay', 'autoAdjustSampleDistances', 'initialInteractionScale', 'interactionSampleDistanceFactor', 'blendMode', 'volumeShadowSamplingDistFactor', 'colorTextureWidth', 'opacityTextureWidth', 'labelOutlineTextureWidth']);
   macro.event(publicAPI, model, 'lightingActivated');
 
   // Object methods

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

@@ -10,9 +10,7 @@ export declare enum OpacityMode {
 }
 
 export declare enum ColorMixPreset {
-  // Add a `//VTK::CustomColorMix` tag to the Fragment shader
-  // See usage in file `testColorMix` and in function `setColorMixPreset`
-  CUSTOM = 0,
+  DEFAULT = 0,
 
   // Two components preset
   // Out color: sum of colors weighted by opacity
@@ -23,11 +21,22 @@ export declare enum ColorMixPreset {
   // Out color: color of the first component, colorized by second component with an intensity that is the second component's opacity
   // Out opacity: opacity of the first component
   COLORIZE = 2,
+
+  // Add a `//VTK::CustomColorMix` tag to the Fragment shader
+  // See usage in file `testColorMix` and in function `setColorMixPreset`
+  CUSTOM = 3,
+}
+
+export declare enum FilterMode {
+  OFF = 0,
+  NORMALIZED = 1,
+  RAW = 2,
 }
 
 declare const _default: {
   InterpolationType: typeof InterpolationType;
   OpacityMode: typeof OpacityMode;
   ColorMixPreset: typeof ColorMixPreset;
+  FilterMode: typeof FilterMode;
 };
 export default _default;

package/Rendering/Core/VolumeProperty/Constants.js

@@ -8,14 +8,21 @@ const OpacityMode = {
   PROPORTIONAL: 1
 };
 const ColorMixPreset = {
-  CUSTOM: 0,
+  DEFAULT: 0,
   ADDITIVE: 1,
-  COLORIZE: 2
+  COLORIZE: 2,
+  CUSTOM: 3
+};
+const FilterMode = {
+  OFF: 0,
+  NORMALIZED: 1,
+  RAW: 2
 };
 var Constants = {
   InterpolationType,
   OpacityMode,
-  ColorMixPreset
+  ColorMixPreset,
+  FilterMode
 };
 
-export { ColorMixPreset, InterpolationType, OpacityMode, Constants as default };
+export { ColorMixPreset, FilterMode, InterpolationType, OpacityMode, Constants as default };

package/Rendering/Core/VolumeProperty.d.ts

@@ -1,6 +1,6 @@
 import vtkPiecewiseFunction from './../../Common/DataModel/PiecewiseFunction';
 import { vtkObject } from './../../interfaces';
-import { Nullable } from './../../types';
+import { Extent, Nullable } from './../../types';
 import vtkColorTransferFunction from './ColorTransferFunction';
 import { ColorMixPreset, InterpolationType, OpacityMode } from './VolumeProperty/Constants';
 
@@ -13,6 +13,7 @@ export interface IVolumePropertyInitialValues {
   specularPower?: number;
   useLabelOutline?: boolean;
   labelOutlineThickness?: number | number[];
+  colorMixPreset?: ColorMixPreset;
 }
 
 export interface vtkVolumeProperty extends vtkObject {
@@ -71,7 +72,7 @@ export interface vtkVolumeProperty extends vtkObject {
   /**
    *
    */
-  getColorMixPreset(): Nullable<ColorMixPreset>;
+  getColorMixPreset(): ColorMixPreset;
 
   /**
    *
@@ -194,7 +195,7 @@ export interface vtkVolumeProperty extends vtkObject {
 
   /**
    * Set the color mix code to a preset value
-   * Set to null to use no preset
+   * Defaults to ColorMixPreset.DEFAULT
    * See the test `testColorMix` for an example on how to use this preset.
    *
    * If set to `CUSTOM`, a tag `//VTK::CustomColorMix` is made available to the
@@ -202,9 +203,9 @@ export interface vtkVolumeProperty extends vtkObject {
    * will be used to mix the colors from each component.
    * Each component is available as a rgba vec4: `comp0`, `comp1`...
    * There are other useful functions or variable available. To find them,
-   * see `//VTK::CustomComponentsColorMix::Impl` tag in `vtkVolumeFS.glsl`.
+   * see `//VTK::CustomColorMix` tag in `vtkVolumeFS.glsl`.
    */
-  setColorMixPreset(preset: Nullable<ColorMixPreset>): boolean;
+  setColorMixPreset(preset: ColorMixPreset): boolean;
 
   /**
    * Does the data have independent components, or do some define color only?
@@ -370,6 +371,140 @@ export interface vtkVolumeProperty extends vtkObject {
    * Get the interpolation type for sampling a volume as a string.
    */
   getInterpolationTypeAsString(): string;
+
+  /**
+   *
+   */
+  getAverageIPScalarRange(): Range;
+
+  /**
+   *
+   */
+  getAverageIPScalarRangeByReference(): Range;
+
+  /**
+   * Get the blending coefficient that interpolates between surface and volume rendering
+   * @default 0.0
+   */
+  getVolumetricScatteringBlending(): number;
+
+  /**
+   * Get the global illumination reach of volume shadow
+   * @default 0.0
+   */
+  getGlobalIlluminationReach(): number;
+
+  /**
+   * Get anisotropy of volume shadow scatter
+   * @default 0.0
+   */
+  getAnisotropy(): number;
+
+  /**
+   * Get local ambient occlusion flag
+   * @default false
+   */
+  getLocalAmbientOcclusion(): boolean;
+
+  /**
+   * Get kernel size for local ambient occlusion
+   * @default 15
+   */
+  getLAOKernelSize(): number;
+
+  /**
+   * Get kernel radius for local ambient occlusion
+   * @default 7
+   */
+  getLAOKernelRadius(): number;
+
+  /**
+   *
+   * @param x
+   * @param y
+   */
+  setAverageIPScalarRange(x: number, y: number): boolean;
+
+  /**
+   *
+   * @param {Range} averageIPScalarRange
+   */
+  setAverageIPScalarRangeFrom(averageIPScalarRange: Range): boolean;
+
+  /**
+   * Set the normal computation to be dependent on the transfer function.
+   * By default, the mapper relies on the scalar gradient for computing normals at sample locations
+   * for lighting calculations. This is an approximation and can lead to inaccurate results.
+   * When enabled, this property makes the mapper compute normals based on the accumulated opacity
+   * at sample locations. This can generate a more accurate representation of edge structures in the
+   * data but adds an overhead and drops frame rate.
+   * @param computeNormalFromOpacity
+   */
+  setComputeNormalFromOpacity(computeNormalFromOpacity: boolean): boolean;
+
+  /**
+   * Set the blending coefficient that determines the interpolation between surface and volume rendering.
+   * Default value of 0.0 means shadow effect is computed with phong model.
+   * Value of 1.0 means shadow is created by volume occlusion.
+   * @param volumeScatterBlendCoef
+   */
+  setVolumetricScatteringBlending(volumeScatterBlendCoef: number): void;
+
+  /**
+   * Set the global illumination reach of volume shadow. This function is only effective when volumeScatterBlendCoef is greater than 0.
+   * Default value of 0.0 means only the neighboring voxel is considered when creating global shadow.
+   * Value of 1.0 means the shadow ray traverses through the entire volume.
+   * @param globalIlluminationReach
+   */
+  setGlobalIlluminationReach(globalIlluminationReach: number): void;
+
+  /**
+   * Set anisotropy of volume shadow scatter. This function is only effective when volumeScatterBlendCoef is greater than 0.
+   * Default value of 0.0 means light scatters uniformly in all directions.
+   * Value of -1.0 means light scatters backward, value of 1.0 means light scatters forward.
+   * @param anisotropy
+   */
+  setAnisotropy(anisotropy: number): void;
+
+  /**
+   * Set whether to turn on local ambient occlusion (LAO). LAO is only effective if shading is on and volumeScatterBlendCoef is set to 0.
+   * LAO effect is added to ambient lighting, so the ambient component of the actor needs to be great than 0.
+   * @param localAmbientOcclusion
+   */
+  setLocalAmbientOcclusion(localAmbientOcclusion: boolean): void;
+
+  /**
+   * Set kernel size for local ambient occlusion. It specifies the number of rays that are randomly sampled in the hemisphere.
+   * Value is clipped between 1 and 32.
+   * @param LAOKernelSize
+   */
+  setLAOKernelSize(LAOKernelSize: number): void;
+
+  /**
+   * Set kernel radius for local ambient occlusion. It specifies the number of samples that are considered on each random ray.
+   * Value must be greater than or equal to 1.
+   * @param LAOKernelRadius
+   */
+  setLAOKernelRadius(LAOKernelRadius: number): void;
+
+  /**
+   * Informs the mapper to only update the specified extents at the next render.
+   *
+   * If there are zero extents, the mapper updates the entire volume texture.
+   * Otherwise, the mapper will only update the texture by the specified extents
+   * during the next render call.
+   *
+   * This array is cleared after a successful render.
+   * @param extents
+   */
+  setUpdatedExtents(extents: Extent[]): boolean;
+
+  /**
+   * Retrieves the updated extents.
+   *
+   * This array is cleared after every successful render.
+   */
+  getUpdatedExtents(): Extent[];
 }
 
 /**

package/Rendering/Core/VolumeProperty.js

@@ -1,11 +1,14 @@
 import { m as macro } from '../../macros2.js';
+import { E as clampValue, K as floor } from '../../Common/Core/Math/index.js';
 import vtkColorTransferFunction from './ColorTransferFunction.js';
 import vtkPiecewiseFunction from '../../Common/DataModel/PiecewiseFunction.js';
 import Constants from './VolumeProperty/Constants.js';
 
 const {
   InterpolationType,
-  OpacityMode
+  OpacityMode,
+  FilterMode,
+  ColorMixPreset
 } = Constants;
 const {
   vtkErrorMacro
@@ -19,6 +22,9 @@ const VTK_MAX_VRCOMP = 4;
 function vtkVolumeProperty(publicAPI, model) {
   // Set our className
   model.classHierarchy.push('vtkVolumeProperty');
+  const superClass = {
+    ...publicAPI
+  };
   publicAPI.getMTime = () => {
     let mTime = model.mtime;
     let time;
@@ -197,14 +203,33 @@ function vtkVolumeProperty(publicAPI, model) {
     const cap = macro.capitalize(val);
     publicAPI[`get${cap}`] = index => model.componentData[index][`${val}`];
   });
+  publicAPI.setAverageIPScalarRange = (min, max) => {
+    console.warn('setAverageIPScalarRange is deprecated use setIpScalarRange');
+    publicAPI.setIpScalarRange(min, max);
+  };
+  publicAPI.getFilterModeAsString = () => macro.enumToString(FilterMode, model.filterMode);
+  publicAPI.setFilterModeToOff = () => {
+    publicAPI.setFilterMode(FilterMode.OFF);
+  };
+  publicAPI.setFilterModeToNormalized = () => {
+    publicAPI.setFilterMode(FilterMode.NORMALIZED);
+  };
+  publicAPI.setFilterModeToRaw = () => {
+    publicAPI.setFilterMode(FilterMode.RAW);
+  };
+  publicAPI.setGlobalIlluminationReach = gl => superClass.setGlobalIlluminationReach(clampValue(gl, 0.0, 1.0));
+  publicAPI.setVolumetricScatteringBlending = vsb => superClass.setVolumetricScatteringBlending(clampValue(vsb, 0.0, 1.0));
+  publicAPI.setAnisotropy = at => superClass.setAnisotropy(clampValue(at, -0.99, 0.99));
+  publicAPI.setLAOKernelSize = ks => superClass.setLAOKernelSize(floor(clampValue(ks, 1, 32)));
+  publicAPI.setLAOKernelRadius = kr => superClass.setLAOKernelRadius(kr >= 1 ? kr : 1);
 }
 
 // ----------------------------------------------------------------------------
 // Object factory
 // ----------------------------------------------------------------------------
 
-const DEFAULT_VALUES = {
-  colorMixPreset: null,
+const defaultValues = initialValues => ({
+  colorMixPreset: ColorMixPreset.DEFAULT,
   independentComponents: true,
   interpolationType: InterpolationType.FAST_LINEAR,
   shade: false,
@@ -214,14 +239,31 @@ const DEFAULT_VALUES = {
   specularPower: 10.0,
   useLabelOutline: false,
   labelOutlineThickness: [1],
-  labelOutlineOpacity: 1.0
-};
+  labelOutlineOpacity: 1.0,
+  // Properties moved from volume mapper
+  ipScalarRange: [-1000000.0, 1000000.0],
+  filterMode: FilterMode.OFF,
+  // ignored by WebGL so no behavior change
+  preferSizeOverAccuracy: false,
+  // Whether to use halfFloat representation of float, when it is inaccurate
+  computeNormalFromOpacity: false,
+  // volume shadow parameters
+  volumetricScatteringBlending: 0.0,
+  globalIlluminationReach: 0.0,
+  anisotropy: 0.0,
+  // local ambient occlusion
+  localAmbientOcclusion: false,
+  LAOKernelSize: 15,
+  LAOKernelRadius: 7,
+  updatedExtents: [],
+  ...initialValues
+});
 
 // ----------------------------------------------------------------------------
 
 function extend(publicAPI, model) {
   let initialValues = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-  Object.assign(model, DEFAULT_VALUES, initialValues);
+  Object.assign(model, defaultValues(initialValues));
 
   // Build VTK API
   macro.obj(publicAPI, model);
@@ -245,7 +287,12 @@ function extend(publicAPI, model) {
       });
     }
   }
-  macro.setGet(publicAPI, model, ['colorMixPreset', 'independentComponents', 'interpolationType', 'shade', 'ambient', 'diffuse', 'specular', 'specularPower', 'useLabelOutline', 'labelOutlineOpacity']);
+  macro.setGet(publicAPI, model, ['colorMixPreset', 'independentComponents', 'interpolationType', 'shade', 'ambient', 'diffuse', 'specular', 'specularPower', 'useLabelOutline', 'labelOutlineOpacity',
+  // Properties moved from volume mapper
+  'filterMode', 'preferSizeOverAccuracy', 'computeNormalFromOpacity', 'volumetricScatteringBlending', 'globalIlluminationReach', 'anisotropy', 'localAmbientOcclusion', 'LAOKernelSize', 'LAOKernelRadius', 'updatedExtents']);
+
+  // Property moved from volume mapper
+  macro.setGetArray(publicAPI, model, ['ipScalarRange'], 2);
   macro.setGetArray(publicAPI, model, ['labelOutlineThickness']);
 
   // Object methods

package/Rendering/OpenGL/Framebuffer.js

@@ -162,7 +162,13 @@ function vtkFramebuffer(publicAPI, model) {
     texture.setOpenGLRenderWindow(model._openGLRenderWindow);
     texture.setMinificationFilter(Filter.LINEAR);
     texture.setMagnificationFilter(Filter.LINEAR);
-    texture.create2DFromRaw(model.glFramebuffer.width, model.glFramebuffer.height, 4, VtkDataTypes.UNSIGNED_CHAR, null);
+    texture.create2DFromRaw({
+      width: model.glFramebuffer.width,
+      height: model.glFramebuffer.height,
+      numComps: 4,
+      dataType: VtkDataTypes.UNSIGNED_CHAR,
+      data: null
+    });
     publicAPI.setColorBuffer(texture);
 
     // for now do not count on having a depth buffer texture