Refactor vector3_t #1645

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

@@ -76,7 +76,12 @@ runs:
         -DF3D_PLUGIN_BUILD_USD=ON
         -DF3D_PLUGIN_BUILD_VDB=ON
         -DF3D_STRICT_BUILD=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_EGL=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_GLFW=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_OSMESA=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_QT=ON
         -DF3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS=ON
+        -DF3D_TESTING_ENABLE_GLX_TESTS=ON
 
     - name: Build
       shell: bash

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

@@ -25,10 +25,10 @@ inputs:
     description: 'Label to control bundle'
     required: false
     default: 'no-bundle'
-  egl_label:
-    description: 'Label to control egl'
+  rendering_backend:
+    description: 'Label to control the rendering backend'
     required: false
-    default: 'no-egl'
+    default: 'auto'
   static_label:
     description: 'Label to control static build'
     required: false
@@ -82,7 +82,6 @@ runs:
         vtk_version: ${{inputs.vtk_version}}
         vtk_sha_file: ./source/.github/actions/vtk_commit_sha
         raytracing_label: ${{inputs.raytracing_label}}
-        egl_label: ${{inputs.egl_label}}
         cpu: ${{inputs.cpu}}
 
     - name: Install F3D dependencies
@@ -112,15 +111,6 @@ runs:
          mkdir install
          mkdir install/output
 
-    # There is a RPATH issue with VTK < 9.2.0
-    # This is a simple workaround for it
-    # See https://gitlab.kitware.com/vtk/vtk/-/merge_requests/8210
-    - name: Set LD_LIBRARY_PATH ubuntu VTK
-      if: runner.os == 'Linux'
-      shell: bash
-      working-directory: ${{github.workspace}}/dependencies/
-      run: echo "LD_LIBRARY_PATH=$(pwd)/install/lib:$LD_LIBRARY_PATH" >> $GITHUB_ENV
-
     - name: Set PATH windows
       if: runner.os == 'Windows'
       shell: powershell
@@ -140,6 +130,10 @@ runs:
       # https://github.com/f3d-app/f3d/issues/1322
       # MacOS x86_64 occasionally segfault with Java
       # https://github.com/f3d-app/f3d/issues/1410
+      # F3D_TESTING_ENABLE_EXTERNAL_(EGL|QT|GLFW) are disabled if no X server is running
+      # EGL is crashing in the CI but not locally
+      # QT/GLFW external tests should be adapted to run offscreen
+      # https://github.com/f3d-app/f3d/issues/1670
     - name: Configure
       shell: bash
       working-directory: ${{github.workspace}}/build
@@ -174,6 +168,12 @@ runs:
         -DF3D_PLUGIN_BUILD_USD=${{ inputs.optional_deps_label == 'optional-deps' && 'ON' || 'OFF' }}
         -DF3D_PLUGIN_BUILD_VDB=${{ matrix.vtk_version != 'v9.2.6' && (runner.os != 'Windows' || matrix.vtk_version != 'v9.3.1') && inputs.optional_deps_label == 'optional-deps' && 'ON' || 'OFF' }}
         -DF3D_STRICT_BUILD=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_EGL=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
+        -DF3D_TESTING_ENABLE_EXTERNAL_GLFW=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
+        -DF3D_TESTING_ENABLE_EXTERNAL_OSMESA=${{ runner.os == 'Linux' && 'ON' || 'OFF' }}
+        -DF3D_TESTING_ENABLE_EXTERNAL_QT=${{ (runner.os == 'Linux' && inputs.rendering_backend == 'auto') && 'ON' || 'OFF' }}
+        -DF3D_TESTING_ENABLE_GLX_TESTS=${{ inputs.rendering_backend == 'auto' && 'ON' || 'OFF' }}
+        -DF3D_TESTING_FORCE_RENDERING_BACKEND=${{ inputs.rendering_backend }}
         -DF3D_WINDOWS_GUI=ON
         ${{ runner.os == 'Windows' && '-Ax64 -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL' || null }}
         ${{ runner.os == 'macOS' && '-DCMAKE_OSX_DEPLOYMENT_TARGET=10.15' || null }}
@@ -187,7 +187,7 @@ runs:
     - name: Run Xvfb ubuntu
       if: |
         runner.os == 'Linux' &&
-        inputs.egl_label != 'egl'
+        inputs.rendering_backend == 'auto'
       shell: bash
       run: Xvfb $DISPLAY -screen 0 1280x1024x24 &
 
@@ -214,7 +214,7 @@ runs:
         runner.os == 'macOS' &&
         inputs.cpu == 'arm64'
       shell: bash
-      run: echo "F3D_CTEST_EXCEPTIONS=(TestDepthPeelingToneMapping)|(TestDepthPeeling)|(TestTextureColor)|(TestDXF)|(TestScalarsCell)|(TestXCAFColors)|(TestGrid)|(TestConfig)|(TestGLTFDracoImporter)" >> $GITHUB_ENV
+      run: echo "F3D_CTEST_EXCEPTIONS=(TestDepthPeelingToneMapping)|(TestDepthPeeling)|(TestTextureColor)|(TestDXF)|(TestScalarsCell)|(TestXCAFColors)|(TestGrid)|(TestConfig)|(TestGLTFDracoImporter)|(TestSDKInteractorCallBack)" >> $GITHUB_ENV
 
     - name: Test
       shell: bash

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

@@ -1,4 +1,4 @@
-name: 'Sanitzier CI'
+name: 'Sanitizer CI'
 description: 'Sanitizer CI'
 inputs:
   sanitizer_type:
@@ -78,6 +78,11 @@ runs:
         -DF3D_PLUGIN_BUILD_VDB=OFF
         -DF3D_SANITIZER=${{inputs.sanitizer_type}}
         -DF3D_STRICT_BUILD=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_EGL=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_GLFW=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_OSMESA=ON
+        -DF3D_TESTING_ENABLE_EXTERNAL_QT=ON
+        -DF3D_TESTING_ENABLE_GLX_TESTS=ON
         -DF3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS=ON
 
     - name: Build

.github/actions/vtk-install-dep/action.yml

@@ -13,10 +13,6 @@ inputs:
     description: 'Label to control raytracing'
     required: false
     default: 'no-raytracing'
-  egl_label:
-    description: 'Label to control egl'
-    required: false
-    default: 'no-egl'
   cpu:
     description: 'CPU architecture to build for'
     required: false
@@ -47,7 +43,7 @@ runs:
       uses: actions/cache@v4
       with:
         path: dependencies/vtk_install
-        key: vtk-${{env.VTK_SHA_OR_TAG}}-${{runner.os}}-${{inputs.raytracing_label}}-${{inputs.egl_label}}-${{inputs.cpu}}-8
+        key: vtk-${{env.VTK_SHA_OR_TAG}}-${{runner.os}}-${{inputs.raytracing_label}}-${{inputs.cpu}}-4
 
     - name: Setup VTK
       if: steps.cache-vtk.outputs.cache-hit != 'true'
@@ -68,6 +64,16 @@ runs:
         path: './dependencies/vtk'
         ref: ${{env.VTK_SHA_OR_TAG}}
 
+    # CMake 3.31 introduced a new policy producing a warning when using vtkModule.cmake
+    # See https://gitlab.kitware.com/vtk/vtk/-/issues/19526
+    - name: Patch VTK
+      if: steps.cache-vtk.outputs.cache-hit != 'true'
+      working-directory: ${{github.workspace}}/dependencies/vtk
+      shell: bash
+      run: |
+        cat $GITHUB_ACTION_PATH/set_cmp0177_policy.cmake CMake/vtkModule.cmake > patched.cmake
+        mv patched.cmake CMake/vtkModule.cmake
+
       # OpenVDB_CMAKE_PATH is required because of
       # https://github.com/AcademySoftwareFoundation/openvdb/issues/1160 and
       # https://gitlab.kitware.com/vtk/vtk/-/merge_requests/10393
@@ -86,7 +92,6 @@ runs:
         -DVTKOSPRAY_ENABLE_DENOISER=ON
         -DVTK_BUILD_TESTING=OFF
         -DVTK_DEBUG_LEAKS=ON
-        -DVTK_DEFAULT_RENDER_WINDOW_HEADLESS=${{ inputs.egl_label == 'egl' && 'ON' || 'OFF' }}
         -DVTK_ENABLE_LOGGING=OFF
         -DVTK_ENABLE_REMOTE_MODULES=OFF
         -DVTK_ENABLE_WRAPPING=OFF
@@ -116,7 +121,7 @@ runs:
         -DVTK_MODULE_ENABLE_VTK_RenderingRayTracing=${{ inputs.raytracing_label == 'raytracing' && 'YES' || 'DEFAULT' }}
         -DVTK_MODULE_ENABLE_VTK_RenderingVolumeOpenGL2=YES
         -DVTK_MODULE_ENABLE_VTK_TestingCore=YES
-        -DVTK_OPENGL_HAS_EGL=${{ inputs.egl_label == 'egl' && 'ON' || 'OFF' }}
+        -DVTK_OPENGL_HAS_EGL=${{ inputs.vtk_version != 'v9.2.6' && inputs.vtk_version != 'v9.3.1' && 'ON' || 'OFF' }}
         -DVTK_SMP_IMPLEMENTATION_TYPE=TBB
         -DVTK_VERSIONED_INSTALL=OFF
         ${{ runner.os == 'macOS' && '-DCMAKE_OSX_DEPLOYMENT_TARGET=10.15' || null }}

.github/actions/vtk-install-dep/set_cmp0177_policy.cmake

@@ -0,0 +1,4 @@
+# CMake 3.31 trigger a warning without this policy set
+if(POLICY CMP0174)
+  cmake_policy(SET CMP0174 OLD)
+endif()

.github/actions/vtk_commit_sha

@@ -1 +1 @@
-6a898fd91da30d3ff903416bf856f0d1cea82cdf
+aab695b6405fef4a7472039766ced36bd162221f

.github/workflows/ci.yml

@@ -86,35 +86,42 @@ jobs:
           - raytracing_label: raytracing
           - exclude_deprecated_label: no-exclude-deprecated
           - optional_deps_label: optional-deps
-          - egl_label: no-egl
+          - rendering_backend: auto
           - static_label: no-static
-          - build_type: headless
+          - build_type: egl
             vtk_version: commit
             raytracing_label: raytracing
             optional_deps_label: optional-deps
             exclude_deprecated_label: no-exclude-deprecated
-            egl_label: egl
+            rendering_backend: egl
+            static_label: no-static
+          - build_type: osmesa
+            vtk_version: commit
+            raytracing_label: raytracing
+            optional_deps_label: optional-deps
+            exclude_deprecated_label: no-exclude-deprecated
+            rendering_backend: osmesa
             static_label: no-static
           - build_type: exclude_deprecated
             vtk_version: commit
             raytracing_label: raytracing
             optional_deps_label: optional-deps
             exclude_deprecated_label: exclude-deprecated
-            egl_label: no-egl
+            rendering_backend: auto
             static_label: no-static
           - build_type: no_optional_deps
             vtk_version: commit
             raytracing_label: no-raytracing
             optional_deps_label: no-optional-deps
             exclude_deprecated_label: no-exclude-deprecated
-            egl_label: no-egl
+            rendering_backend: auto
             static_label: no-static
           - build_type: static_libs
             vtk_version: commit
             raytracing_label: no-raytracing
             optional_deps_label: optional-deps
             exclude_deprecated_label: no-exclude-deprecated
-            egl_label: no-egl
+            rendering_backend: auto
             static_label: static
 
     runs-on: ubuntu-latest
@@ -137,9 +144,9 @@ jobs:
         build_type: ${{matrix.build_type}}
         vtk_version: ${{matrix.vtk_version}}
         raytracing_label: ${{matrix.raytracing_label}}
+        rendering_backend: ${{matrix.rendering_backend}}
         optional_deps_label: ${{matrix.optional_deps_label}}
         exclude_deprecated_label: ${{matrix.exclude_deprecated_label}}
-        egl_label: ${{matrix.egl_label}}
         static_label: ${{matrix.static_label}}
         lfs_sha: ${{ needs.cache_lfs.outputs.lfs_sha}}
 
@@ -182,7 +189,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        vtk_version: [commit, v9.3.1, v9.2.6]
+        vtk_version: [commit, v9.3.1] # VTK 9.2.6 not compatible with recent clang version on macOS
         bundle_label: [no-bundle]
         static_label: [no-static]
         include:

.github/workflows/nightly_vtk_master.yml

@@ -98,10 +98,11 @@ jobs:
       matrix:
         build_type: [standard]
         include:
-          - egl_label: no-egl
-          - build_type: headless
-            egl_label: egl
-
+          - rendering_backend: auto
+          - build_type: egl
+            rendering_backend: egl
+          - build_type: osmesa
+            rendering_backend: osmesa
     runs-on: ubuntu-latest
     container: ghcr.io/f3d-app/f3d-ci
 
@@ -122,8 +123,7 @@ jobs:
         build_type: ${{matrix.build_type}}
         vtk_version: ${{needs.check_nightly.outputs.vtk_sha}}
         raytracing_label: 'raytracing'
-        exclude_deprecated_label: ${{matrix.exclude_deprecated_label}}
-        egl_label: ${{matrix.egl_label}}
+        rendering_backend: ${{matrix.rendering_backend}}
         lfs_sha: ${{ needs.cache_lfs.outputs.lfs_sha}}
 
 #----------------------------------------------------------------------------

.github/workflows/public-api-warn.yml

@@ -3,6 +3,7 @@ on:
   pull_request_target:
     paths:
       - 'library/public/*.h'
+      - 'library/public/*.h.in'
 
 jobs:
   public-api-warn:

.gitignore

@@ -1,13 +1,19 @@
-.vscode
+## This file should contain only F3D process related files and folder
+## For any files specific to user process, use either ~/.gitignore or .git/info/exclude instead
+# doc process related
 _site
-.vs
-CMakeUserPresets.json
-build/
+
+# scikit build related
 _skbuild
 dist
 *.egg-info
+
+# python usage related
 __pycache__
 *.pyc
+
+# python wheel process related
 _version.py
-.DS_Store
+
+# wasm process related
 node_modules

.lsan.supp

@@ -18,6 +18,9 @@ leak:TKernel
 # TBB
 leak:libtbb
 
+# OSMesa
+leak:libOSMesa
+
 # Potential mesa/VTK leak with incomplete callstack
 # forces us to hide all leaks from the tests using a render window
 # https://gitlab.kitware.com/vtk/vtk/-/issues/18504

.tsan.supp

@@ -14,3 +14,6 @@ race:libOpenEXR
 # dmon
 # https://github.com/septag/dmon/issues/33
 race:dmon.h
+
+# OSMesa
+race:libOSMesa

CMakeLists.txt

@@ -75,7 +75,7 @@ endif ()
 # VTK dependency
 # Optional components should list VTK modules
 # needed by plugins and optional modules
-find_package(VTK 9.0 REQUIRED
+find_package(VTK 9.2.6 REQUIRED
   COMPONENTS
     CommonCore
     CommonDataModel
@@ -99,14 +99,19 @@ find_package(VTK 9.0 REQUIRED
     RenderingVolumeOpenGL2
     TestingCore
     jsoncpp
-    opengl
   OPTIONAL_COMPONENTS
+    opengl
     IOExodus
     IOOpenVDB
     RenderingExternal
     RenderingRayTracing)
 message(STATUS "VTK ${VTK_VERSION} found")
 
+if(VTK_VERSION VERSION_LESS 9.3.20240914)
+  # Not optional before
+  find_package(VTK REQUIRED COMPONENTS opengl)
+endif()
+
 # Shared options between application and library
 include(GNUInstallDirs)
 cmake_dependent_option(F3D_WINDOWS_GUI "Build a non-console Win32 application" ON "WIN32" OFF)
@@ -184,10 +189,18 @@ list(APPEND f3d_link_options_public ${f3d_sanitizer_link_options})
 option(BUILD_TESTING "Build the tests" OFF)
 cmake_dependent_option(F3D_TESTING_ENABLE_RENDERING_TESTS "Enable rendering tests" ON "BUILD_TESTING" OFF)
 cmake_dependent_option(F3D_TESTING_ENABLE_LONG_TIMEOUT_TESTS "Enable long timeout tests" OFF "BUILD_TESTING" OFF)
+cmake_dependent_option(F3D_TESTING_ENABLE_GLX_TESTS "Enable test that require a X server running on Linux" ON "F3D_TESTING_ENABLE_RENDERING_TESTS AND UNIX AND NOT APPLE" OFF)
 if(BUILD_TESTING)
   enable_testing()
 endif()
 
+# Testing offscreen backend
+if(NOT F3D_TESTING_FORCE_RENDERING_BACKEND)
+  set(F3D_TESTING_FORCE_RENDERING_BACKEND "auto" CACHE STRING "Force testing offscreen backend" FORCE)
+  set_property(CACHE F3D_TESTING_FORCE_RENDERING_BACKEND PROPERTY STRINGS "auto" "egl" "osmesa")
+endif()
+mark_as_advanced(F3D_TESTING_FORCE_RENDERING_BACKEND)
+
 # Figure out F3D configuration directory
 if(UNIX AND NOT APPLE)
   option(F3D_LINUX_INSTALL_DEFAULT_CONFIGURATION_FILE_IN_PREFIX "Install the default configuration at the prefix root instead of system wide" OFF)