From a96af5031e59efba5367b31381add04b736d1c0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Tue, 9 May 2023 18:54:04 +0200 Subject: [PATCH] improve doc --- .../include/CGAL/Polygon_mesh_processing/orientation.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orientation.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orientation.h index 42b7ecf253f..ad2d627c661 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orientation.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orientation.h @@ -1626,6 +1626,10 @@ void merge_reversible_connected_components(PolygonMesh& pm, * identifies faces whose orientation must be reversed in order to enable stitching of connected components. * Each face is assigned a bit (`false` or `true`) * such that two faces have compatible orientations iff they are assigned the same bits. + * If `pm` features several connected components (ignoring edge orientations), the property map passed + * to the named parameter `face_partition_id_map` will indicate for each face to which connected component it belongs. + * Note that two faces in different connected components are not impacting each others' orientations, + * so comparing their associated bits in `face_bit_map` is irrelevant. * * @tparam PolygonMesh a model of `HalfedgeListGraph`, `FaceGraph`. * @tparam FaceBitMap a model of `WritablePropertyMap` with `face_descriptor` as key and `bool` as value_type