From 22b08dfaf86a0a5792ea6d656b8b34a1b911dced Mon Sep 17 00:00:00 2001 From: Ivan Paden Date: Sat, 9 Sep 2023 11:46:43 +0200 Subject: [PATCH] Update documentation Info on curvature calculation in Adaptive_sizing_field Update reference manual welcome page --- .../doc/Polygon_mesh_processing/PackageDescription.txt | 7 +++++-- .../CGAL/Polygon_mesh_processing/Adaptive_sizing_field.h | 3 +++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt index 83929a69981..74bfc24e231 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt @@ -115,8 +115,6 @@ The page \ref bgl_namedparameters "Named Parameters" describes their usage. - `CGAL::Polygon_mesh_processing::split()` \cgalCRPSection{Meshing Functions} -- \link PMP_meshing_grp `CGAL::Polygon_mesh_processing::isotropic_remeshing()` \endlink -- \link PMP_meshing_grp `CGAL::Polygon_mesh_processing::split_long_edges()` \endlink - `CGAL::Polygon_mesh_processing::remesh_planar_patches()` - `CGAL::Polygon_mesh_processing::remesh_almost_planar_patches()` - `CGAL::Polygon_mesh_processing::refine()` @@ -131,9 +129,14 @@ The page \ref bgl_namedparameters "Named Parameters" describes their usage. - `CGAL::Polygon_mesh_processing::smooth_mesh()` (deprecated) - `CGAL::Polygon_mesh_processing::angle_and_area_smoothing()` - `CGAL::Polygon_mesh_processing::tangential_relaxation()` +- `CGAL::Polygon_mesh_processing::tangential_relaxation_with_sizing()` - `CGAL::Polygon_mesh_processing::smooth_shape()` - `CGAL::Polygon_mesh_processing::random_perturbation()` +\cgalCRPSection{Sizing Fields} +- `CGAL::Polygon_mesh_processing::Uniform_sizing_field()` +- `CGAL::Polygon_mesh_processing::Adaptive_sizing_field()` + \cgalCRPSection{Orientation Functions} - `CGAL::Polygon_mesh_processing::orient_polygon_soup()` - `CGAL::Polygon_mesh_processing::orient()` diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/Adaptive_sizing_field.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/Adaptive_sizing_field.h index b1794a6a6b7..60c9e5f7659 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/Adaptive_sizing_field.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/Adaptive_sizing_field.h @@ -32,6 +32,9 @@ namespace Polygon_mesh_processing * provides a set of instructions for isotropic remeshing to achieve variable * mesh edge lengths as a function of local discrete curvatures. * +* The local discrete curvatures are calculated using the +* `CGAL::Polygon_mesh_processing::interpolated_corrected_principal_curvatures_and_directions()` function. +* * Edges longer than the local target edge length are split in half, while * edges shorter than the local target edge length are collapsed. *