document the property map version of parameters

This commit is contained in:
Sébastien Loriot 2023-03-22 14:34:25 +01:00
parent e316b3fb04
commit cfa8c2954f
3 changed files with 27 additions and 4 deletions

View File

@ -291,6 +291,20 @@ bool is_polygon_soup_a_polygon_mesh(const PolygonRange& polygons)
* \cgalParamDefault{`Emptyset_iterator`}
* \cgalParamNEnd
*
* \cgalParamNBegin{point_to_vertex_map}
* \cgalParamDescription{a property map associating each soup point of `points` to a vertex of `out`.}
* \cgalParamType{a class model of `ReadablePropertyMap` with an integer type as key type and
* `boost::graph_traits<PolygonMesh>::%vertex_descriptor` as value type.}
* \cgalParamDefault{unused}
* \cgalParamNEnd
*
* \cgalParamNBegin{polygon_to_face_map}
* \cgalParamDescription{a property map associating each soup polygon of `polygons` to a face of `out`}
* \cgalParamType{a class model of `ReadablePropertyMap` with an integer type as key type and
* `boost::graph_traits<PolygonMesh>::%face_descriptor` as value type.}
* \cgalParamDefault{unused}
* \cgalParamNEnd
*
* \cgalNamedParamsEnd
*
* @param np_pm an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
@ -335,9 +349,16 @@ void polygon_soup_to_polygon_mesh(const PointRange& points,
internal::PS_to_PM_converter<PointRange, PolygonRange, Point_map> converter(points, polygons, pm);
converter(out, vpm,
choose_parameter(get_parameter(np_ps, internal_np::point_to_vertex_output_iterator),
impl::make_functor(get_parameter(np_ps, internal_np::vertex_to_vertex_map))),
impl::make_functor(get_parameter(np_ps, internal_np::point_to_vertex_map))),
choose_parameter(get_parameter(np_ps, internal_np::polygon_to_face_output_iterator),
impl::make_functor(get_parameter(np_ps, internal_np::face_to_face_map))));
impl::make_functor(get_parameter(np_ps, internal_np::polygon_to_face_map))));
CGAL_static_assertion_msg(
(parameters::is_default_parameter<NamedParameters_PS,internal_np::vertex_to_vertex_map_t>::value),
"Named parameter vertex_to_vertex_map was renamed point_to_vertex_map");
CGAL_static_assertion_msg(
(parameters::is_default_parameter<NamedParameters_PS,internal_np::face_to_face_map_t>::value),
"Named parameter face_to_face_map was renamed polygon_to_face_map");
}
} // namespace Polygon_mesh_processing

View File

@ -863,8 +863,8 @@ bool decimate_impl(const TriangleMeshIn& tm_in,
visitor(tm_out);
polygon_soup_to_polygon_mesh(corners, faces, tm_out,
parameters::vertex_to_vertex_map(f_id_tracker.v2v_map()).
face_to_face_map(f_id_tracker.f2f_map()),
parameters::point_to_vertex_map(f_id_tracker.v2v_map()).
polygon_to_face_map(f_id_tracker.f2f_map()),
parameters::vertex_point_map(vpm_out));
return remeshing_failed;
}

View File

@ -37,6 +37,8 @@ CGAL_add_named_parameter(halfedge_to_halfedge_output_iterator_t, halfedge_to_hal
CGAL_add_named_parameter(face_to_face_output_iterator_t, face_to_face_output_iterator, face_to_face_output_iterator)
CGAL_add_named_parameter(point_to_vertex_output_iterator_t, point_to_vertex_output_iterator, point_to_vertex_output_iterator)
CGAL_add_named_parameter(polygon_to_face_output_iterator_t, polygon_to_face_output_iterator, polygon_to_face_output_iterator)
CGAL_add_named_parameter(point_to_vertex_map_t, point_to_vertex_map, point_to_vertex_map)
CGAL_add_named_parameter(polygon_to_face_map_t, polygon_to_face_map, polygon_to_face_map)
CGAL_add_named_parameter(vertex_to_vertex_map_t, vertex_to_vertex_map, vertex_to_vertex_map)
CGAL_add_named_parameter(halfedge_to_halfedge_map_t, halfedge_to_halfedge_map, halfedge_to_halfedge_map)