refactor(dataarray): change setData

Rename values to data in extend function and accept null as array param

Author: joannacirillo

Sources/Common/Core/DataArray/index.d.ts

@@ -209,7 +209,7 @@ export function extend(publicAPI: object, model: object, initialValues?: object)
  * Method use to create a new instance of vtkDataArray
  * @param {object} [initialValues] for pre-setting some of its content
  * initialValues can have a property "empty: true" to be able to create a
- * model without giving values. This property will not be stored in the model
+ * model without giving data. This property will not be stored in the model
  */
 export function newInstance(initialValues?: object): vtkDataArray;
 

Sources/Common/Core/DataArray/index.js

@@ -264,7 +264,7 @@ function vtkDataArray(publicAPI, model) {
   };
 
   publicAPI.setData = (typedArray, numberOfComponents) => {
-    if (!typedArray) {
+    if (typedArray === undefined) {
       vtkErrorMacro(`Cannot call setData with given array : ${typedArray}`);
       return;
     }
@@ -273,14 +273,15 @@ function vtkDataArray(publicAPI, model) {
       // eslint-disable-next-line no-param-reassign
       typedArray = macro.newTypedArrayFrom(model.dataType, typedArray);
     }
+
     model.values = typedArray;
-    model.size = typedArray.length;
-    model.dataType = getDataType(typedArray);
+    model.size = typedArray ? typedArray.length : 0;
+    model.dataType = typedArray ? getDataType(typedArray) : model.dataType;
 
     if (numberOfComponents) {
       model.numberOfComponents = numberOfComponents;
     }
-    if (model.size % model.numberOfComponents !== 0) {
+    if (model.size % model.numberOfComponents !== 0 || model.size === 0) {
       model.numberOfComponents = 1;
     }
     dataChange();
@@ -332,7 +333,7 @@ function defaultValues(initialValues) {
     size: 0,
     dataType: DefaultDataType,
     rangeTuple: [0, 0],
-    // values: macro.newTypedArray(DefaultValues),
+    // data: macro.newTypedArray(DefaultValues),
     // ranges: null,
     ...initialValues,
   };
@@ -346,6 +347,9 @@ export function extend(publicAPI, model, initialValues = {}) {
       'Cannot create vtkDataArray object without: size > 0, values'
     );
   }
+  let initialData = initialValues.values;
+  delete initialValues.empty;
+  delete initialValues.values;
   Object.assign(initialValues, defaultValues(initialValues));
 
   // Object methods
@@ -355,28 +359,17 @@ export function extend(publicAPI, model, initialValues = {}) {
   model.dataType = initialValues.dataType
     ? initialValues.dataType
     : DefaultDataType;
-  if (!initialValues.values) {
-    initialValues.values = macro.newTypedArray(
-      model.dataType,
-      initialValues.size
-    );
-  } else if (Array.isArray(initialValues.values)) {
-    initialValues.values = macro.newTypedArrayFrom(
-      model.dataType,
-      initialValues.values
-    );
+  delete initialValues.dataType;
+  if (!initialData) {
+    initialData = macro.newTypedArray(model.dataType, initialValues.size);
+  } else if (Array.isArray(initialData)) {
+    initialData = macro.newTypedArrayFrom(model.dataType, initialData);
   }
 
+  initialValues.data = initialData;
+
   // Object specific methods
   vtkDataArray(publicAPI, model);
-  // We need to call setData manually here because it is not a setter for a property
-  // in itself but calling it is still the proper way to set the datas of the model
-  publicAPI.setData(initialValues.values, initialValues.numberOfComponents);
-  delete initialValues.values;
-  delete initialValues.empty;
-  delete initialValues.numberOfComponents;
-  delete initialValues.size;
-  delete initialValues.dataType;
 }
 
 // ----------------------------------------------------------------------------

Sources/Common/Core/DataArray/test/testDataArray.js

@@ -19,19 +19,22 @@ test('Test vtkDataArray instance', (t) => {
 
   t.throws(
     () => vtkDataArray.newInstance({}),
-    'Create instance without values'
+    'Not allowed to create instance without initialValues'
   );
 
-  t.doesNotThrow(() => vtkDataArray.newInstance({ empty: true }));
+  t.doesNotThrow(
+    () => vtkDataArray.newInstance({ empty: true }),
+    'Allowed to create instance with empty true, no values'
+  );
 
   t.throws(
     () => vtkDataArray.newInstance({ empty: false }),
-    'Create instance with empty false, no values'
+    'Not allowed to create instance with empty false, no values'
   );
 
   t.doesNotThrow(
     () => vtkDataArray.newInstance({ size: 256 }),
-    'Create instance with only size'
+    'Allowed to create instance with only size'
   );
 
   const dataArray0 = vtkDataArray.newInstance({
@@ -137,7 +140,7 @@ test('Test vtkDataArray setData', (t) => {
       values: macro.newTypedArrayFrom(DefaultDataType, [4, 5, 6, 7]),
     },
     getDataArrayProperties(dataArray),
-    'Change data of existing instance'
+    'Change values of existing instance'
   );
 
   dataArray.setData([1, 2, 3, 4, 5, 6], 2);
@@ -176,28 +179,29 @@ test('Test vtkDataArray setData', (t) => {
     'Empty an instance (pass [] array)'
   );
 
-  // For both of those cases, check it does not change the DataArray
-  // Not supposed to call setData with typedArray = null
+  // Fill the DataArray before so that we are sure the size and the numberOfComponents is updated
+  dataArray.setData([1, 2, 3], 3);
   dataArray.setData(null);
   t.deepEqual(
     {
       dataType: DefaultDataType,
       size: 0,
       numberOfComponents: 1,
-      values: macro.newTypedArray(DefaultDataType),
+      values: null,
     },
     getDataArrayProperties(dataArray),
     'Call setData with typedArray = null'
   );
 
-  // Not supposed to call setData without parameters
+  // Not supposed to call setData without parameters : check it does nothing on the DataArray
+  dataArray.setData([1, 2, 3]);
   dataArray.setData();
   t.deepEqual(
     {
       dataType: DefaultDataType,
-      size: 0,
+      size: 3,
       numberOfComponents: 1,
-      values: macro.newTypedArray(DefaultDataType),
+      values: macro.newTypedArrayFrom(DefaultDataType, [1, 2, 3]),
     },
     getDataArrayProperties(dataArray),
     'Call setData with typedArray = undefined'
@@ -212,7 +216,7 @@ test('Test vtkDataArray setData', (t) => {
       values: macro.newTypedArrayFrom('Uint32Array', [4, 5, 6, 7]),
     },
     getDataArrayProperties(dataArray),
-    'Change data of existing instance with another type'
+    'Change values of existing instance with another type'
   );
 });
 

Sources/Common/Core/Points/index.js

@@ -82,6 +82,8 @@ function vtkPoints(publicAPI, model) {
 
 function defaultValues(initialValues) {
   return {
+    // empty is only here to be passed to the DataArray extend function in order
+    // to create Points without giving values
     empty: true,
     numberOfComponents: 3,
     dataType: VtkDataTypes.FLOAT,

Sources/Rendering/Misc/FullScreenRenderWindow/index.d.ts

@@ -128,6 +128,7 @@ export function extend(publicAPI: object, model: object, initialValues?: IFullSc
 /**
  * Method used to create a new instance of vtkFullScreenRenderWindow
  * @param {IFullScreenRenderWindowInitialValues} [initialValues] for pre-setting some of its content
+ *  a background property can be given in the initialValues to set the background of the renderer
  */
 export function newInstance(initialValues?: IFullScreenRenderWindowInitialValues): vtkFullScreenRenderWindow;
 

Sources/Rendering/Misc/FullScreenRenderWindow/index.js

@@ -200,9 +200,6 @@ function defaultValues(initialValues) {
 // ----------------------------------------------------------------------------
 
 export function extend(publicAPI, model, initialValues = {}) {
-  // a background property can be set in the initialValues but we do not want
-  // to "store" background, only forward it to the renderer
-
   Object.assign(initialValues, defaultValues(initialValues));
 
   // Object methods