PMP: Replace Location_traits by a simpler API
#4277
Conversation
MaelRL
force-pushed
the
PMP-Locate_rework_traits-GF
branch
from
203de6f to
22092a3
Compare
|
This PR targets the 5.0 release because the feature is new in this release. |
|
locate was introduced by https://cgal.geometryfactory.com/CGAL/Members/wiki/Features/Small_Features/PMP-Locate. @janetournois, can you please have a look at the new API, and approve it again? |
| typedef typename boost::graph_traits<Mesh>::vertex_descriptor vertex_descriptor; | ||
| typedef typename boost::graph_traits<Mesh>::face_descriptor face_descriptor; | ||
|
|
||
| namespace CP = CGAL::parameters; |
There was a problem hiding this comment.
I don't mind too much, but it seems to me that everywhere else (at least in this package) we call this namespace NP for "Named Parameters".
Is there a reason to change that?
|
I re-approve the new documentation (and wrote it in the small feature). There is only one detail I already mentioned in the my first review is : for template parameters descriptions, I would stick to "a model of" everywhere, and avoid mixing with "must be a model of", which makes the reader wonder why this one is different, imho. |
|
Travis still find errors: |
|
Actually, I do not understand why Travis sees new dependencies in the Property_maps package. |
|
Yes, I couldn't understand either, so I thought it might have been an issue present in master when I forked (doesn't ring a bell, though), and ignored it. I can try updating it with master. |
lrineau
added
known false-positive in CI checks
Under Testing
and removed
CI checks failed
labels
PMP: Replace `Location_traits` by a simpler API
lrineau
added
rm only: ready for release branch
|
Successfully tested in https://cgal.geometryfactory.com/CGAL/testsuite/results-5.0-Ic-183.shtml |
lrineau
added
rm only: ready for master
PMP: Replace `Location_traits` by a simpler API
lrineau
removed
the
rm only: ready for master
Summary of Changes
Users have rightfully pointed out that the API used in PMP Location function was not practical, sometimes requiring the user to pass the type of the named parameters, which is very unpractical.
Instead, template aliases for most types, and template by the field type (FT) when necessary, which is much easier to write for the user. Since template aliases cannot automatically deduce template parameters, a non-Doxygen version of a function is written without them from time to time.
updated doc: https://cgal.geometryfactory.com/~mrouxell/PMP_locate_v3/Polygon_mesh_processing/group__PMP__locate__grp.html
This PR also adds an example for the PMP Location functions.
Release Management
Polygon_mesh_processing