Update documentation

Info on curvature calculation in Adaptive_sizing_field

Update reference manual welcome page
This commit is contained in:
Ivan Paden 2023-09-09 11:46:43 +02:00
parent cd6692661d
commit 22b08dfaf8
2 changed files with 8 additions and 2 deletions

View File

@ -115,8 +115,6 @@ The page \ref bgl_namedparameters "Named Parameters" describes their usage.
- `CGAL::Polygon_mesh_processing::split()` - `CGAL::Polygon_mesh_processing::split()`
\cgalCRPSection{Meshing Functions} \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_planar_patches()`
- `CGAL::Polygon_mesh_processing::remesh_almost_planar_patches()` - `CGAL::Polygon_mesh_processing::remesh_almost_planar_patches()`
- `CGAL::Polygon_mesh_processing::refine()` - `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::smooth_mesh()` (deprecated)
- `CGAL::Polygon_mesh_processing::angle_and_area_smoothing()` - `CGAL::Polygon_mesh_processing::angle_and_area_smoothing()`
- `CGAL::Polygon_mesh_processing::tangential_relaxation()` - `CGAL::Polygon_mesh_processing::tangential_relaxation()`
- `CGAL::Polygon_mesh_processing::tangential_relaxation_with_sizing()`
- `CGAL::Polygon_mesh_processing::smooth_shape()` - `CGAL::Polygon_mesh_processing::smooth_shape()`
- `CGAL::Polygon_mesh_processing::random_perturbation()` - `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} \cgalCRPSection{Orientation Functions}
- `CGAL::Polygon_mesh_processing::orient_polygon_soup()` - `CGAL::Polygon_mesh_processing::orient_polygon_soup()`
- `CGAL::Polygon_mesh_processing::orient()` - `CGAL::Polygon_mesh_processing::orient()`

View File

@ -32,6 +32,9 @@ namespace Polygon_mesh_processing
* provides a set of instructions for isotropic remeshing to achieve variable * provides a set of instructions for isotropic remeshing to achieve variable
* mesh edge lengths as a function of local discrete curvatures. * 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 longer than the local target edge length are split in half, while
* edges shorter than the local target edge length are collapsed. * edges shorter than the local target edge length are collapsed.
* *