OM I/O Functions

I/O Functions for the OpenMesh (OM) File format.

Functions
template<typename Graph , typename NamedParameters = CGAL::parameters::Default_named_parameters>
bool	CGAL::IO::read_OM (const std::string &fname, Graph &g, const NamedParameters &np=parameters::default_values())
	reads the graph g from the file fname, using the OpenMesh (OM) File format.
template<typename Graph , typename NamedParameters = CGAL::parameters::Default_named_parameters>
bool	CGAL::IO::write_OM (const std::string &fname, const Graph &g, const NamedParameters &np=parameters::default_values())
	writes the graph g into a file named fname, using the OpenMesh (OM) File format.

Function Documentation

read_OM()

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

bool CGAL::IO::read_OM	(	const std::string &	fname,
		Graph &	g,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/boost/graph/IO/OM.h>

reads the graph g from the file fname, using the OpenMesh (OM) File format.

The data is expected to represent a 2-manifold (possibly with borders).

Attention

The graph g is not cleared, and the data from the file are appended.

Note

This function is only available if OpenMesh is available (CGAL_USE_OPENMESH is defined or CMake target is linked with CGAL::OpenMesh_support).

Template Parameters

Graph	a model of MutableFaceGraph
NamedParameters	a sequence of Named Parameters

Parameters

fname	the name of the input file
g	the graph to be built from the input data
np	optional Named Parameters described below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of g Type: a class model of WritablePropertyMap with boost::graph_traits<Graph>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, g) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in Graph.
edge_is_constrained_map a property map containing the feature-or-not status of each edge of g to be filled by the reader Type: a class model of WritablePropertyMap with boost::graph_traits<Graph>::edge_descriptor as key type and bool as value type. Default: a default property map where no edge is marked as feature
vertex_is_constrained_map a property map containing the feature-or-not status of each vertex of g to be filled by the reader Type: a class model of WritablePropertyMap with boost::graph_traits<Graph>::vertex_descriptor as key type and bool as value type. Default: a default property map where no vertex is marked as feature

Returns

true if reading was successful and the resulting mesh is valid, false otherwise.

write_OM()

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

bool CGAL::IO::write_OM	(	const std::string &	fname,
		const Graph &	g,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/boost/graph/IO/OM.h>

writes the graph g into a file named fname, using the OpenMesh (OM) File format.

Note

This function is only available if OpenMesh is available (CGAL_USE_OPENMESH is defined or CMake target is linked with CGAL::OpenMesh_support).

Template Parameters

Graph	a model of FaceListGraph and HalfedgeListGraph
NamedParameters	a sequence of Named Parameters

Parameters

fname	the output file
g	the graph to be written
np	optional Named Parameters described below

Optional Named Parameters

vertex_point_map a property map associating points to the vertices of g Type: a class model of ReadablePropertyMap with boost::graph_traits<Graph>::vertex_descriptor as key type and Point_3 as value type Default: boost::get(CGAL::vertex_point, g) Extra: If this parameter is omitted, an internal property map for CGAL::vertex_point_t must be available in Graph.
edge_is_constrained_map a property map containing the feature-or-not status of each edge of g Type: a class model of ReadablePropertyMap with boost::graph_traits<Graph>::edge_descriptor as key type and bool as value type.
vertex_is_constrained_map a property map containing the feature-or-not status of each vertex of g Type: a class model of ReadablePropertyMap with boost::graph_traits<Graph>::vertex_descriptor as key type and bool as value type.
stream_precision a parameter used to set the precision (i.e. how many digits are generated) of the output stream Type: int Default: the precision of the stream os

Returns

true if writing was successful, false otherwise.