update after Mael's review

This commit is contained in:
Sébastien Loriot 2018-05-24 13:37:30 +02:00
parent da92f566de
commit c554738ea1
5 changed files with 12 additions and 12 deletions

View File

@ -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.

View File

@ -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);
/// @}

View File

@ -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

View File

@ -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

View File

@ -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`).