mirror of https://github.com/CGAL/cgal
document face_patch_map
This commit is contained in:
parent
21a869491b
commit
bfe4d815a2
|
|
@ -167,7 +167,21 @@ during the remeshing process.\n
|
|||
\b Default value is `false`
|
||||
\cgalNPEnd
|
||||
|
||||
|
||||
\cgalNPBegin{face_patch_map} \anchor PMP_face_patch_map
|
||||
a property map containing information about faces.
|
||||
It is particularly well-suited for preserving surface patch IDs,
|
||||
or face colors.
|
||||
The edges at the interface between surface patches are treated similarly
|
||||
to the ones of `edge_is_constrained_map`
|
||||
\n
|
||||
\b Type : a class model of `ReadWritePropertyMap` with
|
||||
`boost::graph_traits<PolygonMesh>::%face_descriptor` as key type and
|
||||
the desired property, model of `CopyConstructible` as value type.\n
|
||||
\b Default : if this parameter is omitted,
|
||||
a default property map where each face is associated with the ID of
|
||||
the connected component it belongs to. Connected components are
|
||||
computed with respect to the constrained edges listed in the property map
|
||||
`edge_is_constrained_map`
|
||||
\cgalNPTableEnd
|
||||
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -68,13 +68,13 @@ namespace Polygon_mesh_processing {
|
|||
* \cgalParamBegin{geom_traits} a geometric traits class instance, model of `Kernel`
|
||||
* \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 splitted
|
||||
* constrained-or-not status of each edge of `pmesh`. A constrained edge can be splitted
|
||||
* or collapsed, but not flipped, nor its endpoints moved by smoothing.
|
||||
* Note that patch boundary edges (i.e. incident to only one face in the range)
|
||||
* are always considered as constrained edges.
|
||||
* \cgalParamEnd
|
||||
* \cgalParamBegin{vertex_is_constrained_map} a property map containing the
|
||||
* constrained-or-not status of each vertex of pmesh. A constrained vertex
|
||||
* constrained-or-not status of each vertex of `pmesh`. A constrained vertex
|
||||
* cannot be modified at all during remeshing
|
||||
* \cgalParamEnd
|
||||
* \cgalParamBegin{protect_constraints} If `true`, the edges set as constrained
|
||||
|
|
|
|||
Loading…
Reference in New Issue