mirror of https://github.com/CGAL/cgal
Regroup related named parameters
This commit is contained in:
parent
2a25a6080e
commit
29505552ee
|
|
@ -681,11 +681,13 @@ clip(TriangleMesh& tm,
|
||||||
* \cgalParamDefault{`false`}
|
* \cgalParamDefault{`false`}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
*
|
*
|
||||||
* \cgalParamNBegin{use_compact_clipper}
|
* \cgalParamNBegin{allow_self_intersections}
|
||||||
* \cgalParamDescription{If `false`, the parts of `pm` coplanar with `plane` will not be part of the output.
|
* \cgalParamDescription{If `true`, self-intersections are accepted for `pm`.}
|
||||||
* Always `true` if `clip_volume` is `true`.}
|
|
||||||
* \cgalParamType{Boolean}
|
* \cgalParamType{Boolean}
|
||||||
* \cgalParamDefault{`true`}
|
* \cgalParamDefault{`false`}
|
||||||
|
* \cgalParamExtra{If this option is set to `true`, `pm` is no longer required to be without self-intersection.
|
||||||
|
* Setting this option to `true` will automatically set `throw_on_self_intersection` to `false`
|
||||||
|
* and `clip_volume` to `false` (overwriting any value provided)}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
*
|
*
|
||||||
* \cgalParamNBegin{clip_volume}
|
* \cgalParamNBegin{clip_volume}
|
||||||
|
|
@ -696,13 +698,11 @@ clip(TriangleMesh& tm,
|
||||||
* \cgalParamDefault{`false`}
|
* \cgalParamDefault{`false`}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
*
|
*
|
||||||
* \cgalParamNBegin{allow_self_intersections}
|
* \cgalParamNBegin{use_compact_clipper}
|
||||||
* \cgalParamDescription{If `true`, self-intersections are accepted for `pm`.}
|
* \cgalParamDescription{If `false`, the parts of `pm` coplanar with `plane` will not be part of the output.
|
||||||
|
* Always `true` if `clip_volume` is `true`.}
|
||||||
* \cgalParamType{Boolean}
|
* \cgalParamType{Boolean}
|
||||||
* \cgalParamDefault{`false`}
|
* \cgalParamDefault{`true`}
|
||||||
* \cgalParamExtra{If this option is set to `true`, `pm` is no longer required to be without self-intersection.
|
|
||||||
* Setting this option to `true` will automatically set `throw_on_self_intersection` to `false`
|
|
||||||
* and `clip_volume` to `false` (overwriting any value provided)}
|
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
*
|
*
|
||||||
* \cgalParamNBegin{do_not_triangulate_faces}
|
* \cgalParamNBegin{do_not_triangulate_faces}
|
||||||
|
|
@ -854,15 +854,6 @@ bool clip(PolygonMesh& pm,
|
||||||
* \cgalParamDefault{`Corefinement::Default_visitor<TriangleMesh>`}
|
* \cgalParamDefault{`Corefinement::Default_visitor<TriangleMesh>`}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
*
|
*
|
||||||
* \cgalParamNBegin{throw_on_self_intersection}
|
|
||||||
* \cgalParamDescription{If `true`, the set of triangles close to the intersection of `tm`
|
|
||||||
* and `iso_cuboid` will be checked for self-intersections
|
|
||||||
* and `CGAL::Polygon_mesh_processing::Corefinement::Self_intersection_exception`
|
|
||||||
* will be thrown if at least one self-intersection is found.}
|
|
||||||
* \cgalParamType{Boolean}
|
|
||||||
* \cgalParamDefault{`false`}
|
|
||||||
* \cgalParamNEnd
|
|
||||||
*
|
|
||||||
* \cgalParamNBegin{clip_volume}
|
* \cgalParamNBegin{clip_volume}
|
||||||
* \cgalParamDescription{If `true`, and `tm` is closed, the clipping will be done on
|
* \cgalParamDescription{If `true`, and `tm` is closed, the clipping will be done on
|
||||||
* the volume \link coref_def_subsec bounded \endlink by `tm`
|
* the volume \link coref_def_subsec bounded \endlink by `tm`
|
||||||
|
|
@ -877,6 +868,15 @@ bool clip(PolygonMesh& pm,
|
||||||
* \cgalParamDefault{`true`}
|
* \cgalParamDefault{`true`}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
*
|
*
|
||||||
|
* \cgalParamNBegin{throw_on_self_intersection}
|
||||||
|
* \cgalParamDescription{If `true`, the set of triangles close to the intersection of `tm`
|
||||||
|
* and `iso_cuboid` will be checked for self-intersections
|
||||||
|
* and `CGAL::Polygon_mesh_processing::Corefinement::Self_intersection_exception`
|
||||||
|
* will be thrown if at least one self-intersection is found.}
|
||||||
|
* \cgalParamType{Boolean}
|
||||||
|
* \cgalParamDefault{`false`}
|
||||||
|
* \cgalParamNEnd
|
||||||
|
*
|
||||||
* \cgalParamNBegin{allow_self_intersections}
|
* \cgalParamNBegin{allow_self_intersections}
|
||||||
* \cgalParamDescription{If `true`, self-intersections are accepted for `tm`.}
|
* \cgalParamDescription{If `true`, self-intersections are accepted for `tm`.}
|
||||||
* \cgalParamType{Boolean}
|
* \cgalParamType{Boolean}
|
||||||
|
|
@ -885,6 +885,7 @@ bool clip(PolygonMesh& pm,
|
||||||
* Setting this option to `true` will automatically set `throw_on_self_intersection` to `false`
|
* Setting this option to `true` will automatically set `throw_on_self_intersection` to `false`
|
||||||
* and `clip_volume` to `false`.}
|
* and `clip_volume` to `false`.}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
|
*
|
||||||
* \cgalNamedParamsEnd
|
* \cgalNamedParamsEnd
|
||||||
*
|
*
|
||||||
* @return `true` if the output surface mesh is manifold.
|
* @return `true` if the output surface mesh is manifold.
|
||||||
|
|
@ -1161,15 +1162,6 @@ void split(PolygonMesh& pm,
|
||||||
* \cgalParamDefault{`Corefinement::Default_visitor<TriangleMesh>`}
|
* \cgalParamDefault{`Corefinement::Default_visitor<TriangleMesh>`}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
*
|
*
|
||||||
* \cgalParamNBegin{throw_on_self_intersection}
|
|
||||||
* \cgalParamDescription{If `true`, the set of triangles close to the intersection of `tm`
|
|
||||||
* and `iso_cuboid` will be checked for self-intersections
|
|
||||||
* and `CGAL::Polygon_mesh_processing::Corefinement::Self_intersection_exception`
|
|
||||||
* will be thrown if at least one self-intersection is found.}
|
|
||||||
* \cgalParamType{Boolean}
|
|
||||||
* \cgalParamDefault{`false`}
|
|
||||||
* \cgalParamNEnd
|
|
||||||
*
|
|
||||||
* \cgalParamNBegin{clip_volume}
|
* \cgalParamNBegin{clip_volume}
|
||||||
* \cgalParamDescription{If `true`, and `tm` is closed, the clipping will be done on
|
* \cgalParamDescription{If `true`, and `tm` is closed, the clipping will be done on
|
||||||
* the volume \link coref_def_subsec bounded \endlink by `tm`
|
* the volume \link coref_def_subsec bounded \endlink by `tm`
|
||||||
|
|
@ -1184,7 +1176,16 @@ void split(PolygonMesh& pm,
|
||||||
* \cgalParamDefault{`true`}
|
* \cgalParamDefault{`true`}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
*
|
*
|
||||||
* * \cgalParamNBegin{allow_self_intersections}
|
* \cgalParamNBegin{throw_on_self_intersection}
|
||||||
|
* \cgalParamDescription{If `true`, the set of triangles close to the intersection of `tm`
|
||||||
|
* and `iso_cuboid` will be checked for self-intersections
|
||||||
|
* and `CGAL::Polygon_mesh_processing::Corefinement::Self_intersection_exception`
|
||||||
|
* will be thrown if at least one self-intersection is found.}
|
||||||
|
* \cgalParamType{Boolean}
|
||||||
|
* \cgalParamDefault{`false`}
|
||||||
|
* \cgalParamNEnd
|
||||||
|
*
|
||||||
|
* \cgalParamNBegin{allow_self_intersections}
|
||||||
* \cgalParamDescription{If `true`, self-intersections are accepted for `tm`.}
|
* \cgalParamDescription{If `true`, self-intersections are accepted for `tm`.}
|
||||||
* \cgalParamType{Boolean}
|
* \cgalParamType{Boolean}
|
||||||
* \cgalParamDefault{`false`}
|
* \cgalParamDefault{`false`}
|
||||||
|
|
@ -1192,6 +1193,7 @@ void split(PolygonMesh& pm,
|
||||||
* Setting this option to `true` will automatically set `throw_on_self_intersection` to `false`
|
* Setting this option to `true` will automatically set `throw_on_self_intersection` to `false`
|
||||||
* and `clip_volume` to `false`.}
|
* and `clip_volume` to `false`.}
|
||||||
* \cgalParamNEnd
|
* \cgalParamNEnd
|
||||||
|
*
|
||||||
* \cgalNamedParamsEnd
|
* \cgalNamedParamsEnd
|
||||||
*
|
*
|
||||||
* @see `clip()`
|
* @see `clip()`
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue