Skip to content

Commit 8e8e24a

Browse files
committed
review
1 parent ffd45db commit 8e8e24a

7 files changed

Lines changed: 34 additions & 18 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ runs:
198198
-DF3D_TESTING_ENABLE_EGL_TESTS=${{ runner.os == 'Linux' && 'ON' || 'OFF' }}
199199
-DF3D_TESTING_ENABLE_EXTERNAL_GLFW=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
200200
-DF3D_TESTING_ENABLE_EXTERNAL_QT=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
201-
-DF3D_TESTING_ENABLE_ILLUSTRATION_TESTS=${{ (runner.os == 'Linux') && 'ON' || 'OFF' }}
201+
-DF3D_TESTING_ENABLE_ILLUSTRATION_TESTS=${{ (runner.os == 'Linux' && inputs.vtk_version == 'commit') && 'ON' || 'OFF' }}
202202
-DF3D_TESTING_ENABLE_GLX_TESTS=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
203203
-DF3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS=${{ (runner.os == 'Linux' || runner.os == 'Windows') && 'ON' || 'OFF' }}
204204
-DF3D_TESTING_ENABLE_OSMESA_TESTS=${{ runner.os == 'Linux' && 'ON' || 'OFF' }}

application/testing/tests.documentation.cmake

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,23 @@ file(DOWNLOAD
4444
SHOW_PROGRESS
4545
)
4646

47-
## Wrapper that sets many default arguments for documentation illustration tests
47+
#[==[.md
48+
# Wrapper that sets many common arguments for documentation illustration tests
49+
50+
Usage:
51+
52+
```
53+
f3d_doc_test(<NAME> [ARGS...])
54+
```
55+
- `UI` Mark the test to require the presence of UI component and disable it otherwise
56+
- `BACKGROUND` The background is visible, otherwise it's transparent
57+
- `ROTATE` Rotate the camera to show the model from a different angle, otherwise it's front facing
58+
- `NAME` Provide the name of the test, mandatory and must be unique
59+
- `THRESHOLD` Provide the `--reference-threshold` to use instead of the default
60+
- `DATA` Data to open, support multiple input, also set test labels accordingly
61+
- `REF_IMAGE` Provide the reference image name, saved into `doc/user/images`
62+
- `ARGS` Supplement arguments to add to the f3d command line
63+
#]==]
4864
function(f3d_test_doc)
4965
cmake_parse_arguments(F3D_TEST_DOC "UI;BACKGROUND;ROTATE" "NAME;DATA;REF_IMAGE;THRESHOLD" "ARGS" ${ARGN})
5066

@@ -290,7 +306,7 @@ f3d_test_doc(NAME TestDocHDRICOC50 DATA DamagedHelmet.glb REF_IMAGE hdri_coc_50.
290306

291307
## --light-intensity
292308
f3d_test_doc(NAME TestDocLightIntensity1 DATA DamagedHelmet.glb REF_IMAGE light_intensity_1.png ROTATE)
293-
f3d_test_doc(NAME TestDocLightIntensity05 DATA DamagedHelmet.glb REF_IMAGE light_intensity_0.5.png ROTATE ARGS --light-intensity=0.5)
309+
f3d_test_doc(NAME TestDocLightIntensity2 DATA DamagedHelmet.glb REF_IMAGE light_intensity_2.png ROTATE ARGS --light-intensity=2)
294310

295311
## --scalar-coloring
296312
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
318334

319335
## ---colormap-file
320336
### OFF: skull_baseline.png
321-
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)
337+
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)
322338

323339
## --colormap-discretization
324-
f3d_test_doc(NAME TestDocColorMapDiscretizationDefault DATA dragon.vtu REF_IMAGE color_map_discretization_default.png ROTATE ARGS -s "--coloring-array=UV coordinates from field")
325-
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)
340+
f3d_test_doc(NAME TestDocColorMapDiscretizationDefault DATA dragon.vtu REF_IMAGE colormap_discretization_default.png ROTATE ARGS -s "--coloring-array=UV coordinates from field")
341+
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)
326342

327343
## --volume
328344
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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -715,9 +715,9 @@ _Adjust the intensity_ of every light in the scene (except HDRI).
715715

716716
#### compare
717717

718-
| 1 (default) | 0.5 |
719-
| ----------------------------------- | ------------------------------------- |
720-
| ![](./images/light_intensity_1.png) | ![](./images/light_intensity_0.5.png) |
718+
| 1 (default) | 2 |
719+
| ----------------------------------- | ----------------------------------- |
720+
| ![](./images/light_intensity_1.png) | ![](./images/light_intensity_2.png) |
721721

722722
## Scientific visualization options
723723

@@ -795,9 +795,9 @@ Use with the scalar option.
795795

796796
#### compare
797797

798-
| Default (inferno) | Viridis |
799-
| -------------------------------- | ----------------------------------- |
800-
| ![](./images/skull_baseline.png) | ![](./images/color_map_viridis.png) |
798+
| Default (inferno) | Viridis |
799+
| -------------------------------- | ---------------------------------- |
800+
| ![](./images/skull_baseline.png) | ![](./images/colormap_viridis.png) |
801801

802802
### `--colormap=<colormap>` (_colormap_)
803803

@@ -811,9 +811,9 @@ Set the number of distinct colors from [1, N] will be used in the colormap. Any
811811

812812
#### compare
813813

814-
| Default | 8 |
815-
| -------------------------------------------------- | -------------------------------------------- |
816-
| ![](./images/color_map_discretization_default.png) | ![](./images/color_map_discretization_8.png) |
814+
| Default | 8 |
815+
| ------------------------------------------------- | ------------------------------------------- |
816+
| ![](./images/colormap_discretization_default.png) | ![](./images/colormap_discretization_8.png) |
817817

818818
### `-v`, `--volume` (_bool_, default: `false`)
819819

File renamed without changes.
File renamed without changes.

doc/user/images/light_intensity_0.5.png

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)