Skip to content

Conversation

@MaelRL
Copy link
Member

@MaelRL MaelRL commented Jan 17, 2026

Summary of Changes

With the years and the additions to the package "Polygon Mesh Processing" (PMP), the user and reference manuals have grown overly large, making it difficult to find information.

This PR splits the documentation of PMP into four (three new) packages:

  • PMP (core): essential functions, ranging from simple geometric functions to distance functions, feature detection etc.
  • Boolean Operations on Meshes: Corefinement, autorefinement, clipping, splitting, slicing, [upcoming kernel ?]
  • Meshing and Remeshing of Polygon Meshes: combinatorial and geometric, local and global meshing and remeshing.
  • Polygon Mesh Repair: detection and treatment of defects in polygon meshes

TODO:

Tentative TODO:

  • Update some package icons?

Release Management

Integrate after :

  • Affected package(s): PMP
  • Issue(s) solved (if any):
  • Feature/Small Feature (if any): PMP_doc_breakup
  • Link to compiled documentation (obligatory for small feature) wrong link name to be changed
  • License and copyright ownership: no change

@MaelRL MaelRL added this to the 6.2-beta milestone Jan 17, 2026
@MaelRL MaelRL added Enhancement Doc Pkg::PMP depends on another PR This pull-request should only be merged after other ones. labels Jan 17, 2026
@MaelRL

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

For example:

warning: tag INPUT: input source '/home/runner/work/cgal/cgal/PMP_Boolean_operations/include/' does not exist
warning: source '/home/runner/work/cgal/cgal/PMP_Boolean_operations/include' is not a readable file or directory...
@MaelRL

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@sloriot

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@sloriot

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@MaelRL

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@MaelRL

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@MaelRL

This comment was marked as outdated.

@github-actions
Copy link

The documentation is built. It will be available, after a few minutes, here: https://cgal.github.io/9286/v0/Manual/index.html

Copy link
Member

@janetournois janetournois left a comment

Choose a reason for hiding this comment

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

A few comments and one more question
For functions moved from namespace CGAL::PMP to namespace CGAL, are we going through a "deprecated" period, or a direct breaking change?

@MaelRL
Copy link
Member Author

MaelRL commented Feb 2, 2026

A few comments and one more question For functions moved from namespace CGAL::PMP to namespace CGAL, are we going through a "deprecated" period, or a direct breaking change?

PMP/border.h was moved to border.h in BGL, and the PMP functions are deprecated (it's in PMP "Core").

@MaelRL MaelRL added Not yet approved The feature or pull-request has not yet been approved. Small feature TODO labels Feb 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

depends on another PR This pull-request should only be merged after other ones. Doc Enhancement Not yet approved The feature or pull-request has not yet been approved. Pkg::PMP Small feature TODO

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants