songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

document the new named parameter

This commit is contained in:
Sébastien Loriot 2018-05-24 10:24:14 +02:00
parent a207317cf5
commit 699a43e47f
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Polygon_mesh_processing/doc/Polygon_mesh_processing/NamedParameters.txt
View File

@ -310,6 +310,15 @@ of close meshes should be done in addition to surface intersection tests.
\b Default value is `false` \b Default value is `false`
\cgalNPEnd \cgalNPEnd
\cgalNPBegin{new_face_visitor} \anchor PMP_new_face_visitor
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
\b Default value is a model of `PMPCorefinementNewFaceVisitor` that is doing nothing
\cgalNPEnd
\cgalNPTableEnd \cgalNPTableEnd
*/ */

12
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h
View File

@ -471,6 +471,9 @@ boolean_operation( TriangleMesh& tm1,
* Note that if the property map is writable, the indices of the faces * Note that if the property map is writable, the indices of the faces
* of `tm1` and `tm2` will be set after the corefinement is done. * of `tm1` and `tm2` will be set after the corefinement is done.
* \cgalParamEnd * \cgalParamEnd
* \cgalParamBegin{new_face_visitor} a class model of `PMPCorefinementNewFaceVisitor`
* that is used to track the creation of new faces (`np1` only)
* \cgalParamEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
* @param np_out optional sequence of \ref pmp_namedparameters "Named Parameters" among the ones listed below * @param np_out optional sequence of \ref pmp_namedparameters "Named Parameters" among the ones listed below
@ -611,6 +614,9 @@ corefine_and_compute_difference( TriangleMesh& tm1,
* \cgalParamBegin{edge_is_constrained_map} a property map containing the * \cgalParamBegin{edge_is_constrained_map} a property map containing the
* constrained-or-not status of each edge of `tm1` (`tm2`) * constrained-or-not status of each edge of `tm1` (`tm2`)
* \cgalParamEnd * \cgalParamEnd
* \cgalParamBegin{new_face_visitor} a class model of `PMPCorefinementNewFaceVisitor`
* that is used to track the creation of new faces (`np1` only)
* \cgalParamEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
*/ */
@ -711,6 +717,9 @@ namespace experimental {
* \cgalParamBegin{edge_is_constrained_map} a property map containing the * \cgalParamBegin{edge_is_constrained_map} a property map containing the
* constrained-or-not status of each edge of `tm` * constrained-or-not status of each edge of `tm`
* \cgalParamEnd * \cgalParamEnd
* \cgalParamBegin{new_face_visitor} a class model of `PMPCorefinementNewFaceVisitor`
* that is used to track the creation of new faces
* \cgalParamEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
*/ */
@ -786,6 +795,9 @@ namespace experimental {
* constrained-or-not status of each edge of `tm` * constrained-or-not status of each edge of `tm`
* \cgalParamEnd * \cgalParamEnd
* \cgalParamBegin{face_index_map} a property map containing the index of each face of `tm` \cgalParamEnd * \cgalParamBegin{face_index_map} a property map containing the index of each face of `tm` \cgalParamEnd
* \cgalParamBegin{new_face_visitor} a class model of `PMPCorefinementNewFaceVisitor`
* that is used to track the creation of new faces
* \cgalParamEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
*/ */