diff --git a/Installation/CHANGES.md b/Installation/CHANGES.md index aa819b19c1a..f6608194fe1 100644 --- a/Installation/CHANGES.md +++ b/Installation/CHANGES.md @@ -35,7 +35,7 @@ Release date: September 2018 ### Polygon Mesh Processing - Added a function to apply a transformation to a mesh : - `CGAL::Polygon_mesh_processing::transform()` -- Add in corefinement related functions a new named parameter `new_face_visitor` +- Add in corefinement-related functions a new named parameter `new_face_visitor` that make it possible to pass a visitor to the function in order to track the creation of new faces. diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPCorefinementNewFaceVisitor.h b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPCorefinementNewFaceVisitor.h index 04e77634c40..47febe3c1ca 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPCorefinementNewFaceVisitor.h +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Concepts/PMPCorefinementNewFaceVisitor.h @@ -2,7 +2,7 @@ /// \cgalConcept /// /// The concept `PMPCorefinementNewFaceVisitor` defines the requirements for the visitor -/// used in \link PMP_corefinement_grp corefinement related functions \endlink to track +/// used in \link PMP_corefinement_grp corefinement-related functions \endlink to track /// the creation of new faces. /// /// \cgalRefines `CopyConstructible` @@ -23,21 +23,21 @@ typedef unspecified_type face_descriptor; /// the creation of a new face of triangulating `f_split`. void before_subface_creations(face_descriptor f_split, Triangle_mesh& tm); /// called when the triangulation of a face in `tm` is finished - void after_subface_creations(Mesh& tm); + void after_subface_creations(Triangle_mesh& tm); /// called before creating a new triangle face in `tm` to triangulate the face passed to `before_subface_creations()` - void before_subface_created(Mesh& tm); + void before_subface_created(Triangle_mesh& tm); /// called after creating a new triangle face `f_new` in `tm` to triangulate the face passed to `before_subface_creations()`. - /// Note that the call is placed just after a call to `add_face()` so the halfedge pointer is set yet. + /// Note that the call is placed just after a call to `add_face()` so the halfedge pointer is not set yet. void after_subface_created(face_descriptor f_new, Triangle_mesh& tm); /// @} -/// @name Functions used by functions computing Boolean operations using corefinement -/// These functions are not needed is you only call `corefine()`. +/// @name Functions used by functions computing Boolean operations using corefinement. +/// These functions are not needed if you only call `corefine()`. /// @{ - /// called before importing face `f_src` of `tm_src` in `tm_tgt` + /// called before importing the face `f_src` of `tm_src` in `tm_tgt` void before_face_copy(face_descriptor f_src, Triangle_mesh& tm_src, Triangle_mesh& tm_tgt); - /// called after importing face `f_src` of `tm_src` in `tm_tgt`. The new face if `f_tgt`. - /// Note that the call is placed just after a call to `add_face()` so the halfedge pointer is set yet. + /// called after importing the face `f_src` of `tm_src` in `tm_tgt`. The new face is `f_tgt`. + /// Note that the call is placed just after a call to `add_face()` so the halfedge pointer is not set yet. void after_face_copy(face_descriptor f_src, Triangle_mesh& tm_src, face_descriptor f_tgt, Triangle_mesh& tm_tgt); /// @} diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt index 34f1acc6670..55485dfdd4f 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt @@ -311,7 +311,7 @@ of close meshes should be done in addition to surface intersection tests. \cgalNPEnd \cgalNPBegin{new_face_visitor} \anchor PMP_new_face_visitor -A class model of `PMPCorefinementNewFaceVisitor` that is used in corefinement related functions +A class model of `PMPCorefinementNewFaceVisitor` that is used in corefinement-related functions to track the creation of new faces. \n \b Type : `A class` \n diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt index d9118621645..80e65018910 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/PackageDescription.txt @@ -148,7 +148,6 @@ and provides a list of the parameters that are used in this package. - `CGAL::Polygon_mesh_processing::corefine()` - `CGAL::Polygon_mesh_processing::surface_intersection()` - `CGAL::Polygon_mesh_processing::does_bound_a_volume()` -- `PMPCorefinementNewFaceVisitor` ## Geometric Measure Functions ## - \link measure_grp `CGAL::Polygon_mesh_processing::face_area()` \endlink diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h index 18207a2c6b3..c10cc3a1a12 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h @@ -605,6 +605,7 @@ corefine_and_compute_difference( TriangleMesh& tm1, * the set of triangles closed to the intersection of `tm1` and `tm2` will be * checked for self-intersection and `CGAL::Corefinement::Self_intersection_exception` * will be thrown if at least one is found. + * * \cgalNamedParamsBegin * \cgalParamBegin{vertex_point_map} * the property map with the points associated to the vertices of `tm1` (`tm2`).