CGAL 4.12 - Polygon Mesh Processing
Corefinement and Boolean Operations

Functions to corefine triangulated surface meshes and compute triangulated surface meshes of the union, difference and intersection of the bounded volumes.

## Functions

template<class TriangleMesh , class NamedParameters >
bool CGAL::Polygon_mesh_processing::does_bound_a_volume (const TriangleMesh &tm, const NamedParameters &np)
indicates if tm bounds a volume. More...

template<class TriangleMesh , class NamedParameters1 , class NamedParameters2 , class NamedParametersOut >
bool CGAL::Polygon_mesh_processing::corefine_and_compute_union (TriangleMesh &tm1, TriangleMesh &tm2, TriangleMesh &tm_out, const NamedParameters1 &np1, const NamedParameters2 &np2, const NamedParametersOut &np_out)
corefines tm1 and tm2 and puts in tm_out a triangulated surface mesh bounding the union of the volumes bounded by tm1 and tm2. More...

template<class TriangleMesh , class NamedParameters1 , class NamedParameters2 , class NamedParametersOut >
bool CGAL::Polygon_mesh_processing::corefine_and_compute_intersection (TriangleMesh &tm1, TriangleMesh &tm2, TriangleMesh &tm_out, const NamedParameters1 &np1, const NamedParameters2 &np2, const NamedParametersOut &np_out)
corefines tm1 and tm2 and puts in tm_out a triangulated surface mesh bounding the intersection of the volumes bounded by tm1 and tm2. More...

template<class TriangleMesh , class NamedParameters1 , class NamedParameters2 , class NamedParametersOut >
bool CGAL::Polygon_mesh_processing::corefine_and_compute_difference (TriangleMesh &tm1, TriangleMesh &tm2, TriangleMesh &tm_out, const NamedParameters1 &np1, const NamedParameters2 &np2, const NamedParametersOut &np_out)
corefines tm1 and tm2 and puts in tm_out a triangulated surface mesh bounding the volume bounded by tm1 minus the volume bounded by tm2. More...

template<class TriangleMesh , class NamedParameters1 , class NamedParameters2 >
void CGAL::Polygon_mesh_processing::corefine (TriangleMesh &tm1, TriangleMesh &tm2, const NamedParameters1 &np1, const NamedParameters2 &np2, const bool throw_on_self_intersection=false)
corefines tm1 and tm2. More...

template<class OutputIterator , class TriangleMesh , class NamedParameters1 , class NamedParameters2 >
OutputIterator CGAL::Polygon_mesh_processing::surface_intersection (const TriangleMesh &tm1, const TriangleMesh &tm2, OutputIterator polyline_output, const NamedParameters1 &np1, const NamedParameters2 &np2, const bool throw_on_self_intersection=false)
computes the intersection of triangles of tm1 and tm2. More...

## ◆ corefine()

template<class TriangleMesh , class NamedParameters1 , class NamedParameters2 >
 void CGAL::Polygon_mesh_processing::corefine ( TriangleMesh & tm1, TriangleMesh & tm2, const NamedParameters1 & np1, const NamedParameters2 & np2, const bool throw_on_self_intersection = false )

#include <CGAL/Polygon_mesh_processing/corefinement.h>

corefines tm1 and tm2.

For each input triangulated surface mesh, if a constrained edge is provided, intersection edges will be marked as constrained. If an edge that was marked as constrained is split, its sub-edges will be marked as constrained as well.

Precondition
!CGAL::Polygon_mesh_processing::does_self_intersect(tm1)
!CGAL::Polygon_mesh_processing::does_self_intersect(tm2)
Template Parameters
 TriangleMesh a model of MutableFaceGraph, HalfedgeListGraph and FaceListGraph NamedParameters1 a sequence of Named Parameters NamedParameters2 a sequence of Named Parameters
Parameters
tm1first input triangulated surface mesh
tm2second input triangulated surface mesh
np1optional sequence of Named Parameters among the ones listed below
np2optional sequence of Named Parameters among the ones listed below
throw_on_self_intersectionif true, for each input triangle mesh, the set of triangles closed to the intersection of tm1 and tm2 will be checked for self-intersection and CGAL::Corefinement::Self_intersection_exception will be thrown if at least one is found.
Named Parameters
 vertex_point_map the property map with the points associated to the vertices of tm1 (tm2). If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in TriangleMesh edge_is_constrained_map a property map containing the constrained-or-not status of each edge of tm1 (tm2)

## ◆ corefine_and_compute_difference()

template<class TriangleMesh , class NamedParameters1 , class NamedParameters2 , class NamedParametersOut >
 bool CGAL::Polygon_mesh_processing::corefine_and_compute_difference ( TriangleMesh & tm1, TriangleMesh & tm2, TriangleMesh & tm_out, const NamedParameters1 & np1, const NamedParameters2 & np2, const NamedParametersOut & np_out )

#include <CGAL/Polygon_mesh_processing/corefinement.h>

corefines tm1 and tm2 and puts in tm_out a triangulated surface mesh bounding the volume bounded by tm1 minus the volume bounded by tm2.

If tm_out is one of the input surface meshes, it will be updated to contain the output (in-place operation), otherwise the result will be inserted into tm_out without clearing it first.

Precondition
!CGAL::Polygon_mesh_processing::does_self_intersect(tm1)
!CGAL::Polygon_mesh_processing::does_self_intersect(tm2)
CGAL::Polygon_mesh_processing::does_bound_a_volume(tm1)
CGAL::Polygon_mesh_processing::does_bound_a_volume(tm2)
Template Parameters
 TriangleMesh a model of MutableFaceGraph, HalfedgeListGraph and FaceListGraph. If TriangleMesh has an internal property map for CGAL::face_index_t, as a named parameter, then it must be initialized. NamedParameters1 a sequence of Named Parameters NamedParameters2 a sequence of Named Parameters NamedParametersOut a sequence of Named Parameters
Parameters
 tm1 first input triangulated surface mesh tm2 second input triangulated surface mesh tm_out output surface mesh np1 optional sequence of Named Parameters among the ones listed below np2 optional sequence of Named Parameters among the ones listed below
Named Parameters
 vertex_point_map the property map with the points associated to the vertices of tm1 (tm2). If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in TriangleMesh edge_is_constrained_map a property map containing the constrained-or-not status of each edge of tm1 (tm2). face_index_map a property map containing the index of each face of tm1 (tm2). Note that if the property map is writable, the indices of the faces of tm1 and tm2 will be set after the corefinement is done.
Parameters
 np_out optional sequence of Named Parameters among the ones listed below
Named Parameters
 vertex_point_map the property map with the points associated to the vertices of tm_out. If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in TriangleMesh edge_is_constrained_map a property map containing the constrained-or-not status of each edge of tm_out. An edge of tm_out is constrained if it is on the intersection of tm1 and tm2, or if the edge corresponds to a constrained edge in tm1 or tm2.
Returns
true if the output surface mesh is manifold and is put into tm_out. If false is returned and if tm_out is one of the input surface meshes, then tm_out is only corefined.
Examples:
Polygon_mesh_processing/corefinement_difference_remeshed.cpp.

## ◆ corefine_and_compute_intersection()

template<class TriangleMesh , class NamedParameters1 , class NamedParameters2 , class NamedParametersOut >
 bool CGAL::Polygon_mesh_processing::corefine_and_compute_intersection ( TriangleMesh & tm1, TriangleMesh & tm2, TriangleMesh & tm_out, const NamedParameters1 & np1, const NamedParameters2 & np2, const NamedParametersOut & np_out )

#include <CGAL/Polygon_mesh_processing/corefinement.h>

corefines tm1 and tm2 and puts in tm_out a triangulated surface mesh bounding the intersection of the volumes bounded by tm1 and tm2.

If tm_out is one of the input surface meshes, it will be updated to contain the output (in-place operation), otherwise the result will be inserted into tm_out without clearing it first.

Precondition
!CGAL::Polygon_mesh_processing::does_self_intersect(tm1)
!CGAL::Polygon_mesh_processing::does_self_intersect(tm2)
CGAL::Polygon_mesh_processing::does_bound_a_volume(tm1)
CGAL::Polygon_mesh_processing::does_bound_a_volume(tm2)
Template Parameters
 TriangleMesh a model of MutableFaceGraph, HalfedgeListGraph and FaceListGraph. If TriangleMesh has an internal property map for CGAL::face_index_t, as a named parameter, then it must be initialized. NamedParameters1 a sequence of Named Parameters NamedParameters2 a sequence of Named Parameters NamedParametersOut a sequence of Named Parameters
Parameters
 tm1 first input triangulated surface mesh tm2 second input triangulated surface mesh tm_out output surface mesh np1 optional sequence of Named Parameters among the ones listed below np2 optional sequence of Named Parameters among the ones listed below
Named Parameters
 vertex_point_map the property map with the points associated to the vertices of tm1 (tm2). If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in TriangleMesh edge_is_constrained_map a property map containing the constrained-or-not status of each edge of tm1 (tm2). face_index_map a property map containing the index of each face of tm1 (tm2). Note that if the property map is writable, the indices of the faces of tm1 and tm2 will be set after the corefinement is done.
Parameters
 np_out optional sequence of Named Parameters among the ones listed below
Named Parameters
 vertex_point_map the property map with the points associated to the vertices of tm_out. If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in TriangleMesh edge_is_constrained_map a property map containing the constrained-or-not status of each edge of tm_out. An edge of tm_out is constrained if it is on the intersection of tm1 and tm2, or if the edge corresponds to a constrained edge in tm1 or tm2.
Returns
true if the output surface mesh is manifold and is put into tm_out. If false is returned and if tm_out is one of the input surface meshes, then tm_out is only corefined.
Examples:
Polygon_mesh_processing/corefinement_consecutive_bool_op.cpp.

## ◆ corefine_and_compute_union()

template<class TriangleMesh , class NamedParameters1 , class NamedParameters2 , class NamedParametersOut >
 bool CGAL::Polygon_mesh_processing::corefine_and_compute_union ( TriangleMesh & tm1, TriangleMesh & tm2, TriangleMesh & tm_out, const NamedParameters1 & np1, const NamedParameters2 & np2, const NamedParametersOut & np_out )

#include <CGAL/Polygon_mesh_processing/corefinement.h>

corefines tm1 and tm2 and puts in tm_out a triangulated surface mesh bounding the union of the volumes bounded by tm1 and tm2.

If tm_out is one of the input surface meshes, it will be updated to contain the output (in-place operation), otherwise the result will be inserted into tm_out without clearing it first.

Precondition
!CGAL::Polygon_mesh_processing::does_self_intersect(tm1)
!CGAL::Polygon_mesh_processing::does_self_intersect(tm2)
CGAL::Polygon_mesh_processing::does_bound_a_volume(tm1)
CGAL::Polygon_mesh_processing::does_bound_a_volume(tm2)
Template Parameters
 TriangleMesh a model of MutableFaceGraph, HalfedgeListGraph and FaceListGraph. If TriangleMesh has an internal property map for CGAL::face_index_t, as a named parameter, then it must be initialized. NamedParameters1 a sequence of Named Parameters NamedParameters2 a sequence of Named Parameters NamedParametersOut a sequence of Named Parameters
Parameters
 tm1 first input triangulated surface mesh tm2 second input triangulated surface mesh tm_out output surface mesh np1 optional sequence of Named Parameters among the ones listed below np2 optional sequence of Named Parameters among the ones listed below
Named Parameters
 vertex_point_map the property map with the points associated to the vertices of tm1 (tm2). If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in TriangleMesh edge_is_constrained_map a property map containing the constrained-or-not status of each edge of tm1 (tm2). face_index_map a property map containing the index of each face of tm1 (tm2). Note that if the property map is writable, the indices of the faces of tm1 and tm2 will be set after the corefinement is done.
Parameters
 np_out optional sequence of Named Parameters among the ones listed below
Named Parameters
 vertex_point_map the property map with the points associated to the vertices of tm_out. If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in TriangleMesh edge_is_constrained_map a property map containing the constrained-or-not status of each edge of tm_out. An edge of tm_out is constrained if it is on the intersection of tm1 and tm2, or if the edge corresponds to a constrained edge in tm1 or tm2.
Returns
true if the output surface mesh is manifold and is put into tm_out. If false is returned and if tm_out is one of the input surface meshes, then tm_out is only corefined.
Examples:
Polygon_mesh_processing/corefinement_consecutive_bool_op.cpp, and Polygon_mesh_processing/corefinement_mesh_union.cpp.

## ◆ does_bound_a_volume()

template<class TriangleMesh , class NamedParameters >
 bool CGAL::Polygon_mesh_processing::does_bound_a_volume ( const TriangleMesh & tm, const NamedParameters & np )

#include <CGAL/Polygon_mesh_processing/corefinement.h>

indicates if tm bounds a volume.

See Definitions for details.

Template Parameters
 TriangleMesh a model of MutableFaceGraph, HalfedgeListGraph and FaceListGraph. If TriangleMesh has an internal property map for CGAL::face_index_t, as a named parameter, then it must be initialized. NamedParameters a sequence of Named Parameters
Parameters
 tm a closed triangulated surface mesh np optional sequence of Named Parameters among the ones listed below
Precondition
CGAL::is_closed(tm)
Named Parameters
 vertex_point_map the property map with the points associated to the vertices of tm. If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in TriangleMesh face_index_map a property map containing the index of each face of tm.
CGAL::Polygon_mesh_processing::orient_to_bound_a_volume()

## ◆ surface_intersection()

template<class OutputIterator , class TriangleMesh , class NamedParameters1 , class NamedParameters2 >
 OutputIterator CGAL::Polygon_mesh_processing::surface_intersection ( const TriangleMesh & tm1, const TriangleMesh & tm2, OutputIterator polyline_output, const NamedParameters1 & np1, const NamedParameters2 & np2, const bool throw_on_self_intersection = false )

#include <CGAL/Polygon_mesh_processing/intersection.h>

computes the intersection of triangles of tm1 and tm2.

The output is a set of polylines with all vertices but endpoints being of degree 2.

Precondition
!CGAL::Polygon_mesh_processing::does_self_intersect(tm1)
!CGAL::Polygon_mesh_processing::does_self_intersect(tm2)
Template Parameters
 TriangleMesh a model of MutableFaceGraph, HalfedgeListGraph and FaceListGraph NamedParameters1 a sequence of Named Parameters NamedParameters2 a sequence of Named Parameters OutputIterator an output iterator in which std::vector of points can be put. The point type is the one from the vertex property map
Parameters
 tm1 first input triangulated surface mesh tm2 second input triangulated surface mesh polyline_output output iterator of polylines. Each polyline will be given as a vector of points throw_on_self_intersection if true, for each input triangle mesh, the set of triangles closed to the intersection of tm1 and tm2 will be checked for self-intersection and CGAL::Corefinement::Self_intersection_exception will be thrown if at least one is found. np1 optional sequence of Named Parameters among the ones listed below np2 optional sequence of Named Parameters among the ones listed below
Named Parameters
 vertex_point_map a property map with the points associated to the vertices of tm1 (tm2). The two property map types must be the same.