fix(dataobject): add initialize() to clear vtkDataSet

Previous outData must be cleared before populated by requestData

Author: finetjul

Sources/Common/Core/DataArray/index.js

@@ -198,9 +198,10 @@ function vtkDataArray(publicAPI, model) {
     return false;
   };
 
-  // FIXME, to rename into "clear()" or "reset()"
+  // Restore the array to initial state
   publicAPI.initialize = () => {
     publicAPI.resize(0);
+    return publicAPI;
   };
 
   publicAPI.getElementComponentSize = () => model.values.BYTES_PER_ELEMENT;

Sources/Common/DataModel/DataSet/index.d.ts

@@ -8,6 +8,13 @@ import { FieldAssociations, FieldDataTypes } from './Constants';
 export interface IDataSetInitialValues {}
 
 export interface vtkDataSet extends vtkObject {
+  /**
+   * Initialize the field, cell and point data.
+   * @see vtkDataSetAttributes::initialize()
+   * @see vtkFieldData::initialize()
+   */
+  initialize(): void;
+
   /**
    * Get dataset's cell data
    */

Sources/Common/DataModel/DataSet/index.js

@@ -73,6 +73,11 @@ function vtkDataSet(publicAPI, model) {
         Math.max(mTime, model[fieldName]?.getMTime() ?? mTime),
       superGetMTime()
     );
+
+  publicAPI.initialize = () => {
+    DATASET_FIELDS.forEach((fieldName) => model[fieldName]?.initialize());
+    return publicAPI;
+  };
 }
 
 // ----------------------------------------------------------------------------

Sources/Common/DataModel/DataSetAttributes/FieldData.d.ts

@@ -22,12 +22,16 @@ interface IArrayWithIndex {
 
 export interface vtkFieldData extends vtkObject {
   /**
-   *
+   * Initialize fields, clear flags and restore copy beahvior.
+   * @see initializeFields
+   * @see clearFieldFlags
+   * @see copyAllOn
    */
   initialize(): void;
 
   /**
-   *
+   * Delete all arrays and clear flags.
+   * @see initialize
    */
   initializeFields(): void;
 

Sources/Common/DataModel/DataSetAttributes/index.d.ts

@@ -229,7 +229,8 @@ export interface vtkDataSetAttributes extends vtkFieldData {
   removeArrayByIndex(arrayIdx: number): void;
 
   /**
-   *
+   * Called when initialize() is called.
+   * @see initialize
    */
   initializeAttributeCopyFlags(): void;
 

Sources/Common/DataModel/ImageData/index.d.ts

@@ -20,6 +20,13 @@ interface IComputeHistogram {
 }
 
 export interface vtkImageData extends vtkDataSet {
+  /**
+   * Reinitialize the state (direction, spacing, origin, extent, etc.)
+   * and the data set.
+   * @see vtkDataSet::initialize()
+   */
+  initialize(): void;
+
   /**
    * Returns an object with `{ minimum, maximum, average, variance, sigma, count }`
    * of the imageData points found within the provided `worldBounds`.

Sources/Common/DataModel/ImageData/index.js

@@ -393,6 +393,18 @@ function vtkImageData(publicAPI, model) {
       .getScalars()
       .getComponent(offsetIndex, comp);
   };
+
+  const superInitialize = publicAPI.initialize;
+  publicAPI.initialize = () => {
+    publicAPI.set({
+      direction: mat3.identity(model.direction),
+      spacing: [1.0, 1.0, 1.0],
+      origin: [0.0, 0.0, 0.0],
+      extent: [0, -1, 0, -1, 0, -1],
+      dataDescription: StructuredType.EMPTY,
+    });
+    return superInitialize();
+  };
 }
 
 // ----------------------------------------------------------------------------

Sources/Common/DataModel/PointSet/index.d.ts

@@ -8,6 +8,12 @@ import vtkDataSet, { IDataSetInitialValues } from '../DataSet';
 export interface IPointSetInitialValues extends IDataSetInitialValues {}
 
 export interface vtkPointSet extends vtkDataSet {
+  /**
+   * Empty the points and initialize the data set and .
+   * @see vtkDataSet::initialize()
+   */
+  initialize(): void;
+
   /**
    * Compute the (X, Y, Z) bounds of the data.
    */

Sources/Common/DataModel/PointSet/index.js

@@ -42,6 +42,12 @@ function vtkPointSet(publicAPI, model) {
     const mTime = superGetMTime();
     return Math.max(mTime, model.points?.getMTime() ?? mTime);
   };
+
+  const superInitialize = publicAPI.initialize;
+  publicAPI.initialize = () => {
+    model.points?.initialize();
+    return superInitialize();
+  };
 }
 
 // ----------------------------------------------------------------------------

Sources/Common/DataModel/PolyData/index.d.ts

@@ -8,6 +8,12 @@ import vtkPointSet, { IPointSetInitialValues } from '../PointSet';
 export interface IPolyDataInitialValues extends IPointSetInitialValues {}
 
 export interface vtkPolyData extends vtkPointSet {
+  /**
+   * Empty the cells and initialize the point set.
+   * @see vtkPointSet::initialize()
+   */
+  initialize(): void;
+
   /**
    * Create data structure that allows random access of cells.
    */