refactor: move the updatedExtent API to properties

BREAKING CHANGE: the updatedExtent API has been moved from the mappers
to the vtkImageProperty and vtkVolumeProperty interfaces. vtkImageMapper
does not yet honor the updatedExtent API.

Author: floryst

Sources/Rendering/Core/ImageCPRMapper/index.d.ts

@@ -1,5 +1,5 @@
 import { mat3, mat4, quat, vec3 } from 'gl-matrix';
-import { Extent, Nullable } from '../../../types';
+import { Nullable } from '../../../types';
 import { vtkOutputPort } from '../../../interfaces';
 import vtkAbstractMapper3D, {
   IAbstractMapper3DInitialValues,
@@ -307,25 +307,6 @@ export interface vtkImageCPRMapper
    * @param imageData
    */
   setImageConnection(imageData: vtkOutputPort): void;
-
-  /**
-   * Tells the mapper to only update the specified extents.
-   *
-   * 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[];
 }
 
 /**

Sources/Rendering/Core/ImageCPRMapper/index.js

@@ -344,7 +344,6 @@ const defaultValues = (initialValues) => ({
   projectionSlabThickness: 1,
   projectionSlabNumberOfSamples: 1,
   projectionMode: ProjectionMode.MAX,
-  updatedExtents: [],
   ...initialValues,
 });
 
@@ -376,7 +375,6 @@ export function extend(publicAPI, model, initialValues = {}) {
     'projectionSlabThickness',
     'projectionSlabNumberOfSamples',
     'projectionMode',
-    'updatedExtents',
   ]);
   CoincidentTopologyHelper.implementCoincidentTopologyMethods(publicAPI, model);
 

Sources/Rendering/Core/ImageProperty/index.d.ts

@@ -1,5 +1,5 @@
 import { vtkObject } from '../../../interfaces';
-import { Nullable } from '../../../types';
+import { Extent, Nullable } from '../../../types';
 import vtkColorTransferFunction from '../ColorTransferFunction';
 import vtkPiecewiseFunction from '../../../Common/DataModel/PiecewiseFunction';
 import { InterpolationType } from './Constants';
@@ -231,6 +231,25 @@ export interface vtkImageProperty extends vtkObject {
    * @param {Boolean} useLookupTableScalarRange
    */
   setUseLookupTableScalarRange(useLookupTableScalarRange: boolean): boolean;
+
+  /**
+   * 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[];
 }
 
 /**

Sources/Rendering/Core/ImageProperty/index.js

@@ -130,7 +130,7 @@ function vtkImageProperty(publicAPI, model) {
 // ----------------------------------------------------------------------------
 // Object factory
 // ----------------------------------------------------------------------------
-const DEFAULT_VALUES = {
+const defaultValues = (initialValues) => ({
   independentComponents: false,
   interpolationType: InterpolationType.LINEAR,
   colorWindow: 255,
@@ -142,12 +142,14 @@ const DEFAULT_VALUES = {
   useLabelOutline: false,
   labelOutlineThickness: [1],
   labelOutlineOpacity: 1.0,
-};
+  updatedExtents: [],
+  ...initialValues,
+});
 
 // ----------------------------------------------------------------------------
 
 export function extend(publicAPI, model, initialValues = {}) {
-  Object.assign(model, DEFAULT_VALUES, initialValues);
+  Object.assign(model, defaultValues(initialValues));
 
   // Build VTK API
   macro.obj(publicAPI, model);
@@ -174,6 +176,7 @@ export function extend(publicAPI, model, initialValues = {}) {
     'useLookupTableScalarRange',
     'useLabelOutline',
     'labelOutlineOpacity',
+    'updatedExtents',
   ]);
 
   macro.setGetArray(publicAPI, model, ['labelOutlineThickness']);

Sources/Rendering/Core/ImageResliceMapper/index.d.ts

@@ -3,7 +3,7 @@ import vtkAbstractImageMapper, {
 } from '../AbstractImageMapper';
 import vtkPlane from '../../../Common/DataModel/Plane';
 import vtkPolyData from '../../../Common/DataModel/PolyData';
-import { Bounds, Extent } from '../../../types';
+import { Bounds } from '../../../types';
 import { SlabTypes } from './Constants';
 import CoincidentTopologyHelper, {
   StaticCoincidentTopologyMethods,
@@ -115,25 +115,6 @@ export interface vtkImageResliceMapper
    * @param {vtkPolyData} slicePolyData The polydata to slice the volume with. Default: null
    */
   setSlicePolyData(slicePolyData: vtkPolyData): boolean;
-
-  /**
-   * Tells the mapper to only update the specified extents.
-   *
-   * 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[];
 }
 
 /**

Sources/Rendering/Core/ImageResliceMapper/index.js

@@ -45,7 +45,6 @@ const defaultValues = (initialValues) => ({
   slabType: SlabTypes.MEAN,
   slicePlane: null,
   slicePolyData: null,
-  updatedExtents: [],
   ...initialValues,
 });
 
@@ -63,7 +62,6 @@ export function extend(publicAPI, model, initialValues = {}) {
     'slabType',
     'slicePlane',
     'slicePolyData',
-    'updatedExtents',
   ]);
   CoincidentTopologyHelper.implementCoincidentTopologyMethods(publicAPI, model);
 

Sources/Rendering/Core/VolumeMapper/index.d.ts

@@ -1,5 +1,5 @@
 import vtkPiecewiseFunction from '../../../Common/DataModel/PiecewiseFunction';
-import { Bounds, Extent } from '../../../types';
+import { Bounds } from '../../../types';
 import vtkAbstractMapper3D, {
   IAbstractMapper3DInitialValues,
 } from '../AbstractMapper3D';
@@ -158,25 +158,6 @@ export interface vtkVolumeMapper extends vtkAbstractMapper3D {
     interactionSampleDistanceFactor: number
   ): boolean;
 
-  /**
-   * Tells the mapper to only update the specified extents.
-   *
-   * 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[];
-
   /**
    *
    */

Sources/Rendering/Core/VolumeMapper/index.js

@@ -148,8 +148,6 @@ const defaultValues = (initialValues) => ({
   interactionSampleDistanceFactor: 1.0,
   blendMode: BlendMode.COMPOSITE_BLEND,
   volumeShadowSamplingDistFactor: 5.0,
-  // TODO move to volumeProperty
-  updatedExtents: [],
   colorTextureWidth: 1024,
   opacityTextureWidth: 1024,
   labelOutlineTextureWidth: 1024,
@@ -172,7 +170,6 @@ export function extend(publicAPI, model, initialValues = {}) {
     'interactionSampleDistanceFactor',
     'blendMode',
     'volumeShadowSamplingDistFactor',
-    'updatedExtents',
     'colorTextureWidth',
     'opacityTextureWidth',
     'labelOutlineTextureWidth',

Sources/Rendering/Core/VolumeProperty/index.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 './Constants';
 
@@ -486,6 +486,25 @@ export interface vtkVolumeProperty extends vtkObject {
    * @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[];
 }
 
 /**

Sources/Rendering/Core/VolumeProperty/index.js

@@ -286,7 +286,7 @@ function vtkVolumeProperty(publicAPI, model) {
 // Object factory
 // ----------------------------------------------------------------------------
 
-const DEFAULT_VALUES = {
+const defaultValues = (initialValues) => ({
   colorMixPreset: ColorMixPreset.DEFAULT,
   independentComponents: true,
   interpolationType: InterpolationType.FAST_LINEAR,
@@ -312,12 +312,15 @@ const DEFAULT_VALUES = {
   localAmbientOcclusion: false,
   LAOKernelSize: 15,
   LAOKernelRadius: 7,
-};
+  updatedExtents: [],
+
+  ...initialValues,
+});
 
 // ----------------------------------------------------------------------------
 
 export function extend(publicAPI, model, initialValues = {}) {
-  Object.assign(model, DEFAULT_VALUES, initialValues);
+  Object.assign(model, defaultValues(initialValues));
 
   // Build VTK API
   macro.obj(publicAPI, model);
@@ -366,6 +369,7 @@ export function extend(publicAPI, model, initialValues = {}) {
     'localAmbientOcclusion',
     'LAOKernelSize',
     'LAOKernelRadius',
+    'updatedExtents',
   ]);
 
   // Property moved from volume mapper