| geom_traits | is the geometric traits instance used for the mesh processing operation.
Type: a Geometric traits class.
Default:
typename boost::property_traits<
typename boost::property_map<PolygonMesh, CGAL::vertex_point_t>::type>::value_type> ::Kernel
|
| point_map | is the property map containing the points associated to the elements of the point range points.
Type: a class model of ReadablePropertyMap with PointRange::iterator::value_type as key type and geom_traits::Point_3 as value type.
Default value:
|
| vertex_incident_patches_map | is the property map containing the surface patches incident to each vertex of the input polygon mesh.
Type: a class model of LvaluePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type. Its value type must be a container of boost::property_traits<PatchIdMap>::value_type and have a function insert(). A std::set or a boost::unordered_set are recommended, as a patch index may be inserted several times.
Default: boost::get(CGAL::vertex_incident_patches_t, pmesh)
|
| vertex_feature_degree_map | is the property map containing the number of feature edges being incident to the vertices of the polygon mesh pmesh.
Type: a class model of ReadWritePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type and int as value type. It must be default constructible.
Default: boost::get(CGAL::vertex_feature_degree_t(), pmesh)
|
| vertex_is_constrained_map | is the property map containing information about vertices of the input polygon mesh being constrained or not. Constrained vertices may be replaced by new vertices, but the number and location of vertices remain unchanged.
Type: a class model of ReadWritePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type and bool as value type. It must be default constructible.
Default: a default property map where no vertex is constrained is provided.
|
| face_patch_map | is a property map containing information about faces. It is particularly well-suited for preserving surface patch IDs, or face colors. The edges at the interface between surface patches are treated similarly to the ones of edge_is_constrained_map.
Type: a class model of ReadWritePropertyMap with boost::graph_traits<PolygonMesh>::face_descriptor as key type and the desired property, model of CopyConstructible as value type.
Default: a default property map where each face is associated with the ID of the connected component it belongs to. Connected components are computed with respect to the constrained edges listed in the property map edge_is_constrained_map
|
| first_index | is the index of the first surface patch.
Type: std::size_t
Default: 1
|
| density_control_factor | controls the density of the mesh generated by refinement, with larger values causing denser refinements. The density of vertices in the refined region is this factor times higher than before refinement.
Type: floating scalar value
Default: CGAL::sqrt(2)
|
| fairing_continuity | controls the tangential continuity of the output surface in fair(). The possible values are 0, 1 and 2, refering to the C0, C1 and C2 continuity.
Type: unsigned int between 0 and 2
Default: 1
|
| sparse_linear_solver | is the solver used.
Type: a class model of SparseLinearAlgebraWithFactorTraits_d.
Default: if Eigen 3.2 (or greater) is available and CGAL_EIGEN3_ENABLED is defined, then the following overload of Eigen_solver_traits is provided as default value:
in fair():
in smooth_shape():
|
| number_of_iterations | is the number of iterations of the sequence of iterations performed in isotropic_remeshing().
Type: unsigned int
Default: 1
|
| protect_constraints | enables the protection of constraints listed by edge_is_constrained_map and boundary edges in isotropic_remeshing(). If true, constraint edges cannot be modified at all during the remeshing process.
Type: bool
Default: false
|
| collapse_constraints | enables the collapse of constraints listed by edge_is_constrained_map and boundary edges in isotropic_remeshing(). If false, constraint edges cannot be collapsed during the remeshing process.
Type: bool
Default: true
|
| relax_constraints | enables the tangential relaxation step in isotropic_remeshing() to be performed on vertices that are endpoints of constraints listed by edge_is_constrained_map, and boundary edges. The vertices move along the constrained polylines they belong to. Corners (i.e. vertices incident to more than 2 constraints, and vertices listed in vertex_is_constrained_map) are not allowed to move at all. If protect_constraints is set to true, this parameter is ignored.
Type: bool
Default: true
|
| number_of_relaxation_steps | is the number of iterations of tangential relaxation that are performed at each iteration of isotropic_remeshing(). A larger number of relaxation steps lead to a more isotropic mesh.
Type: unsigned int
Default: 1
|
| use_delaunay_triangulation | enables the use of the Delaunay triangulation facet search space for hole filling functions. If no valid triangulation can be found in this search space, the algorithm falls back to the non-Delaunay triangulations search space to find a solution.
Type: bool
Default: true
|
| use_random_uniform_sampling | is a parameter used in sample_triangle_mesh() to indicate that the points are picked in a random uniform way.
Type: bool
Default: true
|
| use_grid_sampling | is a parameter used in sample_triangle_mesh() to indicate that the points are picked on a grid in each face.
Type: bool
Default: false
|
| use_monte_carlo_sampling | is a parameter used in sample_triangle_mesh() to indicate that the points are picked using a Monte-Carlo approach.
Type: bool
Default: false
|
| sample_edges | is a parameter used in sample_triangle_mesh() to indicate if a dedicated sampling of edges is done.
Type: bool
Default: true
|
| sample_vertices | is a parameter used in sample_triangle_mesh() to indicate that triangle vertices are copied in the output iterator.
Type: bool
Default: true
|
| sample_faces | is a parameter used in sample_triangle_mesh() to indicate if the interior of faces is considered for the sampling.
Type: bool
Default: true
|
| number_of_points_on_faces | is a parameter used in sample_triangle_mesh() to set the number of points picked using the random uniform method on faces.
Type: std::size_t
Default: 0
|
| number_of_points_on_edges | is a parameter used in sample_triangle_mesh() to set the number of points picked using the random uniform method on edges.
Type: std::size_t
Default: 0
|
| number_of_points_per_face | is a parameter used in sample_triangle_mesh() to set the number of points picked per face using the Monte-Carlo method.
Type: std::size_t
Default: 0
|
| number_of_points_per_edge | is a parameter used in sample_triangle_mesh() to set the number of points picked per edge using the Monte-Carlo method.
Type: std::size_t
Default: 0
|
| grid_spacing | is a parameter used in sample_triangle_mesh() to set the grid spacing when using the grid sampling method.
Type: double
Default: 0
|
| number_of_points_per_area_unit | is a parameter used in sample_triangle_mesh() to set the number of points per area unit to be picked up in faces for the random uniform sampling and Monte-Carlo methods.
Type: double
Default: 0
|
| number_of_points_per_distance_unit | is a parameter used in sample_triangle_mesh() to set the number of points per distance unit to be picked up on edges for the random uniform sampling and Monte-Carlo methods.
Type: double
Default: 0
|
| do_project | is a parameter used in random_perturbation() to set whether vertices are re-projected to the input surface after their geometric perturbation.
Type: bool
Default: true
|
| random_seed | is a parameter used in random_perturbation() to choose a seed to initialize the random number generator CGAL::Random(). If this parameter is not provided, the perturbation is not deterministic (i.e. not reproducible from one run to the other).
Type: unsigned int
Default: the random number generator is initialized with CGAL::Random()
|
| outward_orientation | Parameter used in orientation functions to choose between an outward or inward orientation.
Type: bool
Default: true
|
| do_overlap_test_of_bounded_sides | Parameter used in intersection test functions to indicate whether overlapping tests of bounded sides of close meshes are done in addition to surface intersection tests.
Type: bool
Default: false
|
| projection_functor | Parameter used in isotropic_remeshing() to specify an alternative vertex projection method.
Type: Unary function object with vertex descriptor as argument type.
Default: A function object projecting vertices on the input surface.
|
| apply_per_connected_component | Parameter used to indicate whether an algorithm should consider each connected component of a mesh independently.
Type: bool
Default: false
|
| visitor | Parameter used to pass a visitor class to a function. Its type and behavior depend on the visited function.
Type: A class
Default: Specific to the function visited
|
| throw_on_self_intersection | Parameter used in corefinement-related functions to make the functions throw an exception in case some faces involved in the intersection of the input are self-intersecting and make the operation impossible with the current version of the code.
Type: bool
Default: false
|
| clip_volume | Parameter used in clip() functions to clip a volume rather than a surface.
Type: bool
Default: false
|
| use_compact_clipper | Parameter used in clip() functions to indicate whether the boundary of the clipper should be considered as part of the clipping volume or not.
Type: bool
Default: true
|
| output_iterator | Parameter to pass an output iterator.
Type : a model of OutputIterator
Default : #CGAL::Emptyset_iterator
|
| erase_all_duplicates | Parameter used in the function merge_duplicate_polygons_in_polygon_soup() to indicate, when multiple faces are duplicates, whether all the duplicate faces should be removed or if one (arbitrarily chosen) face should be kept.
Type: bool
Default: false
|
| require_same_orientation | Parameter used in the function merge_duplicate_polygons_in_polygon_soup() to indicate if orientation should matter when determining whether two faces are duplicates.
Type: bool
Default: false
|
| snapping_tolerance | Parameter used in the function locate_in_face() to to snap barycentric coordinates. Depending on the geometric traits used, the computation of the barycentric coordinates might be an inexact construction, thus leading to sometimes surprising values (e.g. a triplet [0.5, 0.5, -1-e17] for a point at the middle of an edge). The coordinates will be snapped towards 0 and 1 if the difference is smaller than the tolerance value, while still ensuring that the total sum of the coordinates is 1.
Type: Kernel::FT
Default: 0
|
| use_angle_smoothing | Parameter used in the function smooth_mesh() to indicate if angle-based smoothing should be used. When this type of smoothing is used, the algorithm attempts to equalize angles incident to each vertex.
Type: bool
Default: true
|
| use_area_smoothing | Parameter used in the function smooth_mesh() to indicate if area-based smoothing should be used. When this type of smoothing is used, the algorithm attempts to equalize the areas of the triangles incident to each vertex. Since this can create elongated triangles, a second phase uses Delaunay-based flips to recover good shapes, unless specified otherwise (see below).
Type: bool
Default: true
|
| do_orientation_tests | Parameter used in volume_connected_components() to indicate if a surface orientation test must be performed to decide whether a surface connected component belong to a volume or not.
Type : bool
Default value is true
|
| do_self_intersection_tests | Parameter used in volume_connected_components() to indicate if the input triangle mesh might contains self-intersections that must be taken into account while detecting volume connected components.
Type : bool
Default value is false
|
| error_codes | a reference to an object that must be a model of the BackInsertionSequence concept, holding the classification of a volume connected component identified by its id. The size of the container is exactly the number of volume connected components and the object at position k in the container corresponds to the classification of the volume connected component assigned the id k.
Type: a reference_wrapper (either from boost or the standard library) over an object of type container<Volume_error_code>
Default: None
|
| face_connected_component_map | a property map that will contain for each face the id of its surface connected component in the range [0, number of connected components - 1[.
Type: a class model of WritablePropertyMap with boost::graph_traits<PolygonMesh>::face_descriptor as key type and std::size_t as value type
Default: None
|
| volume_inclusions | a reference to a container holding a container of id of surface connected components. The container must be a model of the BackInsertionSequence concept, with a value type being a model of BackInsertionSequence of ids, both types having the functions reserve() and push_back(). The size of the container is exactly the number of surface connected components of the triangle mesh considered The container at position k contains the id of each surface connected components that is the first intersected by a ray with source on the surface connected component k and directed outside the finite volume enclosed by the surface connected component k.
Type: a reference_wrapper (either from boost or the standard library) over an object of type container< container<std::size_t> >
Default: None
|
| connected_component_id_to_volume_id | a reference_wrapper (either from boost or the standard library) containing a reference to an object that must be a model of the BackInsertionSequence concept, with a value_type being std::size_t. The size of the container is exactly the number of connected components. For each connected component identified using its id ccid, the id of the volume it contributes to is the value at the position ccid in the parameter container.
Type: a reference_wrapper (either from boost or the standard library) over an object of type container<std::size_t>
Default: None
|
| nesting_levels | a reference_wrapper (either from boost or the standard library) containing a reference to an object that must be a model of the BackInsertionSequence concept, with a value_type being std::size_t. The size of the container is exactly the number of connected components. For each connected component identified using its id ccid, the container contains the number of connected components containing on their bounded side this component.
Type: a reference_wrapper (either from boost or the standard library) over an object of type container<std::size_t>
Default: None
|
| is_cc_outward_oriented | a reference_wrapper (either from boost or the standard library) containing a reference to an object that must be a model of the BackInsertionSequence concept, with a value_type being bool. The size of the container is exactly the number of connected components. For each connected component identified using its id ccid, the output of is_outward_oriented called on the submesh corresponding to this connected component is the value at the position ccid in the parameter container.
Type: a reference_wrapper (either from boost or the standard library) over an object of type container<bool>
Default: None
|
| intersecting_volume_pairs_output_iterator | Output iterator into which pairs of ids (id must be convertible to std::size_t) can be put. Each pair of connected components intersecting will be reported using their ids. If do_self_intersection_tests named parameter is set to false, nothing will be reported. Type : a model of OutputIterator
Default : #CGAL::Emptyset_iterator
|
| use_Delaunay_flips | Parameter used in the function smooth_mesh() to indicate if Delaunay-based flips should be used after area-based smoothing has been performed. A user wishing to preserve combinatorial information can set this parameter to false, but the mesh might have elongated elements.
Type: bool
Default: true
|
| use_safety_constraints | Parameter used in the function smooth_mesh() to indicate if some sanity checks should be used to decide if the move of a vertex should be applied or rejected. These sanity checks consists of checking that no face incident to the vertex becomes inverted and that the minimum angle of the incident faces is not decreased by the move.
Type: bool
Default: true
|
| face_size_map | Parameter used in the functions keep_large_connected_components() and keep_largest_connected_components() to pass a property map that gives the size of a face when evaluating the size of a connected component (which is defined as the sum of the sizes of its faces).
Type: a class model of ReadablePropertyMap with boost::graph_traits<PolygonMesh>::face_descriptor as key type and a value type supporting construction from 0, operator+=(), and comparison operators.
Default: CGAL::Constant_property_map<face_descriptor, std::size_t> with value 1
|
| area_threshold | Parameter used in the function remove_connected_components_of_negligible_size() to pass a threshold value such that all connected components with an area smaller than this value are removed from the mesh.
Type: Kernel::FT
Default: The square of one percent of the length of the diagonal of the bounding box of the mesh.
|
| volume_threshold | Parameter used in the function remove_connected_components_of_negligible_size() to pass a threshold value such that all (closed) connected components with a volume smaller than this value are removed from the mesh.
Type: Kernel::FT
Default: The third power of one percent of the length of the diagonal of the bounding box of the mesh.
|
| dry_run | Parameter that tells a function not to alter the input, but rather to only return the expected result. It is for example used in the fucntion keep_large_connected_components().
Type: bool
Default: false
|
| maximum_number_of_faces | Parameter that specifies the maximum number of faces that a component of a mesh can have to be considered reversible
If it is left default, then it is ignored and all components are considered reversible.
Type: size_type
Default: 0
|
1.8.17