From 2ed54dfa3a23190a10588d29bef4bff27f267a27 Mon Sep 17 00:00:00 2001 From: Jane Tournois Date: Thu, 19 Dec 2024 17:17:30 +0100 Subject: [PATCH] add constructors documentation --- .../Construct_initial_points_gray_image.h | 21 ++++++++++++++++--- .../Construct_initial_points_labeled_image.h | 4 +++- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/Mesh_3/include/CGAL/Mesh_3/Construct_initial_points_gray_image.h b/Mesh_3/include/CGAL/Mesh_3/Construct_initial_points_gray_image.h index 83e9896ec27..6dd6c4a3c9c 100644 --- a/Mesh_3/include/CGAL/Mesh_3/Construct_initial_points_gray_image.h +++ b/Mesh_3/include/CGAL/Mesh_3/Construct_initial_points_gray_image.h @@ -39,6 +39,12 @@ namespace CGAL * * \cgalModels{InitialPointsGenerator_3} * + * @tparam C3t3 model of `MeshComplex_3InTriangulation_3` + * @tparam MeshDomain model of `MeshDomain_3` + * @tparam Functor a function object that takes the number type in which the image is encoded, + * and returns the `MeshDomain::Index` of the corresponding subcomplex index. + * The default type is `CGAL::Null_functor`. + * * \sa `CGAL::parameters::initial_points_generator()` * \sa `CGAL::make_mesh_3()` * \sa `CGAL::Construct_initial_points_labeled_image` @@ -52,7 +58,16 @@ struct Construct_initial_points_gray_image Functor image_values_to_subdomain_indices_; /*! - * @todo + * Constructs a functor for generating initial points in gray images. + * @param image the gray image that defines the mesh domain + * @param domain the mesh domain + * @param iso_value the iso value corresponding to the surface of the domain + * @param image_values_to_subdomain_indices a function object that takes + * the number type in which `image` is encoded, + * and returns the corresponding `MeshDomain::Index`. + * The default functor is `CGAL::Null_functor` + * and corresponds to meshing the areas where the image values are + * greater than `iso_value`. */ Construct_initial_points_gray_image(const CGAL::Image_3 & image, const MeshDomain& domain, @@ -75,8 +90,8 @@ struct Construct_initial_points_gray_image * - a `Weighted_point_3` for the point * - an `int` for the minimal dimension of the subcomplexes on which the point lies * - a `MeshDomain::Index` for the corresponding subcomplex index - * \tparam MeshDomain model of `MeshDomain_3` - * \tparam C3t3 model of `MeshComplex_3InTriangulation_3` + * @tparam MeshDomain model of `MeshDomain_3` + * @tparam C3t3 model of `MeshComplex_3InTriangulation_3` * */ template diff --git a/Mesh_3/include/CGAL/Mesh_3/Construct_initial_points_labeled_image.h b/Mesh_3/include/CGAL/Mesh_3/Construct_initial_points_labeled_image.h index 79982147582..ac79ecce0b6 100644 --- a/Mesh_3/include/CGAL/Mesh_3/Construct_initial_points_labeled_image.h +++ b/Mesh_3/include/CGAL/Mesh_3/Construct_initial_points_labeled_image.h @@ -101,7 +101,9 @@ struct Construct_initial_points_labeled_image const MeshDomain& domain_; /*! - * @todo + * Constructs a functor for generating initial points in labeled images. + * @param image the labeled image that defines the mesh domain + * @param domain the mesh domain */ Construct_initial_points_labeled_image(const CGAL::Image_3& image, const MeshDomain& domain)