@kitware/vtk.js 30.6.0 → 30.6.1

package/Rendering/Core/VolumeProperty.d.ts

@@ -4,368 +4,372 @@ import { Nullable } from './../../types';
 import vtkColorTransferFunction from './ColorTransferFunction';
 import { ColorMixPreset, InterpolationType, OpacityMode } from './VolumeProperty/Constants';
 
-export interface IVolumePropertyInitialValues  {
-	independentComponents?: boolean;
-	shade?: boolean;
-	ambient?: number;
-	diffuse?: number;
-	specular?: number;
-	specularPower?: number;
-	useLabelOutline?: boolean;
-	labelOutlineThickness?: number | number[];
+export interface IVolumePropertyInitialValues {
+  independentComponents?: boolean;
+  shade?: boolean;
+  ambient?: number;
+  diffuse?: number;
+  specular?: number;
+  specularPower?: number;
+  useLabelOutline?: boolean;
+  labelOutlineThickness?: number | number[];
 }
 
 export interface vtkVolumeProperty extends vtkObject {
-
-	/**
-	 * Get the ambient lighting coefficient.
-	 */
-	getAmbient(): number;
-
-	/**
-	 * Return the `Modified Time` which is a monotonic increasing integer
-	 * global for all vtkObjects.
-	 *
-	 * This allow to solve a question such as:
-	 *  - Is that object created/modified after another one?
-	 *  - Do I need to re-execute this filter, or not? ...
-	 *
-	 * @return {Number} the global modified time.
-	 */
-	getMTime(): number;
-
-	/**
-	 *
-	 * @param {Number} index
-	 */
-	getColorChannels(index: number): number;
-
-	/**
-	 * Get the diffuse lighting coefficient.
-	 */
-	getDiffuse(): number;
-
-	/**
-	 *
-	 * @param {Number} index
-	 */
-	getGradientOpacityMaximumOpacity(index: number): number;
-
-	/**
-	 *
-	 * @param {Number} index
-	 */
-	getGradientOpacityMaximumValue(index: number): number;
-
-	/**
-	 *
-	 * @param {Number} index
-	 */
-	getGradientOpacityMinimumOpacity(index: number): number;
-
-	/**
-	 *
-	 * @param {Number} index
-	 */
-	getGradientOpacityMinimumValue(index: number): number;
-
-	/**
-	 * 
-	 */
-	getColorMixPreset(): Nullable<ColorMixPreset>;
-
-	/**
-	 *
-	 */
-	getIndependentComponents(): boolean;
-
-	/**
-	 * Get the unit distance on which the scalar opacity transfer function is defined.
-	 * @param {Number} index
-	 */
-	getScalarOpacityUnitDistance(index: number): number;
-
-	/**
-	 * Get the currently set gray transfer function. Create one if none set.
-	 * @param {Number} index
-	 */
-	getGrayTransferFunction(index: number): vtkPiecewiseFunction;
-
-	/**
-	 *
-	 * @default FRACTIONAL
-	 */
-	getOpacityMode(index: number): OpacityMode;
-
-	/**
-	 * gets the label outline thickness 
-	 */
-	getLabelOutlineThickness(): number;
-
-	/**
-	 * Get the currently set RGB transfer function. Create one if none set.
-	 * @param {Number} index 
-	 */
-	getRGBTransferFunction(index: number): vtkColorTransferFunction;
-
-	/**
-	 * Get the scalar opacity transfer function. Create one if none set.
-	 * @param {Number} index 
-	 */
-	getScalarOpacity(index: number): vtkPiecewiseFunction;
-
-	/**
-	 * Get the shading of a volume.
-	 */
-	getShade(): boolean;
-
-	/**
-	 *
-	 */
-	getSpecular(): number;
-
-	/**
-	 * Get the specular power.
-	 */
-	getSpecularPower(): number;
-
-	/**
-	 *
-	 * @param {Number} index 
-	 */
-	getUseGradientOpacity(index: number): boolean;
-
-	/**
-	 * @see setForceNearestInterpolation
-	 * @param {Number} index
-	 */
-	getForceNearestInterpolation(index: number): boolean;
-
-	/**
-	 *
-	 */
-	getUseLabelOutline(): boolean;
-
-	/**
-	 * Set the ambient lighting coefficient.
-	 * @param {Number} ambient The ambient lighting coefficient.
-	 */
-	setAmbient(ambient: number): boolean;
-
-	/**
-	 * Set the diffuse lighting coefficient.
-	 * @param {Number} diffuse The diffuse lighting coefficient.
-	 */
-	setDiffuse(diffuse: number): boolean;
-
-	/**
-	 *
-	 * @param {Number} index 
-	 * @param {Number} value 
-	 */
-	setGradientOpacityMaximumOpacity(index: number, value: number): boolean;
-
-	/**
-	 *
-	 * @param {Number} index 
-	 * @param {Number} value 
-	 */
-	setGradientOpacityMaximumValue(index: number, value: number): boolean;
-
-	/**
-	 *
-	 * @param {Number} index 
-	 * @param {Number} value 
-	 */
-	setGradientOpacityMinimumOpacity(index: number, value: number): boolean;
-
-	/**
-	 *
-	 * @param {Number} index 
-	 * @param {Number} value 
-	 */
-	setGradientOpacityMinimumValue(index: number, value: number): boolean;
-
-	/**
-	 * Set the color of a volume to a gray transfer function
-	 * @param {Number} index 
-	 * @param {vtkPiecewiseFunction} func 
-	 */
-	setGrayTransferFunction(index: number, func: vtkPiecewiseFunction): boolean;
-
-	/**
-	 * Set the color mix code to a preset value
-	 * Set to null to use no preset
-	 * 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
-	 * user who can user shader replacements to put its own code. The given code
-	 * 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`.
-	 */
-	setColorMixPreset(preset: Nullable<ColorMixPreset>): boolean;
-
-	/**
-	 * Does the data have independent components, or do some define color only?
-	 * If IndependentComponents is On (the default) then each component will be
-	 * independently passed through a lookup table to determine RGBA, shaded.
-	 *
-	 * Some volume Mappers can handle 1 to 4 component unsigned char or unsigned
-	 * short data (see each mapper header file to determine functionality). If
-	 * IndependentComponents is Off, then you must have either 2 or 4 component
-	 * data. For 2 component data, the first is passed through the first color
-	 * transfer function and the second component is passed through the first
-	 * scalar opacity (and gradient opacity) transfer function. Normals will be
-	 * generated off of the second component. When using gradient based opacity
-	 * modulation, the gradients are computed off of the second component. For 4
-	 * component data, the first three will directly represent RGB (no lookup
-	 * table). The fourth component will be passed through the first scalar
-	 * opacity transfer function for opacity and first gradient opacity transfer
-	 * function for gradient based opacity modulation. Normals will be generated
-	 * from the fourth component. When using gradient based opacity modulation,
-	 * the gradients are computed off of the fourth component.
-	 * @param {Boolean} independentComponents
-	 */
-	setIndependentComponents(independentComponents: boolean): boolean;
-
-	/**
-	 * It will set the label outline thickness for the labelmaps. It can accept
-	 * a single number or an array of numbers. If a single number is provided,
-	 * it will be used for all the segments. If an array is provided, it indicates
-	 * the thickness for each segment index. For instance if you have a labelmap
-	 * with 3 segments (0: background 1: liver 2: tumor), you can set the thickness
-	 * to [2,4] to have a thicker outline for the tumor (thickness 4). It should be 
-	 * noted that the thickness is in pixel and also the first array value will 
-	 * control the default thickness for all labels when 0 or not specified.
-	 * 
-	 * @param {Number | Number[]} labelOutlineThickness
-	 */
-	setLabelOutlineThickness(labelOutlineThickness: number | number[]): boolean;
-
-
-	/**
-	 *
-	 * @param {Number} index 
-	 * @param {Number} value 
-	 */
-	setOpacityMode(index: number, value: number): boolean;
-
-	/**
-	 * Set the unit distance on which the scalar opacity transfer function is
-	 * defined.
-	 * @param {Number} index 
-	 * @param {Number} value 
-	 */
-	setScalarOpacityUnitDistance(index: number, value: number): boolean;
-
-	/**
-	 * Set the shading of a volume.
-	 * 
-	 * If shading is turned off, then the mapper for the volume will not perform
-	 * shading calculations. If shading is turned on, the mapper may perform
-	 * shading calculations - in some cases shading does not apply (for example,
-	 * in a maximum intensity projection) and therefore shading will not be
-	 * performed even if this flag is on. For a compositing type of mapper,
-	 * turning shading off is generally the same as setting ambient=1,
-	 * diffuse=0, specular=0. Shading can be independently turned on/off per
-	 * component.
-	 * @param {Boolean} shade
-	 */
-	setShade(shade: boolean): boolean;
-
-	/**
-	 *
-	 * @param {Number} specular
-	 */
-	setSpecular(specular: number): boolean;
-
-	/**
-	 * Set the specular power.
-	 * @param {Number} specularPower
-	 */
-	setSpecularPower(specularPower: number): boolean;
-
-	/**
-	 *
-	 * @param {Number} index 
-	 * @param {Boolean} value 
-	 */
-	setUseGradientOpacity(index: number, value: boolean): boolean;
-
-	/**
-	 *
-	 * @param {Boolean} useLabelOutline 
-	 */
-	setUseLabelOutline(useLabelOutline: boolean): boolean;
-
-	/**
-	 * Set the color of a volume to an RGB transfer function
-	 * @param {Number} index 
-	 * @param {vtkColorTransferFunction} func 
-	 */
-	setRGBTransferFunction(index: number, func?: Nullable<vtkColorTransferFunction>): boolean;
-
-	/**
-	 * Set the scalar opacity of a volume to a transfer function
-	 * @param {Number} index 
-	 * @param {vtkPiecewiseFunction} func 
-	 */
-	setScalarOpacity(index: number, func?: Nullable<vtkPiecewiseFunction>): boolean;
-
-	/**
-	 * Set the scalar component weights.
-	 * @param {Number} index 
-	 * @param {Number} value 
-	 */
-	setComponentWeight(index: number, value: number): boolean;
-
-	/**
-	 * Force the nearest neighbor interpolation of one or more of the components
-	 * The interpolation for the rest of the volume is set using `setInterpolationType`
-	 * @see setInterpolationType
-	 * @param {Number} index
-	 * @param {Boolean} value
-	 */
-	setForceNearestInterpolation(index: number, value: boolean): boolean;
-
-	/**
-	 * Get the scalar component weights.
-	 * @param {Number} index 
-	 */
-	getComponentWeight(index: number): number;
-
-	/**
-	 * Set the interpolation type for sampling a volume.
-	 * @param {InterpolationType} interpolationType 
-	 */
-	setInterpolationType(interpolationType: InterpolationType): boolean;
-
-	/**
-	 * Set interpolation type to NEAREST
-	 */
-	setInterpolationTypeToNearest(): boolean;
-
-	/**
-	 * Set interpolation type to LINEAR
-	 */
-	setInterpolationTypeToLinear(): boolean;
-
-	/**
-	 * Set interpolation type to FAST_LINEAR
-	 */
-	setInterpolationTypeToFastLinear(): boolean;
-
-	/**
-	 * Get the interpolation type for sampling a volume.
-	 */
-	getInterpolationType(): InterpolationType;
-
-	/**
-	 * Get the interpolation type for sampling a volume as a string.
-	 */
-	getInterpolationTypeAsString(): string;
+  /**
+   * Get the ambient lighting coefficient.
+   */
+  getAmbient(): number;
+
+  /**
+   * Return the `Modified Time` which is a monotonic increasing integer
+   * global for all vtkObjects.
+   *
+   * This allow to solve a question such as:
+   *  - Is that object created/modified after another one?
+   *  - Do I need to re-execute this filter, or not? ...
+   *
+   * @return {Number} the global modified time.
+   */
+  getMTime(): number;
+
+  /**
+   *
+   * @param {Number} index
+   */
+  getColorChannels(index: number): number;
+
+  /**
+   * Get the diffuse lighting coefficient.
+   */
+  getDiffuse(): number;
+
+  /**
+   *
+   * @param {Number} index
+   */
+  getGradientOpacityMaximumOpacity(index: number): number;
+
+  /**
+   *
+   * @param {Number} index
+   */
+  getGradientOpacityMaximumValue(index: number): number;
+
+  /**
+   *
+   * @param {Number} index
+   */
+  getGradientOpacityMinimumOpacity(index: number): number;
+
+  /**
+   *
+   * @param {Number} index
+   */
+  getGradientOpacityMinimumValue(index: number): number;
+
+  /**
+   *
+   */
+  getColorMixPreset(): Nullable<ColorMixPreset>;
+
+  /**
+   *
+   */
+  getIndependentComponents(): boolean;
+
+  /**
+   * Get the unit distance on which the scalar opacity transfer function is defined.
+   * @param {Number} index
+   */
+  getScalarOpacityUnitDistance(index: number): number;
+
+  /**
+   * Get the currently set gray transfer function. Create one if none set.
+   * @param {Number} index
+   */
+  getGrayTransferFunction(index: number): vtkPiecewiseFunction;
+
+  /**
+   *
+   * @default FRACTIONAL
+   */
+  getOpacityMode(index: number): OpacityMode;
+
+  /**
+   * gets the label outline thickness
+   */
+  getLabelOutlineThickness(): number;
+
+  /**
+   * Get the currently set RGB transfer function. Create one if none set.
+   * @param {Number} index
+   */
+  getRGBTransferFunction(index: number): vtkColorTransferFunction;
+
+  /**
+   * Get the scalar opacity transfer function. Create one if none set.
+   * @param {Number} index
+   */
+  getScalarOpacity(index: number): vtkPiecewiseFunction;
+
+  /**
+   * Get the shading of a volume.
+   */
+  getShade(): boolean;
+
+  /**
+   *
+   */
+  getSpecular(): number;
+
+  /**
+   * Get the specular power.
+   */
+  getSpecularPower(): number;
+
+  /**
+   *
+   * @param {Number} index
+   */
+  getUseGradientOpacity(index: number): boolean;
+
+  /**
+   * @see setForceNearestInterpolation
+   * @param {Number} index
+   */
+  getForceNearestInterpolation(index: number): boolean;
+
+  /**
+   *
+   */
+  getUseLabelOutline(): boolean;
+
+  /**
+   * Set the ambient lighting coefficient.
+   * @param {Number} ambient The ambient lighting coefficient.
+   */
+  setAmbient(ambient: number): boolean;
+
+  /**
+   * Set the diffuse lighting coefficient.
+   * @param {Number} diffuse The diffuse lighting coefficient.
+   */
+  setDiffuse(diffuse: number): boolean;
+
+  /**
+   *
+   * @param {Number} index
+   * @param {Number} value
+   */
+  setGradientOpacityMaximumOpacity(index: number, value: number): boolean;
+
+  /**
+   *
+   * @param {Number} index
+   * @param {Number} value
+   */
+  setGradientOpacityMaximumValue(index: number, value: number): boolean;
+
+  /**
+   *
+   * @param {Number} index
+   * @param {Number} value
+   */
+  setGradientOpacityMinimumOpacity(index: number, value: number): boolean;
+
+  /**
+   *
+   * @param {Number} index
+   * @param {Number} value
+   */
+  setGradientOpacityMinimumValue(index: number, value: number): boolean;
+
+  /**
+   * Set the color of a volume to a gray transfer function
+   * @param {Number} index
+   * @param {vtkPiecewiseFunction} func
+   */
+  setGrayTransferFunction(index: number, func: vtkPiecewiseFunction): boolean;
+
+  /**
+   * Set the color mix code to a preset value
+   * Set to null to use no preset
+   * 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
+   * user who can user shader replacements to put its own code. The given code
+   * 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`.
+   */
+  setColorMixPreset(preset: Nullable<ColorMixPreset>): boolean;
+
+  /**
+   * Does the data have independent components, or do some define color only?
+   * If IndependentComponents is On (the default) then each component will be
+   * independently passed through a lookup table to determine RGBA, shaded.
+   *
+   * Some volume Mappers can handle 1 to 4 component unsigned char or unsigned
+   * short data (see each mapper header file to determine functionality). If
+   * IndependentComponents is Off, then you must have either 2 or 4 component
+   * data. For 2 component data, the first is passed through the first color
+   * transfer function and the second component is passed through the first
+   * scalar opacity (and gradient opacity) transfer function. Normals will be
+   * generated off of the second component. When using gradient based opacity
+   * modulation, the gradients are computed off of the second component. For 4
+   * component data, the first three will directly represent RGB (no lookup
+   * table). The fourth component will be passed through the first scalar
+   * opacity transfer function for opacity and first gradient opacity transfer
+   * function for gradient based opacity modulation. Normals will be generated
+   * from the fourth component. When using gradient based opacity modulation,
+   * the gradients are computed off of the fourth component.
+   * @param {Boolean} independentComponents
+   */
+  setIndependentComponents(independentComponents: boolean): boolean;
+
+  /**
+   * It will set the label outline thickness for the labelmaps. It can accept
+   * a single number or an array of numbers. If a single number is provided,
+   * it will be used for all the segments. If an array is provided, it indicates
+   * the thickness for each segment index. For instance if you have a labelmap
+   * with 3 segments (0: background 1: liver 2: tumor), you can set the thickness
+   * to [2,4] to have a thicker outline for the tumor (thickness 4). It should be
+   * noted that the thickness is in pixel and also the first array value will
+   * control the default thickness for all labels when 0 or not specified.
+   *
+   * @param {Number | Number[]} labelOutlineThickness
+   */
+  setLabelOutlineThickness(labelOutlineThickness: number | number[]): boolean;
+
+  /**
+   *
+   * @param {Number} index
+   * @param {Number} value
+   */
+  setOpacityMode(index: number, value: number): boolean;
+
+  /**
+   * Set the unit distance on which the scalar opacity transfer function is
+   * defined.
+   * @param {Number} index
+   * @param {Number} value
+   */
+  setScalarOpacityUnitDistance(index: number, value: number): boolean;
+
+  /**
+   * Set the shading of a volume.
+   *
+   * If shading is turned off, then the mapper for the volume will not perform
+   * shading calculations. If shading is turned on, the mapper may perform
+   * shading calculations - in some cases shading does not apply (for example,
+   * in a maximum intensity projection) and therefore shading will not be
+   * performed even if this flag is on. For a compositing type of mapper,
+   * turning shading off is generally the same as setting ambient=1,
+   * diffuse=0, specular=0. Shading can be independently turned on/off per
+   * component.
+   * @param {Boolean} shade
+   */
+  setShade(shade: boolean): boolean;
+
+  /**
+   *
+   * @param {Number} specular
+   */
+  setSpecular(specular: number): boolean;
+
+  /**
+   * Set the specular power.
+   * @param {Number} specularPower
+   */
+  setSpecularPower(specularPower: number): boolean;
+
+  /**
+   *
+   * @param {Number} index
+   * @param {Boolean} value
+   */
+  setUseGradientOpacity(index: number, value: boolean): boolean;
+
+  /**
+   *
+   * @param {Boolean} useLabelOutline
+   */
+  setUseLabelOutline(useLabelOutline: boolean): boolean;
+
+  /**
+   * Set the color of a volume to an RGB transfer function
+   * @param {Number} index
+   * @param {vtkColorTransferFunction} func
+   */
+  setRGBTransferFunction(
+    index: number,
+    func?: Nullable<vtkColorTransferFunction>
+  ): boolean;
+
+  /**
+   * Set the scalar opacity of a volume to a transfer function
+   * @param {Number} index
+   * @param {vtkPiecewiseFunction} func
+   */
+  setScalarOpacity(
+    index: number,
+    func?: Nullable<vtkPiecewiseFunction>
+  ): boolean;
+
+  /**
+   * Set the scalar component weights.
+   * @param {Number} index
+   * @param {Number} value
+   */
+  setComponentWeight(index: number, value: number): boolean;
+
+  /**
+   * Force the nearest neighbor interpolation of one or more of the components
+   * The interpolation for the rest of the volume is set using `setInterpolationType`
+   * @see setInterpolationType
+   * @param {Number} index
+   * @param {Boolean} value
+   */
+  setForceNearestInterpolation(index: number, value: boolean): boolean;
+
+  /**
+   * Get the scalar component weights.
+   * @param {Number} index
+   */
+  getComponentWeight(index: number): number;
+
+  /**
+   * Set the interpolation type for sampling a volume.
+   * @param {InterpolationType} interpolationType
+   */
+  setInterpolationType(interpolationType: InterpolationType): boolean;
+
+  /**
+   * Set interpolation type to NEAREST
+   */
+  setInterpolationTypeToNearest(): boolean;
+
+  /**
+   * Set interpolation type to LINEAR
+   */
+  setInterpolationTypeToLinear(): boolean;
+
+  /**
+   * Set interpolation type to FAST_LINEAR
+   */
+  setInterpolationTypeToFastLinear(): boolean;
+
+  /**
+   * Get the interpolation type for sampling a volume.
+   */
+  getInterpolationType(): InterpolationType;
+
+  /**
+   * Get the interpolation type for sampling a volume as a string.
+   */
+  getInterpolationTypeAsString(): string;
 }
 
 /**
@@ -375,12 +379,18 @@ export interface vtkVolumeProperty extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IVolumePropertyInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IVolumePropertyInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IVolumePropertyInitialValues
+): void;
 
 /**
  * Method use to create a new instance of vtkVolumeProperty
  */
-export function newInstance(initialValues?: IVolumePropertyInitialValues): vtkVolumeProperty;
+export function newInstance(
+  initialValues?: IVolumePropertyInitialValues
+): vtkVolumeProperty;
 
 /**
  * vtkVolumeProperty is used to represent common properties associated
@@ -448,9 +458,9 @@ export function newInstance(initialValues?: IVolumePropertyInitialValues): vtkVo
  * ```
  */
 export declare const vtkVolumeProperty: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-	InterpolationType: typeof InterpolationType;
-	OpacityMode: typeof OpacityMode;
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+  InterpolationType: typeof InterpolationType;
+  OpacityMode: typeof OpacityMode;
 };
 export default vtkVolumeProperty;