CGAL 4.14.3 - Triangulated Surface Mesh Approximation
|
How to use BGL Optional Named Parameters
The notion of named parameters was introduced in the BGL. Details can be found from: https://www.boost.org/libs/graph/doc/bgl_named_params.html. Named parameters enable the user to specify only those parameters which are really needed, by name, making the parameter ordering not required. See also BGL Named Parameters.
The sequence of named parameters should start with CGAL::parameters::
. The function all_default()
can be used to indicate that default values of optional named parameters are used.
Example
See below a sample call of a function that uses the optional BGL named parameters.
List of Available Named Parameters
In this package, all functions optional parameters are implemented as BGL optional named parameters and listed below.
In the following, we assume that the following types are provided as template parameters of surface mesh approximation functions and classes. Note that the type is more specific for some of these functions.
TriangleMesh
implements a FaceListGraph
GeomTraits
a geometric traits class in which constructions are performed and predicates evaluated. Throughout this package, a CGAL Kernel
fulfills the requirements. The named parameters available in this package are categorized into 3 groups below.
1. Parameters for the Approximation Step
geom_traits | the geometric traits instance in which the mesh approximation operation should be performed. typename CGAL::Kernel_traits< typename boost::property_traits< typename boost::property_map<TriangleMesh, CGAL::vertex_point_t>::type>::value_type>::Kernel |
vertex_point_map | is the property map with the points associated to the vertices of the polygon mesh boost::get(CGAL::vertex_point, pmesh) |
verbose_level | set the verbose level of the function. |
seeding_method | the selection of seeding method. |
max_number_of_proxies | the maximum number of proxies used to approximate the input mesh. |
min_error_drop | the minimum total error drop to approximate the input mesh. |
number_of_relaxations | the number of relaxation iterations interleaved within seeding. |
number_of_iterations | the number of partitioning and fitting iterations after seeding. |
2. Parameters for the Meshing Step
3. Parameters for Retrieving the Results
face_proxy_map | the property map outputs the proxy index of each face of the input polygon mesh. |
proxies | an |
anchors | an |
triangles | an |
Functions | |
unspecified_type | CGAL::Surface_mesh_approximation::parameters::all_default () |
This function is used when default parameters are just fine for approximation or meshing. | |