I/O Functions

Methods to read and write graphs.

Functions
template<typename FaceGraph , typename NamedParameters >
bool	CGAL::write_wrl (std::ostream &os, const FaceGraph &g, const NamedParameters &np)
	writes the graph g in the wrl format (VRML 2.0). More...
template<typename FaceGraph , typename NamedParameters >
bool	CGAL::write_off (std::ostream &os, const FaceGraph &g, const NamedParameters &np)
	writes the graph g in the OFF format. More...
template<typename FaceGraph , typename NamedParameters >
bool	CGAL::write_off (const char *fname, const FaceGraph &g, const NamedParameters &np)
	writes the graph g in the OFF format into a file named fname. More...
template<typename FaceGraph , typename NamedParameters >
bool	CGAL::read_off (std::istream &is, FaceGraph &g, NamedParameters np)
	reads the graph g from data in the OFF format. More...
template<typename FaceGraph , typename NamedParameters >
bool	CGAL::read_off (const char *fname, FaceGraph &g, NamedParameters np)
	reads the graph g from data in the OFF format. More...
template<class TriangleMesh , class NamedParameters >
void	CGAL::write_vtp (std::ostream &os, const TriangleMesh &mesh, const NamedParameters &np)
	writes a triangulated surface mesh in the PolyData XML format. More...

Function Documentation

read_off() [1/2]

template<typename FaceGraph , typename NamedParameters >

bool CGAL::read_off	(	std::istream &	is,
		FaceGraph &	g,
		NamedParameters	np
	)

#include <CGAL/boost/graph/io.h>

reads the graph g from data in the OFF format.

Ignores comment lines which start with a hash, and lines with whitespace.

Named Parameters

vertex_point_map

the property map with the points associated to the vertices of g. If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in FaceGraph

See also

Overloads of this function for specific models of the concept FaceGraph.

Precondition

The data must represent a 2-manifold

Attention

The graph g is not cleared, and the data from the stream are added.

Examples:

BGL_graphcut/face_selection_borders_regularization_example.cpp, and BGL_surface_mesh/surface_mesh_partition.cpp.

read_off() [2/2]

template<typename FaceGraph , typename NamedParameters >

bool CGAL::read_off	(	const char *	fname,
		FaceGraph &	g,
		NamedParameters	np
	)

#include <CGAL/boost/graph/io.h>

reads the graph g from data in the OFF format.

Ignores comment lines which start with a hash, and lines with whitespace.

See also

Overloads of this function for specific models of the concept FaceGraph.

Precondition

The data must represent a 2-manifold

Attention

The graph g is not cleared, and the data from the stream are added.

write_off() [1/2]

template<typename FaceGraph , typename NamedParameters >

bool CGAL::write_off	(	std::ostream &	os,
		const FaceGraph &	g,
		const NamedParameters &	np
	)

#include <CGAL/boost/graph/io.h>

writes the graph g in the OFF format.

Named Parameters

vertex_point_map

the property map with the points associated to the vertices of g. If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in FaceGraph

See also

Overloads of this function for specific models of the concept FaceGraph.

Examples:

BGL_surface_mesh/surface_mesh_partition.cpp.

write_off() [2/2]

template<typename FaceGraph , typename NamedParameters >

bool CGAL::write_off	(	const char *	fname,
		const FaceGraph &	g,
		const NamedParameters &	np
	)

#include <CGAL/boost/graph/io.h>

writes the graph g in the OFF format into a file named fname.

See also

Overloads of this function for specific models of the concept FaceGraph.

write_vtp()

template<class TriangleMesh , class NamedParameters >

void CGAL::write_vtp	(	std::ostream &	os,
		const TriangleMesh &	mesh,
		const NamedParameters &	np
	)

#include <CGAL/boost/graph/io.h>

writes a triangulated surface mesh in the PolyData XML format.

Template Parameters

TriangleMesh	a model of FaceListGraph with only triangle faces.
NamedParameters	a sequence of Named Parameters

Parameters

os	the stream used for writing.
mesh	the triangle mesh to be written.
np	optional sequence of Named Parameters among the ones listed below

Named Parameters

use_binary_mode	a Boolean indicating if the data should be written in binary (true, the default) or in ASCII (false).
vertex_point_map	the property map with the points associated to the vertices of mesh. If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in TriangleMesh.
vertex_index_map	the property map with the indices associated to the vertices of mesh.

write_wrl()

template<typename FaceGraph , typename NamedParameters >

bool CGAL::write_wrl	(	std::ostream &	os,
		const FaceGraph &	g,
		const NamedParameters &	np
	)

#include <CGAL/boost/graph/io.h>

writes the graph g in the wrl format (VRML 2.0).

Named Parameters

vertex_point_map

the property map with the points associated to the vertices of g. If this parameter is omitted, an internal property map for CGAL::vertex_point_t should be available in FaceGraph