Coloring: Split --scalars in two options, --scalar-coloring and `…

…--coloring-array`

 - Remove `--scalars, -s`
 - Introduce `--scalar-coloring, -s` option and corresponding libf3d option
 - Introduce `coloring-array` option and corresponding libf3d option
 - Update tests and configs
 - Add an `enable` boolean to the SetColoring API
 - Update API usage in window and interactor
 - Remove fully F3D_RESERVED* constants

application/F3DOptionsTools.cxx

@@ -125,9 +125,10 @@ static inline const std::vector<CLIGroup> CLIOptions = {
       {"blur-coc", "", "Blur circle of confusion radius", "<value>", ""},
       {"light-intensity", "", "Light intensity", "<value>", ""} } },
   {"Scientific visualization",
-    { {"scalars", "s", "Color by scalars", "<array_name>", "f3d_reserved_true" }, // TODO
-      {"comp", "y", "Component from the scalar array to color with. -1 means magnitude, -2 or the short option, -y, means direct scalars", "<comp_index>", "-2"},
-      {"cells", "c", "Use a scalar array from the cells", "<bool>", "1"},
+    { {"scalar-coloring", "s", "Color by a scalar array", "<bool>", "1" },
+      {"coloring-array", "", "Name of the array to color with", "<array_name>", "" },
+      {"comp", "y", "Component from the array to color with. -1 means magnitude, -2 or the short option, -y, means direct scalars", "<comp_index>", "-2"},
+      {"cells", "c", "Use an array from the cells", "<bool>", "1"},
       {"range", "", "Custom range for the coloring by array", "<min,max>", ""},
       {"bar", "b", "Show scalar bar", "<bool>", "1" },
       {"colormap-file", "", "Specify a colormap image", "<filePath/filename/fileStem>", ""},

application/F3DOptionsTools.h

@@ -105,7 +105,8 @@ static inline const std::map<std::string_view, std::string_view> LibOptionsNames
   { "metadata", "ui.metadata" },
   { "blur-background", "render.background.blur" },
   { "blur-coc", "render.background.blur_coc" },
-  { "scalars", "model.scivis.array_name" },
+  { "scalar-coloring", "model.scivis.enable" },
+  { "coloring-array", "model.scivis.array_name" },
   { "light-intensity", "render.light.intensity" },
   { "comp", "model.scivis.component" },
   { "cells", "model.scivis.cells" },

library/options.json

@@ -249,13 +249,17 @@
       }
     },
     "scivis": {
+      "enable": {
+        "type": "bool",
+        "default_value": "false"
+      },
       "cells": {
         "type": "bool",
         "default_value": "false"
       },
       "array_name": {
         "type": "string",
-        "default_value": "f3d_reserved"
+        "default_value": ""
       },
       "component": {
         "type": "int",

library/src/interactor_impl.cxx

@@ -360,6 +360,7 @@ class interactor_impl::internals
     if (checkColoring)
     {
       // Resynchronise renderer coloring status with options
+      self->Options.model.scivis.enable = renWithColor->GetColoringEnabled();
       self->Options.model.scivis.cells = renWithColor->GetColoringUseCell();
       self->Options.model.scivis.array_name = renWithColor->GetColoringArrayName();
       self->Options.model.scivis.component = renWithColor->GetColoringComponent();

library/src/window_impl.cxx

@@ -416,8 +416,8 @@ void window_impl::UpdateDynamicOptions()
     renderer->SetNormalScale(opt.model.normal.scale);
     renderer->SetTextureMatCap(opt.model.matcap.texture);
 
-    renderer->SetColoring(
-      opt.model.scivis.cells, opt.model.scivis.array_name, opt.model.scivis.component);
+    renderer->SetColoring(opt.model.scivis.enable, opt.model.scivis.cells,
+      opt.model.scivis.array_name, opt.model.scivis.component);
     renderer->SetScalarBarRange(opt.model.scivis.range);
     renderer->SetColormap(opt.model.scivis.colormap);
     renderer->ShowScalarBar(opt.ui.scalar_bar);

resources/configs/config.d/05_all.json

@@ -7,7 +7,7 @@
     "progress": true,
     "anti-aliasing": true,
     "filename": true,
-    "scalars": "",
+    "scalar-coloring": true,
     "camera-direction": "-1,-0.5,-1",
     "hdri-ambient": true,
     "translucency-support": true,

resources/configs/thumbnail.d/05_all.json

@@ -7,7 +7,7 @@
     "max-size":100,
     "no-background": true,
     "verbose": "quiet",
-    "scalars": "",
+    "scalar-coloring": true,
     "tone-mapping": true,
     "translucency-support": true
   }

testing/configs/complex.json

@@ -1,7 +1,7 @@
 {
   ".*":
   {
-    "scalars": "",
+    "scalar-coloring": true,
     "interactor.axis": true,
     "grid": true
   },

vtkext/private/module/Testing/TestF3DRendererWithColoring.cxx

@@ -14,7 +14,7 @@ int TestF3DRendererWithColoring(int argc, char* argv[])
   renderer->ShowGrid(true);
 
   // Check error paths
-  if (renderer->GetColoringArrayName() != F3D_RESERVED_STRING)
+  if (!renderer->GetColoringArrayName().empty())
   {
     std::cerr << "Unexpected coloring information without an importer" << std::endl;
     return EXIT_FAILURE;
@@ -37,7 +37,7 @@ int TestF3DRendererWithColoring(int argc, char* argv[])
   importer->Update();
 
   // Check invalid array code path
-  renderer->SetColoring(false, "Invalid", 0);
+  renderer->SetColoring(true, false, "Invalid", 0);
   renderer->SetUseVolume(false);
   renderer->UpdateActors();
   renderer->CycleScalars(vtkF3DRendererWithColoring::CycleType::COMPONENT);
@@ -51,7 +51,7 @@ int TestF3DRendererWithColoring(int argc, char* argv[])
   }
 
   // Check invalid component code path
-  renderer->SetColoring(false, "Momentum", 5);
+  renderer->SetColoring(true, false, "Momentum", 5);
   renderer->UpdateActors();
   renderer->SetUseVolume(true);
   renderer->UpdateActors();

vtkext/private/module/vtkF3DConfigure.h.in

@@ -3,7 +3,6 @@
 
 #include <string>
 
-static const std::string F3D_RESERVED_STRING = "f3d_reserved";
 static const std::string F3D_EXIT_HOTKEY_SYM = "Escape";
 
 // TODO: Use CMake definitions and get rid of these

vtkext/private/module/vtkF3DRendererWithColoring.cxx

@@ -473,7 +473,7 @@ vtkF3DRendererWithColoring::CycleType vtkF3DRendererWithColoring::CheckColoring(
   assert(this->Importer);
 
   // Never force change of anything if we are currently not coloring
-  if (this->ArrayIndexForColoring == -1)
+  if (this->ArrayIndexForColoring < 0)
   {
     return CycleType::NONE;
   }
@@ -501,7 +501,7 @@ vtkF3DRendererWithColoring::CycleType vtkF3DRendererWithColoring::CheckColoring(
 }
 
 //----------------------------------------------------------------------------
-void vtkF3DRendererWithColoring::SetColoring(
+void vtkF3DRendererWithColoring::SetColoring(bool enable,
   bool useCellData, const std::string& arrayName, int component)
 {
   if (!this->Importer)
@@ -511,13 +511,16 @@ void vtkF3DRendererWithColoring::SetColoring(
 
   // XXX This should be reworked to avoid handling multiple information in one parameters
   // while still being future-proof and flexible enough.
-  if (this->GetColoringUseCell() != useCellData || this->GetColoringArrayName() != arrayName ||
-    this->GetColoringComponent() != component)
+  if (enable != (this->ArrayIndexForColoring >= 0)
+      || useCellData != this->UseCellColoring
+      || component != this->ComponentForColoring
+      || arrayName != this->GetColoringArrayName())
   {
     this->UseCellColoring = useCellData;
+    this->ComponentForColoring = component;
 
     int nIndexes = this->Importer->GetNumberOfIndexesForColoring(this->UseCellColoring);
-    if (arrayName == F3D_RESERVED_STRING)
+    if (!enable)
     {
       // Not coloring
       this->ArrayIndexForColoring = -1;
@@ -544,8 +547,6 @@ void vtkF3DRendererWithColoring::SetColoring(
       }
     }
 
-    this->ComponentForColoring = component;
-
     this->ColorTransferFunctionConfigured = false;
     this->GeometryMappersConfigured = false;
     this->PointSpritesMappersConfigured = false;
@@ -555,6 +556,12 @@ void vtkF3DRendererWithColoring::SetColoring(
   }
 }
 
+//----------------------------------------------------------------------------
+bool vtkF3DRendererWithColoring::GetColoringEnabled()
+{
+  return this->ArrayIndexForColoring >= 0;
+}
+
 //----------------------------------------------------------------------------
 bool vtkF3DRendererWithColoring::GetColoringUseCell()
 {
@@ -566,7 +573,7 @@ std::string vtkF3DRendererWithColoring::GetColoringArrayName()
 {
   if (!this->Importer)
   {
-    return F3D_RESERVED_STRING;
+    return "";
   }
 
   vtkF3DGenericImporter::ColoringInfo info;
@@ -576,7 +583,7 @@ std::string vtkF3DRendererWithColoring::GetColoringArrayName()
   }
   else
   {
-    return F3D_RESERVED_STRING;
+    return "";
   }
 }
 

vtkext/private/module/vtkF3DRendererWithColoring.h

@@ -157,17 +157,18 @@ class vtkF3DRendererWithColoring : public vtkF3DRenderer
   void SetImporter(vtkF3DGenericImporter* importer);
 
   /**
-   * Set the coloring, call after SetColoringAttributes.
+   * Set coloring information.
    * This method will try to find the corresponding array in the coloring attributes and will
    * position ArrayIndexForColoring and DataForColoring accordingly.
    */
-  void SetColoring(bool useCellData, const std::string& arrayName, int component);
+  void SetColoring(bool enable, bool useCellData, const std::string& arrayName, int component);
 
   ///@{
   /**
    * Get current coloring information,
    * Useful after using Cycle methods
    */
+  bool GetColoringEnabled();
   bool GetColoringUseCell();
   std::string GetColoringArrayName();
   int GetColoringComponent();