review

Author: Meakk

.github/actions/generic-ci/action.yml

@@ -198,7 +198,7 @@ runs:
         -DF3D_TESTING_ENABLE_EGL_TESTS=${{ runner.os == 'Linux' && 'ON' || 'OFF' }}
         -DF3D_TESTING_ENABLE_EXTERNAL_GLFW=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
         -DF3D_TESTING_ENABLE_EXTERNAL_QT=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
-        -DF3D_TESTING_ENABLE_ILLUSTRATION_TESTS=${{ (runner.os == 'Linux') && 'ON' || 'OFF' }}
+        -DF3D_TESTING_ENABLE_ILLUSTRATION_TESTS=${{ (runner.os == 'Linux' && inputs.vtk_version == 'commit') && 'ON' || 'OFF' }}
         -DF3D_TESTING_ENABLE_GLX_TESTS=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
         -DF3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS=${{ (runner.os == 'Linux' || runner.os == 'Windows') && 'ON' || 'OFF' }}
         -DF3D_TESTING_ENABLE_OSMESA_TESTS=${{ runner.os == 'Linux' && 'ON' || 'OFF' }}

application/testing/tests.documentation.cmake

@@ -44,7 +44,23 @@ file(DOWNLOAD
     SHOW_PROGRESS
 )
 
-## Wrapper that sets many default arguments for documentation illustration tests
+#[==[.md
+# Wrapper that sets many common arguments for documentation illustration tests
+
+Usage:
+
+```
+f3d_doc_test(<NAME> [ARGS...])
+```
+  - `UI` Mark the test to require the presence of UI component and disable it otherwise
+  - `BACKGROUND` The background is visible, otherwise it's transparent
+  - `ROTATE` Rotate the camera to show the model from a different angle, otherwise it's front facing
+  - `NAME` Provide the name of the test, mandatory and must be unique
+  - `THRESHOLD` Provide the `--reference-threshold` to use instead of the default
+  - `DATA` Data to open, support multiple input, also set test labels accordingly
+  - `REF_IMAGE` Provide the reference image name, saved into `doc/user/images`
+  - `ARGS` Supplement arguments to add to the f3d command line
+#]==]
 function(f3d_test_doc)
   cmake_parse_arguments(F3D_TEST_DOC "UI;BACKGROUND;ROTATE" "NAME;DATA;REF_IMAGE;THRESHOLD" "ARGS" ${ARGN})
 
@@ -290,7 +306,7 @@ f3d_test_doc(NAME TestDocHDRICOC50 DATA DamagedHelmet.glb REF_IMAGE hdri_coc_50.
 
 ## --light-intensity
 f3d_test_doc(NAME TestDocLightIntensity1 DATA DamagedHelmet.glb REF_IMAGE light_intensity_1.png ROTATE)
-f3d_test_doc(NAME TestDocLightIntensity05 DATA DamagedHelmet.glb REF_IMAGE light_intensity_0.5.png ROTATE ARGS --light-intensity=0.5)
+f3d_test_doc(NAME TestDocLightIntensity2 DATA DamagedHelmet.glb REF_IMAGE light_intensity_2.png ROTATE ARGS --light-intensity=2)
 
 ## --scalar-coloring
 f3d_test_doc(NAME TestDocScalarColoringOFF DATA dragon.vtu REF_IMAGE scalar_coloring_off.png ROTATE ARGS)
@@ -318,11 +334,11 @@ f3d_test_doc(NAME TestDocScalarBarON DATA skull.vti REF_IMAGE scalar_bar_on.png
 
 ## ---colormap-file
 ### OFF: skull_baseline.png
-f3d_test_doc(NAME TestDocColorMapViridis DATA skull.vti REF_IMAGE color_map_viridis.png ARGS -sv --up=z --coloring-range=40,200 --colormap-file=${F3D_SOURCE_DIR}/resources/colormaps/viridis.png)
+f3d_test_doc(NAME TestDocColorMapViridis DATA skull.vti REF_IMAGE colormap_viridis.png ARGS -sv --up=z --coloring-range=40,200 --colormap-file=${F3D_SOURCE_DIR}/resources/colormaps/viridis.png)
 
 ## --colormap-discretization
-f3d_test_doc(NAME TestDocColorMapDiscretizationDefault DATA dragon.vtu REF_IMAGE color_map_discretization_default.png ROTATE ARGS -s "--coloring-array=UV coordinates from field")
-f3d_test_doc(NAME TestDocColorMapDiscretization8 DATA dragon.vtu REF_IMAGE color_map_discretization_8.png ROTATE ARGS -s "--coloring-array=UV coordinates from field" --colormap-discretization=8)
+f3d_test_doc(NAME TestDocColorMapDiscretizationDefault DATA dragon.vtu REF_IMAGE colormap_discretization_default.png ROTATE ARGS -s "--coloring-array=UV coordinates from field")
+f3d_test_doc(NAME TestDocColorMapDiscretization8 DATA dragon.vtu REF_IMAGE colormap_discretization_8.png ROTATE ARGS -s "--coloring-array=UV coordinates from field" --colormap-discretization=8)
 
 ## --volume
 f3d_test_doc(NAME TestDocVolumeOFF DATA skull.vti REF_IMAGE volume_off.png ARGS -s --up=z --coloring-range=40,200)

doc/user/03-OPTIONS.md

@@ -715,9 +715,9 @@ _Adjust the intensity_ of every light in the scene (except HDRI).
 
 #### compare
 
-| 1 (default)                         | 0.5                                   |
-| ----------------------------------- | ------------------------------------- |
-| ![](./images/light_intensity_1.png) | ![](./images/light_intensity_0.5.png) |
+| 1 (default)                         | 2                                   |
+| ----------------------------------- | ----------------------------------- |
+| ![](./images/light_intensity_1.png) | ![](./images/light_intensity_2.png) |
 
 ## Scientific visualization options
 
@@ -795,9 +795,9 @@ Use with the scalar option.
 
 #### compare
 
-| Default (inferno)                | Viridis                             |
-| -------------------------------- | ----------------------------------- |
-| ![](./images/skull_baseline.png) | ![](./images/color_map_viridis.png) |
+| Default (inferno)                | Viridis                            |
+| -------------------------------- | ---------------------------------- |
+| ![](./images/skull_baseline.png) | ![](./images/colormap_viridis.png) |
 
 ### `--colormap=<colormap>` (_colormap_)
 
@@ -811,9 +811,9 @@ Set the number of distinct colors from [1, N] will be used in the colormap. Any
 
 #### compare
 
-| Default                                            | 8                                            |
-| -------------------------------------------------- | -------------------------------------------- |
-| ![](./images/color_map_discretization_default.png) | ![](./images/color_map_discretization_8.png) |
+| Default                                           | 8                                           |
+| ------------------------------------------------- | ------------------------------------------- |
+| ![](./images/colormap_discretization_default.png) | ![](./images/colormap_discretization_8.png) |
 
 ### `-v`, `--volume` (_bool_, default: `false`)