Update polyscope viewer with an error if DGTAL_WITH_POLYSCOPE_VIEWER is missing

.github/actions/dgtal-config/action.yml

@@ -50,13 +50,13 @@ runs:
       if: ${{ runner.os == 'Linux' && inputs.config-name == 'PR' }}
       shell: bash
       run: |
-        echo "DGTAL_CMAKE_CONFIG=-DDGTAL_BUILD_TESTS=true -DDGTAL_BUILD_EXAMPLES=true -DDGTAL_BUILD_POLYSCOPE_EXAMPLES=true -DUSE_CCACHE=NO -DDGTAL_WITH_CGAL=true -DDGTAL_WITH_LIBIGL=true -DDGTAL_WITH_FFTW3=true -DDGTAL_WITH_HDF5=true -DDGTAL_WITH_OPENMP=true  -DDGTAL_WITH_POLYSCOPE_VIEWER=true  -DDGTAL_WITH_CAIRO=true -DDGTAL_WITH_ITK=true -DDGTAL_ENABLE_FLOATING_POINT_EXCEPTIONS=true -DDGTAL_WARNING_AS_ERROR=ON -G Ninja" >> "$GITHUB_ENV"
+        echo "DGTAL_CMAKE_CONFIG=-DDGTAL_BUILD_TESTS=true -DDGTAL_BUILD_EXAMPLES=true -DUSE_CCACHE=NO -DDGTAL_WITH_CGAL=true -DDGTAL_WITH_LIBIGL=true -DDGTAL_WITH_FFTW3=true -DDGTAL_WITH_HDF5=true -DDGTAL_WITH_OPENMP=true  -DDGTAL_WITH_POLYSCOPE_VIEWER=true  -DDGTAL_WITH_CAIRO=true -DDGTAL_WITH_ITK=true -DDGTAL_ENABLE_FLOATING_POINT_EXCEPTIONS=true -DDGTAL_WARNING_AS_ERROR=ON -G Ninja" >> "$GITHUB_ENV"
 
     - name: "PR MacOS"
       if: ${{ runner.os == 'macOS' && inputs.config-name == 'PR' }}
       shell: bash
       run: |
-        echo "DGTAL_CMAKE_CONFIG=-DDGTAL_BUILD_TESTS=true -DDGTAL_BUILD_EXAMPLES=true -DDGTAL_BUILD_POLYSCOPE_EXAMPLES=true -DUSE_CCACHE=NO -DDGTAL_WITH_CGAL=true -DDGTAL_WITH_LIBIGL=true" >> "$GITHUB_ENV"
+        echo "DGTAL_CMAKE_CONFIG=-DDGTAL_BUILD_TESTS=true -DDGTAL_BUILD_EXAMPLES=true -DUSE_CCACHE=NO -DDGTAL_WITH_CGAL=true -DDGTAL_WITH_LIBIGL=true" >> "$GITHUB_ENV"
 
     - name: "PR Windows"
       if: ${{ runner.os == 'Windows' && inputs.config-name == 'PR' }}

ChangeLog.md

@@ -15,6 +15,7 @@ git remote set-head origin -a
 
 - *IO*
   - Polyscope viewer upgraded from 2.4 to 2.5 (David Coeurjolly,  [#1796](https://github.com/DGtal-team/DGtal/pull/1796)). Reverting to 2.4  due to build issues (David Coeurjolly,  [#1797](https://github.com/DGtal-team/DGtal/pull/1797))
+  - The DGTAL_BUILD_POLYSCOPE_EXAMPLES option has been removed. If the polyscope viewer is enabled (DGTAL_WITH_POLYSCOPE_VIEWER), the polyscope examples are automatically built (David Coeurjolly, [#1814](https://github.com/DGtal-team/DGtal/pull/1814))
 
 - *Documentation*
   - Refactoring of the volumetric examples in the Shortcuts (David Coeurjolly, [#1807](https://github.com/DGtal-team/DGtal/pull/1807))
@@ -36,6 +37,10 @@ git remote set-head origin -a
   - Cleaning up the Github Actions reuses (Bastien Doignies, [#1793](https://github.com/DGtal-team/DGtal/pull/1793))
   - Add cache to github actions (Bastien Doignies, [#1805](https://github.com/DGtal-team/DGtal/pull/1805))
 
+- *IO*
+  - Error is raised if the polyscope viewer is used without the DGTAL_WITH_POLYSCOPE_VIEWER flag (David Coeurjolly, [#1814](https://github.com/DGtal-team/DGtal/pull/1814))
+  - Replacing  DGTAL_WITH_POLYSCOPE with DGTAL_WITH_POLYSCOPE_VIEWER flags (David Coeurjolly, [#1814](https://github.com/DGtal-team/DGtal/pull/1814))
+
 - *Python*
   - Build backend upgraded to scikit-build-core (Bastien Doignies, [#1804](https://github.com/DGtal-team/DGtal/pull/1804))
   - New CI for pypi deployement with cibuildwheel (Bastien Doignies, [#1804](https://github.com/DGtal-team/DGtal/pull/1804))

cmake/BuildExamples.cmake

@@ -14,10 +14,10 @@ if (DGTAL_BUILD_EXAMPLES)
   # -----------------------------------------------------------------------------
   # polyscope examples
   # -----------------------------------------------------------------------------
-  option(DGTAL_BUILD_POLYSCOPE_EXAMPLES "Build polyscope examples." OFF)
-  if (DGTAL_BUILD_POLYSCOPE_EXAMPLES )
-    message(STATUS "Build polyscope examples ENABLED (DGTAL_BUILD_POLYSCOPE_EXAMPLES)")
+  if (DGTAL_WITH_POLYSCOPE_VIEWER)
+    message(STATUS "Build polyscope examples ENABLED (DGTAL_WITH_POLYSCOPE_VIEWER)")
   else()
-    message(STATUS "Build polyscope examples DISABLED (DGTAL_BUILD_POLYSCOPE_EXAMPLES)")
+    message(STATUS "Build polyscope examples DISABLED (DGTAL_WITH_POLYSCOPE_VIEWER)")
   endif()
 endif()
+message(STATUS "-------------------------------------------------------------------------------")

cmake/CheckDGtalOptionalDependencies.cmake

@@ -207,13 +207,12 @@ endif()
 # Look for Polyscope.
 # -----------------------------------------------------------------------------
 set(POLYSCOPE_FOUND_DGTAL 0)
-if (DGTAL_WITH_POLYSCOPE_VIEWER OR DGTAL_BUILD_POLYSCOPE_EXAMPLES)
+if (DGTAL_WITH_POLYSCOPE_VIEWER)
   include(polyscope)
 
   target_link_libraries(DGtal PUBLIC polyscope)
-  target_compile_definitions(DGtal PUBLIC -DDGTAL_WITH_POLYSCOPE)
+  target_compile_definitions(DGtal PUBLIC -DDGTAL_WITH_POLYSCOPE_VIEWER)
   set(POLYSCOPE_FOUND_DGTAL 1)
-  set(DGTAL_WITH_POLYSCOPE 1)
   set(DGTAL_WITH_POLYSCOPE_VIEWER 1)
 endif()
 

cmake/Install.cmake

@@ -85,7 +85,7 @@ foreach(dep ${_dependencies_list})
   endif()
 endforeach()
 
-message("DGtal version = ${DGTAL_VERSION}")
+message(STATUS "DGtal version = ${DGtal_VERSION}")
 write_basic_package_version_file(
   "${CMAKE_CURRENT_BINARY_DIR}/DGtalConfigVersion.cmake"
   VERSION "${DGTAL_VERSION}"

examples/doc-examples/CMakeLists.txt

@@ -13,7 +13,7 @@ if (DGTAL_BUILD_TESTS)
 endif()
 
 
-if( DGTAL_WITH_POLYSCOPE  )
+if( DGTAL_WITH_POLYSCOPE_VIEWER  )
   set(DGTAL_EXAMPLES_POLYSCOPE_SRC
      )
 

examples/geometry/curves/CMakeLists.txt

@@ -28,7 +28,7 @@ foreach(FILE ${DGTAL_EXAMPLES_SRC})
 endforeach()
 
 ### Test with Polyscope viewer
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER)
    set(DGTAL_EXAMPLES_POLYSCOPE_SRC
      exampleArithDSS3d
      exampleGridCurve3d

examples/geometry/curves/exampleArithDSS3d.cpp

@@ -85,7 +85,7 @@ int main()
   //display  
   Point p;
 
-#ifdef DGTAL_WITH_POLYSCOPE
+#ifdef DGTAL_WITH_POLYSCOPE_VIEWER
 
   PolyscopeViewer viewer;
   viewer.allowReuseList = true; // groups segments
@@ -96,7 +96,7 @@ int main()
   Decomposition::SegmentComputerIterator i = theDecomposition.begin();
   for ( ; i != theDecomposition.end(); ++i) {
     SegmentComputer currentSegmentComputer(*i);
-     #ifdef DGTAL_WITH_POLYSCOPE
+     #ifdef DGTAL_WITH_POLYSCOPE_VIEWER
        viewer.drawAsBalls();
        viewer << currentSegmentComputer;  
        viewer.defaultStyle();
@@ -106,7 +106,7 @@ int main()
   } 
 
 
-  #ifdef DGTAL_WITH_POLYSCOPE
+  #ifdef DGTAL_WITH_POLYSCOPE_VIEWER
     viewer.show();
   #endif
 

examples/geometry/curves/exampleGridCurve3d.cpp

@@ -56,7 +56,7 @@ This command line produces the following output (points are displayed as voxels)
 #include "ConfigExamples.h"
 #include "DGtal/geometry/curves/GridCurve.h"
 
-#ifdef DGTAL_WITH_POLYSCOPE
+#ifdef DGTAL_WITH_POLYSCOPE_VIEWER
   #include "DGtal/io/viewers/PolyscopeViewer.h"
 #endif
 ///////////////////////////////////////////////////////////////////////////////
@@ -101,7 +101,7 @@ int main( int argc, char** argv )
   inputStream.close();
   //! [GridCurveFromDataFile]
 
-#ifdef DGTAL_WITH_POLYSCOPE
+#ifdef DGTAL_WITH_POLYSCOPE_VIEWER
   PolyscopeViewer<Space,K3> viewer(ks);
 
   if (type == "gridcurve")

examples/geometry/curves/exampleParamCurve3dDigitization.cpp

@@ -39,7 +39,7 @@
 #include "DGtal/geometry/curves/parametric/NaiveParametricCurveDigitizer3D.h"
 //! [DigiHelixHeader]
 
-#ifdef DGTAL_WITH_POLYSCOPE
+#ifdef DGTAL_WITH_POLYSCOPE_VIEWER
   #include "DGtal/io/viewers/PolyscopeViewer.h"
 #endif
 

examples/geometry/curves/exampleParamCurve3dDigitizationTransformationDecorator.cpp

@@ -40,7 +40,7 @@
 #include "DGtal/images/RigidTransformation3D.h"
 //! [DigiRotHelixHeader]
 
-#ifdef DGTAL_WITH_POLYSCOPE
+#ifdef DGTAL_WITH_POLYSCOPE_VIEWER
 #include "DGtal/io/viewers/PolyscopeViewer.h"
 #endif
 

examples/geometry/curves/exampleTrofoliKnot.cpp

@@ -37,7 +37,7 @@
 #include "DGtal/geometry/curves/parametric/Knot_3_1.h"
 #include "DGtal/geometry/curves/parametric/NaiveParametricCurveDigitizer3D.h"
 
-#ifdef DGTAL_WITH_POLYSCOPE
+#ifdef DGTAL_WITH_POLYSCOPE_VIEWER
 #include "DGtal/io/viewers/PolyscopeViewer.h"
 #endif
 
@@ -75,7 +75,7 @@ int main()
 
  trace.info() << "exampleParamCurve3dDigitization" << endl;
 
- PolyscopeViewer<> viewer;
+ PolyscopeViewer viewer;
 
  MyDigitalCurve digitalCurve;
  MyMetaData metaData;

examples/geometry/surfaces/CMakeLists.txt

@@ -13,7 +13,7 @@ endforeach()
 
 
 ### with polyscope viewer
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER )
    set(DGTAL_EXAMPLES_POLYSCOPE_SRC
 	greedy-plane-segmentation
 	greedy-plane-segmentation-ex2

examples/geometry/volumes/CMakeLists.txt

@@ -14,7 +14,7 @@ foreach(FILE ${DGTAL_EXAMPLES_SRC})
      DGtal_add_example(${FILE})
 endforeach()
 
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER )
    set( DGTAL_EXAMPLES_POLYSCOPE_SRC
       fullConvexityAnalysis3D
       fullConvexityThinning3D

examples/geometry/volumes/distance/CMakeLists.txt

@@ -10,7 +10,7 @@ foreach(FILE ${DGTAL_EXAMPLES_SRC})
      DGtal_add_example(${FILE})
 endforeach()
 
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER )
    set(DGTAL_EXAMPLES_POLYSCOPE_SRC
   distancetransform3D
   exampleFMM3D

examples/graph/CMakeLists.txt

@@ -7,7 +7,7 @@ foreach(FILE ${DGTAL_EXAMPLES_TOPO_SRC})
 endforeach()
 
 
-if ( DGTAL_WITH_POLYSCOPE )
+if ( DGTAL_WITH_POLYSCOPE_VIEWER )
    set(DGTAL_EXAMPLES_POLYSCOPE_SRC
      volDistanceTraversal
    )

examples/io/CMakeLists.txt

@@ -1,4 +1,4 @@
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER )
   set(DGTAL_EXAMPLES_POLYSCOPE_SRC
     digitalSetFromVol
     digitalSetFromPointList

examples/io/external-viewers/polyscope/CMakeLists.txt

@@ -1,11 +1,7 @@
-if (NOT DGTAL_BUILD_POLYSCOPE_EXAMPLES)
+if (NOT DGTAL_WITH_POLYSCOPE_VIEWER)
   return()
 endif()
 
-if (NOT TARGET polyscope)
-  # Fetch library
-  include(polyscope)
-endif()
 
 set(DGTAL_EXAMPLES_POLYSCOPE_SRC
   dgtalCalculus

examples/io/external-viewers/polyscope/dgtalCalculus-poisson.cpp

@@ -124,11 +124,11 @@ int main()
                       positions.end(),
                       faces.begin(),
                       faces.end());
-  psMesh = polyscope::registerSurfaceMesh("digital surface", positions, faces);
-
   // Initialize polyscope
   polyscope::init();
 
+  psMesh = polyscope::registerSurfaceMesh("digital surface", positions, faces);
+
   // Set the callback function
   polyscope::state::userCallback = myCallback;
   polyscope::show();

examples/io/external-viewers/polyscope/dgtalCalculus-single.cpp

@@ -137,13 +137,14 @@ int main()
                       faces.begin(),
                       faces.end());
 
+  // Initialize polyscope
+  polyscope::init();
+
   psVertices = polyscope::registerPointCloud("Vertices", positions);
 
   std::vector<std::array<size_t,2>> edges={{0,1},{1,2},{2,3},{3,4},{4,0} };
   psBoundary = polyscope::registerCurveNetwork("Edges", positions, edges);
 
-  // Initialize polyscope
-  polyscope::init();
 
   psMesh = polyscope::registerSurfaceMesh("Single face", positions, faces);
 

examples/topology/CMakeLists.txt

@@ -21,7 +21,7 @@ foreach(FILE ${DGTAL_EXAMPLES_TOPO_SRC})
 endforeach()
 
 
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER )
    set(DGTAL_EXAMPLES_POLYSCOPE_SRC
      cubical-complex-collapse
      homotopicThinning3D

examples/tutorial-examples/CMakeLists.txt

@@ -19,7 +19,7 @@ foreach(FILE ${DGTAL_TUTO_EXAMPLES_SRC})
    endif()
 endforeach()
 
-if (DGTAL_WITH_POLYSCOPE)
+if (DGTAL_WITH_POLYSCOPE_VIEWER)
   set(DGTAL_TUTO_EXAMPLES_POLYSCOPE_SRC
     shapeDTViewer
     volDTGranulo

src/DGtal/base/Common.h

@@ -139,7 +139,7 @@ namespace DGtal
 
   template < class Space, class KSpace>  class Display3D;
 
-#if defined( DGTAL_WITH_POLYSCOPE )
+#if defined( DGTAL_WITH_POLYSCOPE_VIEWER )
   template < class Space, class KSpace> class PolyscopeViewer;
 #endif
 

src/DGtal/dec/doc/modulePolygonalCalculus.dox

@@ -49,7 +49,7 @@ https://en.wikipedia.org/wiki/Laplace–Beltrami_operator
 
 @note All illustrations below have been obtained using the
 DGtal+[polyscope](https://polyscope.run) examples \ref
-dgtalCalculus.cpp, \ref dgtalCalculus-single.cpp and \ref dgtalCalculus-poisson.cpp. To build these examples, enable the `DGTAL_BUILD_POLYSCOPE_EXAMPLES` variable (e.g. `cmake .. -DDGTAL_BUILD_POLYSCOPE_EXAMPLES=ON`).
+dgtalCalculus.cpp, \ref dgtalCalculus-single.cpp and \ref dgtalCalculus-poisson.cpp. To build these examples, enable the `DGTAL_WITH_POLYSCOPE_VIEWER` variable (e.g. `cmake .. -DDGTAL_WITH_POLYSCOPE_VIEWER=ON`).
 
 @warning The implementation heavily relies on implicit operators with many Eigen based small matrice constructions, which has a huge overhead in Debug mode. Please consider to build the examples in Release (*e.g.* `CMAKE_BUILD_TYPE` variable) for high performance on large geometrical objects.
 

src/DGtal/io/doc/migratingViewer3D.dox

@@ -14,6 +14,8 @@ namespace DGtal {
 
 [TOC]
 
+@warning Do not forget to enable Polyscope at the `cmake` step, e.g. with `cmake .. -DDGTAL_WITH_POLYSCOPE_VIEWER=true`.
+
 \section DGtalMigration_Intro Introduction and features changes
 
 With version 2.0 of DGtal, the internal and external structures of 3D visualization have been completely changed. The aim is to take advantage of the advanced features of Polyscope, a geometric object viewer. 

src/DGtal/io/doc/moduleDisplay3D.dox

@@ -29,6 +29,8 @@ namespace DGtal {
   embedding mechanism to convert digital objects to structures in @f$
   \mathbb{R}^n@f$.
 
+@warning Do not forget to enable Polyscope at the `cmake` step, e.g. with `cmake .. -DGTAL_WITH_POLYSCOPE_VIEWER=true`.
+
 
 \section DGtalGLV_PolyscopeViewer Interactive visualization from PolyscopeViewer
 

src/DGtal/io/viewers/PolyscopeViewer.h

@@ -25,6 +25,10 @@
  * This file is part of the DGtal library.
  */
 
+#if !defined(DGTAL_WITH_POLYSCOPE_VIEWER)
+#error DGTAL_WITH_POLYSCOPE_VIEWER flag not set during the cmake step
+#endif 
+
 #include "DGtal/io/Display3D.h"
 
 #include "polyscope/polyscope.h"

tests/geometry/surfaces/CMakeLists.txt

@@ -38,7 +38,7 @@ if (   DGTAL_WITH_CGAL )
 endif()
 
 
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER )
   set(POLYSCOPE_VIEWER_TESTS_SRC
     testLocalConvolutionNormalVectorEstimator
     testTensorVotingViewer)

tests/geometry/surfaces/testSphericalHoughNormalVectorEstimator.cpp

@@ -44,7 +44,7 @@
 #include "DGtal/geometry/surfaces/estimation/LocalEstimatorFromSurfelFunctorAdapter.h"
 #include "DGtal/geometry/surfaces/estimation/estimationFunctors/SphericalHoughNormalVectorEstimator.h"
 
-#ifdef DGTAL_WITH_POLYSCOPE
+#ifdef DGTAL_WITH_POLYSCOPE_VIEWER
   #include "DGtal/io/viewers/PolyscopeViewer.h"
 #endif
 

tests/geometry/tools/CMakeLists.txt

@@ -19,7 +19,7 @@ foreach(FILE ${DGTAL_TESTS_SRC})
 endforeach()
 
 
-if (DGTAL_WITH_POLYSCOPE)
+if (DGTAL_WITH_POLYSCOPE_VIEWER)
   foreach(FILE ${DGTAL_TESTS_VSRC})
     DGtal_add_test(${FILE} ONLY_ADD_EXECUTABLE)
   endforeach()

tests/io/viewers/CMakeLists.txt

@@ -11,7 +11,7 @@ set(VIEWER_BASED_TESTS_SRC
   testDisplayKSCell
   )
 
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER )
   foreach(FILE ${VIEWER_BASED_TESTS_SRC})
     DGtal_add_test(${FILE} ONLY_ADD_EXECUTABLE)
   endforeach()

tests/shapes/CMakeLists.txt

@@ -5,7 +5,7 @@ set(VIEWER_BASED_TESTS_SRC
  testMeshDisplay
    )
 
-if (  DGTAL_WITH_POLYSCOPE )
+if (  DGTAL_WITH_POLYSCOPE_VIEWER )
   foreach(FILE ${VIEWER_BASED_TESTS_SRC})
     DGtal_add_test(${FILE} ONLY_ADD_EXECUTABLE)
     #not a test since IHM
@@ -56,7 +56,7 @@ set(POLYSCOPE_SHAPES_TESTS_SRC
   testBall3D
   )
 
-if ( DGTAL_WITH_POLYSCOPE )
+if ( DGTAL_WITH_POLYSCOPE_VIEWER )
   foreach(FILE ${POLYSCOPE_SHAPES_TESTS_SRC})
     DGtal_add_test(${FILE} ONLY_ADD_EXECUTABLE)
   endforeach()