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

document undocumented named parameters 

and add extra info about split edges
This commit is contained in:
Jane Tournois 2018-05-15 11:18:15 +02:00
parent 73db555c5e
commit fbd982f7d8
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh.h
View File

@ -81,6 +81,7 @@ namespace Polygon_mesh_processing {
* \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 `pmesh`. A constrained edge can be split * constrained-or-not status of each edge of `pmesh`. A constrained edge can be split
* or collapsed, but not flipped, nor its endpoints moved by smoothing. * or collapsed, but not flipped, nor its endpoints moved by smoothing.
* Sub-edges generated by splitting are set to be constrained.
* Note that patch boundary edges (i.e. incident to only one face in the range) * Note that patch boundary edges (i.e. incident to only one face in the range)
* are always considered as constrained edges. * are always considered as constrained edges.
* \cgalParamEnd * \cgalParamEnd
@ -305,6 +306,12 @@ void isotropic_remeshing(
* \cgalParamBegin{vertex_point_map} the property map with the points associated * \cgalParamBegin{vertex_point_map} the property map with the points associated
* to the vertices of `pmesh`. Instance of a class model of `ReadWritePropertyMap`. * to the vertices of `pmesh`. Instance of a class model of `ReadWritePropertyMap`.
* \cgalParamEnd * \cgalParamEnd
* \cgalParamBegin{face_index_map} a property map containing the index of each face of `pmesh`
* \cgalParamEnd
* \cgalParamBegin{edge_is_constrained_map} a property map containing the
* constrained-or-not status of each edge of `pmesh`. A constrained edge can be split,
* and the sub-edges are set to be constrained.
* \cgalParamEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd
* *
* @sa `isotropic_remeshing()` * @sa `isotropic_remeshing()`