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

Merge pull request #7436 from sloriot/PMP-doc_compta_ori 

Improve doc of compatible_orientations
This commit is contained in:
Laurent Rineau 2023-05-11 17:37:11 +02:00
parent 1e6519e51a a96af5031e
commit bb63050ef0
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orientation.h
View File

@ -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. * identifies faces whose orientation must be reversed in order to enable stitching of connected components.
* Each face is assigned a bit (`false` or `true`) * Each face is assigned a bit (`false` or `true`)
* such that two faces have compatible orientations iff they are assigned the same bits. * 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 PolygonMesh a model of `HalfedgeListGraph`, `FaceGraph`.
* @tparam FaceBitMap a model of `WritablePropertyMap` with `face_descriptor` as key and `bool` as value_type * @tparam FaceBitMap a model of `WritablePropertyMap` with `face_descriptor` as key and `bool` as value_type