Merge pull request #3 from kostrykin/develop

Towards 3.3.3

Author: kostrykin

.gitattributes

@@ -0,0 +1,3 @@
+include/Carna/base/GL/* linguist-vendored
+test/* linguist-vendored
+docs/* linguist-generated

.github/workflows/build.yml

@@ -0,0 +1,97 @@
+name: Build
+
+on:
+  push:
+    branches: [ 'master', 'develop' ]
+    paths-ignore:
+      - 'docs/**'
+      - '.git*'
+      - 'LICENSE'
+      - 'LICENSE-*'
+      - 'README.md'
+
+  pull_request:
+    branches-ignore: [ 'master' ]
+
+jobs:
+  linux_build:
+    if: |
+      ${{
+        (
+          github.event_name == 'push' && github.ref == 'refs/heads/master'
+        ) || (
+          github.event_name == 'pull_request'
+        )
+      }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        variant: ['default', 'egl']
+        build: ['debug', 'release']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install dependencies for Carna build
+      run: sudo apt-get install libeigen3-dev libglfw3-dev libgl1-mesa-dev libglu1-mesa-dev libglew-dev
+
+    - name: Install dependencies for demo and tests
+      if: ${{ matrix.variant == 'default' }}
+      run: sudo apt-get install qtbase5-dev libboost-iostreams-dev xvfb
+
+    - name: Setup to use xvfb
+      if: ${{ matrix.variant == 'default' }}
+      id: setup
+      run: echo "prefix=xvfb-run" >> $GITHUB_OUTPUT
+
+    - run: ${{ steps.setup.outputs.prefix }} ./linux_build-${{ matrix.variant }}.bash
+      env:
+        BUILD: only_${{ matrix.build }}
+
+    - uses: actions/upload-artifact@v4
+      if: failure()
+      with:
+        name: ${{ matrix.variant }}-${{ matrix.build }}-test_output
+        path: build/make_${{ matrix.build }}/test/test_output/
+
+    - name: Test FindCarna.cmake
+      if: ${{ matrix.variant == 'egl' }}
+      run: ./test.sh ${{ matrix.build }}
+      working-directory: test_cmake
+
+  build_docs:
+    if: |
+      ${{
+        (
+          github.event_name == 'push' && github.ref == 'refs/heads/develop'
+        ) || (
+          github.event_name == 'pull_request'
+        )
+      }}
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install dependencies
+      run: sudo apt-get install libeigen3-dev libglfw3-dev libgl1-mesa-dev libglu1-mesa-dev libglew-dev doxygen
+
+    - run: rm -rf docs
+
+    - run: ./linux_build-egl.bash
+      env:
+        BUILD: only_release
+
+    - uses: peter-evans/create-pull-request@v7
+      if: ${{ github.event_name == 'push' }}
+      with:
+        branch: __build_docs
+        branch-suffix: random
+        commit-message: Update documentation
+        title: Update documentation
+        labels: documentation
+        body: |
+          Auto-update the documentation.
+
+          Triggered by: ${{ github.sha }}

.gitignore

@@ -1,4 +1,5 @@
 /build
+/test_cmake/build
 /include/Carna/Version.h
 /src/doc/Doxyfile
 *~

CMakeLists.txt

@@ -3,7 +3,7 @@ project(Carna)
 
 set(MAJOR_VERSION	3)
 set(MINOR_VERSION	3)
-set(PATCH_VERSION	2)
+set(PATCH_VERSION	3)
 
 ############################################
 

README.md

@@ -1,5 +1,5 @@
 Carna
-========
+=====
 
 Carna provides classes for simple and fast visualization of CT data.
 It is named after the greek god of organs (yup, they really did have even one for organs).
@@ -18,45 +18,31 @@ Go to: [Library Documentation](https://kostrykin.github.io/Carna/html)
 ---
 ## 1. Dependencies
 
-* [Eigen](http://eigen.tuxfamily.org/) ≥ 3.0.5
-* OpenGL 3.3
-* GLEW ≥ 1.7
+* **OpenGL ≥ 3.3** (tested with up to 4.6)
+* **GLEW ≥ 1.7**
+* **Eigen** ≥ 3.0.5
+
+In addition, building the demo or the test suite also requires the following libraries:
+
+* **libboost-iostreams** (tested with 1.83.0, older versions might work too)
+* **Qt ≥ 4** (tested with up to Qt 5.15.13)
 
 Compilation process has been tested with following tool chains:
 
-* **GCC 7.5:** is known to be fully supported.
+* **GCC 7.5** (tested 2021)
+* **GCC 13.3 + CMake 3.28.3** (tested 2025)
 
 ---
 ## 2. Build instructions
 
-On Linux you can run the `linux_build.sh` script.
+On Linux you can run either of the two build scripts:
+- `linux_build-default.sh`: Runs the default build, which includes the demo and the test suite. Also runs the tests. Carna is built without EGL support for offscreen rendering.
+- `linux_build-egl.sh`: Builds Carna with EGL support, but skips the demo and the test suite. This is becaue the demo and the test suite are built with Qt, which cannot be initialized when Carna is built with EGL support.
 
 ---
 ## 3. Including in your project
 
-Add a `find_package` directive to your project's `CMakeLists.txt` file, e.g.:
-
-```CMake
-find_package( Carna REQUIRED )
-include_directories( ${CARNA_INCLUDE_DIR} )
-```
-
-If you need to put a constraint on the version, use `find_package(Carna 3.1.0 REQUIRED)`
-to pick a package with a version *compatible* to 3.1.0,
-or use `find_package(Carna 3.1.0 EXACT REQUIRED)` to pick a package by the exact version.
-
-You also need to add the headers (usually *only* the headers) from Eigen:
-
-```CMake
-find_package( Eigen3 REQUIRED )
-include_directories( ${EIGEN3_INCLUDE_DIR} )
-```
-
-Finally add Carna to the linking stage:
-
-```CMake
-target_link_libraries( ${TARGET_NAME} ${SOME_OTHER_LIBRARIES} ${CARNA_LIBRARIES} )
-```
+See *test_cmake/CMakeLists.txt* as a starting point.
 
 ---
 ## 4. See also

docs/.nojekyll

@@ -1,9 +1,9 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.13"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen 1.9.8"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>Carna: include/Carna/base/Aggregation.h File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -13,11 +13,12 @@
 <script type="text/javascript" src="search/searchdata.js"></script>
 <script type="text/javascript" src="search/search.js"></script>
 <script type="text/x-mathjax-config">
-  MathJax.Hub.Config({
-    extensions: ["tex2jax.js"],
-    jax: ["input/TeX","output/HTML-CSS"],
+MathJax.Hub.Config({
+  extensions: ["tex2jax.js"],
+  jax: ["input/TeX","output/HTML-CSS"],
 });
-</script><script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
+</script>
+<script type="text/javascript" async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 <link href="doc_extra.css" rel="stylesheet" type="text/css"/>
 </head>
@@ -26,28 +27,32 @@
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
- <tr style="height: 56px;">
-  <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">Carna
-   &#160;<span id="projectnumber">Version 3.3.2</span>
+ <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
+  <td id="projectalign">
+   <div id="projectname">Carna<span id="projectnumber">&#160;Version 3.3.3</span>
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
+<!-- Generated by Doxygen 1.9.8 -->
 <script type="text/javascript">
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "search/",'.html');
+/* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
+/* @license-end */
 </script>
 <div id="main-nav"></div>
 <!-- window showing the filter options -->
@@ -59,9 +64,16 @@
 
 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
-<iframe src="javascript:void(0)" frameborder="0" 
-        name="MSearchResults" id="MSearchResults">
-</iframe>
+<div id="MSearchResults">
+<div class="SRPage">
+<div id="SRIndex">
+<div id="SRResults"></div>
+<div class="SRStatus" id="Loading">Loading...</div>
+<div class="SRStatus" id="Searching">Searching...</div>
+<div class="SRStatus" id="NoMatches">No Matches</div>
+</div>
+</div>
+</div>
 </div>
 
 <div id="nav-path" class="navpath">
@@ -73,8 +85,7 @@
   <div class="summary">
 <a href="#nested-classes">Classes</a> &#124;
 <a href="#namespaces">Namespaces</a>  </div>
-  <div class="headertitle">
-<div class="title">Aggregation.h File Reference</div>  </div>
+  <div class="headertitle"><div class="title">Aggregation.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">
 
@@ -86,52 +97,27 @@
 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
 </div>
 <div id="dynsection-0-content" class="dyncontent" style="display:none;">
-<div class="center"><img src="Aggregation_8h__incl.png" border="0" usemap="#include_2Carna_2base_2Aggregation_8h" alt=""/></div>
-<map name="include_2Carna_2base_2Aggregation_8h" id="include_2Carna_2base_2Aggregation_8h">
-<area shape="rect" id="node2" href="Association_8h.html" title="Defines Carna::base::Association. " alt="" coords="73,95,245,121"/>
-<area shape="rect" id="node3" href="Carna_8h_source.html" title="Carna/Carna.h" alt="" coords="23,169,129,196"/>
-<area shape="rect" id="node6" href="noncopyable_8h.html" title="Carna/base/noncopyable.h" alt="" coords="154,169,331,196"/>
-</map>
+<div class="center"><img src="Aggregation_8h__incl.png" border="0" usemap="#ainclude_2Carna_2base_2Aggregation_8h" alt=""/></div>
 </div>
 </div><div class="textblock"><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
   <img id="dynsection-1-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
 <div id="dynsection-1-summary" class="dynsummary" style="display:block;">
 </div>
 <div id="dynsection-1-content" class="dyncontent" style="display:none;">
-<div class="center"><img src="Aggregation_8h__dep__incl.png" border="0" usemap="#include_2Carna_2base_2Aggregation_8hdep" alt=""/></div>
-<map name="include_2Carna_2base_2Aggregation_8hdep" id="include_2Carna_2base_2Aggregation_8hdep">
-<area shape="rect" id="node2" href="FrameRenderer_8h.html" title="Defines Carna::base::FrameRenderer. " alt="" coords="1017,184,1151,225"/>
-<area shape="rect" id="node13" href="MeshColorCodingStage_8h.html" title="Defines Carna::presets::MeshColorCodingStage. " alt="" coords="1066,363,1241,404"/>
-<area shape="rect" id="node19" href="RenderStageSequence_8h.html" title="Defines Carna::base::RenderStageSequence. " alt="" coords="1121,95,1292,136"/>
-<area shape="rect" id="node3" href="GeometryStage_8h.html" title="Defines Carna::base::GeometryStage. " alt="" coords="893,273,1027,315"/>
-<area shape="rect" id="node4" href="MeshRenderingStage_8h.html" title="Defines Carna::base::MeshRenderingStage. " alt="" coords="879,363,1041,404"/>
-<area shape="rect" id="node12" href="CuttingPlanesStage_8h.html" title="Defines Carna::presets::CuttingPlanesStage. " alt="" coords="701,363,854,404"/>
-<area shape="rect" id="node14" href="VolumeRenderingStage_8h.html" title="Defines Carna::presets::VolumeRenderingStage. " alt="" coords="339,363,514,404"/>
-<area shape="rect" id="node5" href="FrameRendererHelper_8h.html" title="Defines Carna::helpers::FrameRendererHelper. " alt="" coords="1135,452,1300,493"/>
-<area shape="rect" id="node6" href="OpaqueRenderingStage_8h.html" title="Defines Carna::presets::OpaqueRenderingStage. " alt="" coords="935,452,1110,493"/>
-<area shape="rect" id="node10" href="TransparentRenderingStage_8h.html" title="Defines Carna::presets::TransparentRenderingStage. " alt="" coords="713,452,911,493"/>
-<area shape="rect" id="node7" href="MeshColorCodingStageTest_8h_source.html" title="test/ModuleTests/MeshColor\lCodingStageTest.h" alt="" coords="1037,541,1227,583"/>
-<area shape="rect" id="node8" href="OpaqueRenderingStageTest_8h_source.html" title="test/ModuleTests/OpaqueRendering\lStageTest.h" alt="" coords="1251,541,1482,583"/>
-<area shape="rect" id="node9" href="PointMarkerHelperTest_8h_source.html" title="test/ModuleTests/PointMarker\lHelperTest.h" alt="" coords="815,541,1012,583"/>
-<area shape="rect" id="node11" href="TransparentRenderingStageTest_8h_source.html" title="test/ModuleTests/Transparent\lRenderingStageTest.h" alt="" coords="594,541,790,583"/>
-<area shape="rect" id="node15" href="DRRStage_8h.html" title="Defines Carna::presets::DRRStage. " alt="" coords="179,452,328,493"/>
-<area shape="rect" id="node16" href="DVRStage_8h.html" title="Defines Carna::presets::DVRStage. " alt="" coords="352,452,501,493"/>
-<area shape="rect" id="node17" href="MaskRenderingStage_8h.html" title="Defines Carna::presets::MaskRenderingStage. " alt="" coords="525,452,688,493"/>
-<area shape="rect" id="node18" href="MIPStage_8h.html" title="Defines Carna::presets::MIPStage. " alt="" coords="5,452,155,493"/>
-</map>
+<div class="center"><img src="Aggregation_8h__dep__incl.png" border="0" usemap="#ainclude_2Carna_2base_2Aggregation_8hdep" alt=""/></div>
 </div>
 </div>
 <p><a href="Aggregation_8h_source.html">Go to the source code of this file.</a></p>
 <table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
 Classes</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCarna_1_1base_1_1Aggregation.html">Carna::base::Aggregation&lt; AssociatedObjectType &gt;</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an aggregation, i.e. a weak reference.  <a href="classCarna_1_1base_1_1Aggregation.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
 Namespaces</h2></td></tr>
-<tr class="memitem:namespaceCarna_1_1base"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCarna_1_1base.html">Carna::base</a></td></tr>
+<tr class="memitem:namespaceCarna_1_1base" id="r_namespaceCarna_1_1base"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCarna_1_1base.html">Carna::base</a></td></tr>
 <tr class="memdesc:namespaceCarna_1_1base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the core framework components. <br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>