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

add doc about property maps to the reference manual

This commit is contained in:
Jane Tournois 2015-06-29 14:10:58 +02:00
parent 0a24bdbacd
commit 00d289baee
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/connected_components.h
View File

@ -476,6 +476,10 @@ connected_component(typename boost::graph_traits<PolygonMesh>::face_descriptor s
* \ingroup PkgPolygonMeshProcessing
* computes for each face the index of the corresponding connected component.
* Two faces are recorded in the same connected component if they share an edge that is not marked as constrained.
*
* A property map for `CGAL::face_index_t` should be either available as an internal property map
* to `pmesh` or provided as one of the \ref namedparameters.
*
* \tparam PolygonMesh a model of `FaceListGraph`
* \tparam FaceComponentMap a model of `WritablePropertyMap` with
`boost::graph_traits<PolygonMesh>::%face_descriptor` as key type and
@ -549,6 +553,10 @@ connected_components(const PolygonMesh& pmesh,
* Keep `nb_components_to_keep` largest connected components.
* Two faces are considered in the same connected component if they share an edge that is not marked as constrained.
*
* Property maps for `CGAL::face_index_t` and `CGAL::vertex_index_t`
* should be either available as internal property maps
* to `pmesh` or provided as \ref namedparameters.
*
* \tparam PolygonMesh a model of `FaceListGraph`
* \tparam NamedParameters a sequence of \ref namedparameters
*
@ -752,6 +760,11 @@ std::size_t keep_largest_connected_components(PolygonMesh& pmesh,
* and erases the other connected components and all the isolated vertices.
* Two faces are considered in the same connected component if they share an edge that is not marked as constrained.
*
* Property maps for `CGAL::face_index_t` and `CGAL::vertex_index_t`
* should be either available as internal property maps
* to `pmesh` or provided as \ref namedparameters.
*
*
* \tparam PolygonMesh a model of `FaceListGraph`
* \tparam NamedParameters a sequence of \ref namedparameters
* \tparam FaceRange a range of `boost::graph_traits<PolygonMesh>::%face_descriptor`