Miscellaneous Functions

Functions
template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>
CGAL::Bbox_3	CGAL::Polygon_mesh_processing::bbox (const PolygonMesh &pmesh, const NamedParameters &np=parameters::default_values())
	computes a bounding box of a polygon mesh.
template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>
CGAL::Bbox_3	CGAL::Polygon_mesh_processing::vertex_bbox (typename boost::graph_traits< PolygonMesh >::vertex_descriptor vd, const PolygonMesh &pmesh, const NamedParameters &np=parameters::default_values())
	computes a bounding box of the vertex of a polygon mesh.
template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>
CGAL::Bbox_3	CGAL::Polygon_mesh_processing::edge_bbox (typename boost::graph_traits< PolygonMesh >::edge_descriptor ed, const PolygonMesh &pmesh, const NamedParameters &np=parameters::default_values())
	computes a bounding box of an edge of a polygon mesh.
template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>
CGAL::Bbox_3	CGAL::Polygon_mesh_processing::face_bbox (typename boost::graph_traits< PolygonMesh >::face_descriptor fd, const PolygonMesh &pmesh, const NamedParameters &np=parameters::default_values())
	computes a bounding box of a face of a polygon mesh.
template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>
void	CGAL::Polygon_mesh_processing::add_bbox (PolygonMesh &pmesh, const NamedParameters &np=parameters::default_values())
	adds an axis-aligned bounding box to a polygon mesh.
template<class Transformation , class PolygonMesh , class NamedParameters = parameters::Default_named_parameters>
void	CGAL::Polygon_mesh_processing::transform (const Transformation &transformation, PolygonMesh &mesh, const NamedParameters &np=parameters::default_values())
	applies a transformation to every vertex of a PolygonMesh.
template<typename TriangleMesh , typename NamedParameters = CGAL::parameters::Default_named_parameters>
Triangle_3	CGAL::Polygon_mesh_processing::triangle (typename boost::graph_traits< TriangleMesh >::face_descriptor fd, const TriangleMesh &tmesh, const NamedParameters &np=parameters::default_values())
	computes a triangle for a face descriptor of a triangle mesh.

Function Documentation

add_bbox()

template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>

void CGAL::Polygon_mesh_processing::add_bbox	(	PolygonMesh &	pmesh,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Polygon_mesh_processing/bbox.h>

adds an axis-aligned bounding box to a polygon mesh.

Template Parameters

PolygonMesh	a model of MutableFaceGraph
NamedParameters	a sequence of Named Parameters

Parameters

pmesh	a polygon mesh
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

bbox_scaling a double used to scale the bounding box. The default value is 1 and the bounding box is the smallest possible axis-aligned bounding box. Default: 1. Precondition: bbox_scaling > 0
do_not_triangulate_faces a Boolean used to specify whether the bounding box's faces should be triangulated or not. The default value is true, and faces are not triangulated. Default: true
vertex_point_map a property map associating points to the vertices of pmesh Type: a class model of ReadWritePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, pmesh) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in PolygonMesh.
geom_traits an instance of a geometric traits class model of Kernel.

See also

bbox()

bbox()

template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>

CGAL::Bbox_3 CGAL::Polygon_mesh_processing::bbox	(	const PolygonMesh &	pmesh,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Polygon_mesh_processing/bbox.h>

computes a bounding box of a polygon mesh.

Template Parameters

PolygonMesh	a model of VertexListGraph
NamedParameters	a sequence of Named Parameters

Parameters

pmesh	a polygon mesh
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of pmesh Type: a class model of ReadablePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, pmesh) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in PolygonMesh.
geom_traits an instance of a geometric traits class providing the functor Construct_bbox_3 and the function Construct_bbox_3 construct_bbox_3_object(). Construct_bbox_3 must provide the functor Bbox_3 operator()(Point_3) where Point_3 is the value type of the vertex point map.
bbox_scaling a double used to scale the bounding box. The default value is 1 and the bounding box is the smallest possible axis-aligned bounding box. Default: 1. Precondition: bbox_scaling > 0

See also

vertex_bbox()

edge_bbox()

face_bbox()

edge_bbox()

template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>

CGAL::Bbox_3 CGAL::Polygon_mesh_processing::edge_bbox	(	typename boost::graph_traits< PolygonMesh >::edge_descriptor	ed,
		const PolygonMesh &	pmesh,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Polygon_mesh_processing/bbox.h>

computes a bounding box of an edge of a polygon mesh.

Template Parameters

PolygonMesh	a model of Graph
NamedParameters	a sequence of Named Parameters

Parameters

ed	a descriptor of an edge in pmesh
pmesh	a polygon mesh
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of pmesh Type: a class model of ReadablePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, pmesh) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in PolygonMesh.
geom_traits an instance of a geometric traits class providing the functor Construct_bbox_3 and the function Construct_bbox_3 construct_bbox_3_object(). Construct_bbox_3 must provide Bbox_3 operator()(Point_3) where Point_3 is the value type of the vertex point map.

See also

vertex_bbox()

face_bbox()

bbox()

face_bbox()

template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>

CGAL::Bbox_3 CGAL::Polygon_mesh_processing::face_bbox	(	typename boost::graph_traits< PolygonMesh >::face_descriptor	fd,
		const PolygonMesh &	pmesh,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Polygon_mesh_processing/bbox.h>

computes a bounding box of a face of a polygon mesh.

Template Parameters

PolygonMesh	a model of Graph
NamedParameters	a sequence of Named Parameters

Parameters

fd	a descriptor of a face in pmesh
pmesh	a polygon mesh
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of pmesh Type: a class model of ReadablePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, pmesh) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in PolygonMesh.
geom_traits an instance of a geometric traits class providing the functor Construct_bbox_3 and the function Construct_bbox_3 construct_bbox_3_object(). Construct_bbox_3 must provide Bbox_3 operator()(Point_3) where Point_3 is the value type of the vertex point map. Default: a CGAL Kernel deduced from the point type, using CGAL::Kernel_traits

See also

vertex_bbox()

edge_bbox()

bbox()

transform()

template<class Transformation , class PolygonMesh , class NamedParameters = parameters::Default_named_parameters>

void CGAL::Polygon_mesh_processing::transform	(	const Transformation &	transformation,
		PolygonMesh &	mesh,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Polygon_mesh_processing/transform.h>

applies a transformation to every vertex of a PolygonMesh.

Template Parameters

Transformation	a functor that has an operator()(Point_3), with Point_3 the value_type of vertex_point_map (see below). Such a functor can be CGAL::Aff_transformation_3 for example.
PolygonMesh	a model of VertexListGraph
NamedParameters	a sequence of Named Parameters

Parameters

transformation	the transformation functor to apply to the points of mesh.
mesh	the PolygonMesh to transform.
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of mesh Type: a class model of ReadWritePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, mesh) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in PolygonMesh.

Examples

Polygon_mesh_processing/hausdorff_bounded_error_distance_example.cpp.

triangle()

template<typename TriangleMesh , typename NamedParameters = CGAL::parameters::Default_named_parameters>

Triangle_3 CGAL::Polygon_mesh_processing::triangle	(	typename boost::graph_traits< TriangleMesh >::face_descriptor	fd,
		const TriangleMesh &	tmesh,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Polygon_mesh_processing/triangle.h>

computes a triangle for a face descriptor of a triangle mesh.

Template Parameters

TriangleMesh	a model of FaceGraph
NamedParameters	a sequence of Named Parameters

Parameters

tmesh	the triangulated surface mesh
fd	the descriptor of the face to construct the triangle from
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of tmesh Type: a class model of ReadablePropertyMap with boost::graph_traits<TriangleMesh>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, tmesh)
geom_traits an instance of a geometric traits class Type: a class model of Kernel Default: a CGAL Kernel deduced from the point type, using CGAL::Kernel_traits Extra: The geometric traits class must be compatible with the vertex point type.

vertex_bbox()

template<typename PolygonMesh , typename NamedParameters = parameters::Default_named_parameters>

CGAL::Bbox_3 CGAL::Polygon_mesh_processing::vertex_bbox	(	typename boost::graph_traits< PolygonMesh >::vertex_descriptor	vd,
		const PolygonMesh &	pmesh,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Polygon_mesh_processing/bbox.h>

computes a bounding box of the vertex of a polygon mesh.

Template Parameters

PolygonMesh	a model of Graph
NamedParameters	a sequence of Named Parameters

Parameters

vd	a descriptor of a vertex in pmesh
pmesh	a polygon mesh
np	an optional sequence of Named Parameters among the ones listed below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of pmesh Type: a class model of ReadablePropertyMap with boost::graph_traits<PolygonMesh>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, pmesh) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in PolygonMesh.
geom_traits an instance of a geometric traits class providing the functor Construct_bbox_3 and the function Construct_bbox_3 construct_bbox_3_object(). Construct_bbox_3 must provide Bbox_3 operator()(Point_3) where Point_3 is the value type of the vertex point map.

See also

edge_bbox()

face_bbox()

bbox()