Skip to content

Update polyscope viewer with an error if DGTAL_WITH_POLYSCOPE_VIEWER is missing#1814

Merged
dcoeurjo merged 11 commits intomainfrom
updatePolyscopeDoc
Nov 2, 2025
Merged

Update polyscope viewer with an error if DGTAL_WITH_POLYSCOPE_VIEWER is missing#1814
dcoeurjo merged 11 commits intomainfrom
updatePolyscopeDoc

Conversation

@dcoeurjo
Copy link
Copy Markdown
Member

@dcoeurjo dcoeurjo commented Oct 29, 2025

PR Description

Checklist

  • Unit-test of your feature with Catch.
  • Doxygen documentation of the code completed (classes, methods, types, members...)
  • Documentation module page added or updated.
  • New entry in the ChangeLog.md added.
  • No warning raised in Debug mode.
  • All continuous integration tests pass (Github Actions)

@dcoeurjo dcoeurjo requested review from Copilot and kerautret November 2, 2025 12:00
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request consolidates Polyscope viewer configuration by replacing the DGTAL_BUILD_POLYSCOPE_EXAMPLES option with DGTAL_WITH_POLYSCOPE_VIEWER and renaming the internal DGTAL_WITH_POLYSCOPE flag to DGTAL_WITH_POLYSCOPE_VIEWER throughout the codebase.

Key changes:

  • Unified the Polyscope configuration to use a single DGTAL_WITH_POLYSCOPE_VIEWER flag
  • Removed the separate DGTAL_BUILD_POLYSCOPE_EXAMPLES option, now examples are automatically built when the viewer is enabled
  • Added a compile-time error guard in PolyscopeViewer.h to catch missing flag configuration
  • Fixed polyscope initialization ordering in example files to initialize before registering objects

Reviewed Changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
tests/shapes/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
tests/io/viewers/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
tests/geometry/tools/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
tests/geometry/surfaces/testSphericalHoughNormalVectorEstimator.cpp Updated preprocessor directive from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
tests/geometry/surfaces/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
src/DGtal/io/viewers/PolyscopeViewer.h Added compile-time error guard for missing DGTAL_WITH_POLYSCOPE_VIEWER flag
src/DGtal/io/doc/moduleDisplay3D.dox Added warning about enabling Polyscope at cmake step
src/DGtal/io/doc/migratingViewer3D.dox Added warning about enabling Polyscope at cmake step
src/DGtal/dec/doc/modulePolygonalCalculus.dox Updated build instructions to reference DGTAL_WITH_POLYSCOPE_VIEWER instead of DGTAL_BUILD_POLYSCOPE_EXAMPLES
src/DGtal/base/Common.h Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/tutorial-examples/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/topology/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/io/external-viewers/polyscope/dgtalCalculus-single.cpp Fixed polyscope initialization order to call polyscope::init() before registering objects
examples/io/external-viewers/polyscope/dgtalCalculus-poisson.cpp Fixed polyscope initialization order to call polyscope::init() before registering objects
examples/io/external-viewers/polyscope/CMakeLists.txt Removed obsolete DGTAL_BUILD_POLYSCOPE_EXAMPLES check and polyscope target verification
examples/io/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/graph/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/geometry/volumes/distance/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/geometry/volumes/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/geometry/surfaces/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/geometry/curves/exampleTrofoliKnot.cpp Updated preprocessor directive and removed template parameters from PolyscopeViewer instantiation
examples/geometry/curves/exampleParamCurve3dDigitizationTransformationDecorator.cpp Updated preprocessor directive from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/geometry/curves/exampleParamCurve3dDigitization.cpp Updated preprocessor directive from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/geometry/curves/exampleGridCurve3d.cpp Updated preprocessor directive from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/geometry/curves/exampleArithDSS3d.cpp Updated preprocessor directives from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/geometry/curves/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
examples/doc-examples/CMakeLists.txt Updated conditional compilation flag from DGTAL_WITH_POLYSCOPE to DGTAL_WITH_POLYSCOPE_VIEWER
cmake/Install.cmake Fixed message output to use correct variable name for consistency
cmake/CheckDGtalOptionalDependencies.cmake Consolidated Polyscope configuration logic to use single DGTAL_WITH_POLYSCOPE_VIEWER flag
cmake/BuildExamples.cmake Removed DGTAL_BUILD_POLYSCOPE_EXAMPLES option and updated messaging to reference DGTAL_WITH_POLYSCOPE_VIEWER
ChangeLog.md Added documentation for changes related to DGTAL_BUILD_POLYSCOPE_EXAMPLES removal and flag renaming
.github/actions/dgtal-config/action.yml Removed DGTAL_BUILD_POLYSCOPE_EXAMPLES from GitHub Actions configuration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread cmake/Install.cmake Outdated
Comment thread cmake/BuildExamples.cmake
dcoeurjo and others added 2 commits November 2, 2025 13:39
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@dcoeurjo
Copy link
Copy Markdown
Member Author

dcoeurjo commented Nov 2, 2025

Self-merging

@dcoeurjo dcoeurjo merged commit 2b9f835 into main Nov 2, 2025
7 checks passed
@dcoeurjo dcoeurjo deleted the updatePolyscopeDoc branch November 2, 2025 12:58
@kerautret
Copy link
Copy Markdown
Member

that looks fine

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants