I/O Functions

Modules
	STL I/O Functions
	I/O Functions for the STereoLithography (STL) File Format.
	PLY I/O Functions
	I/O Functions for the Polygon File Format (PLY).
	OBJ I/O Functions
	I/O Functions for the Wavefront Advanced Visualizer Object Format (OBJ).
	OFF I/O Functions
	I/O Functions for the Object File Format (OFF).
	VTK I/O Functions
	I/O Functions for the VTK (VTU / VTP / legacy) File Formats.
	GOCAD I/O Functions
	I/O Functions for the GOCAD (TS) File Format.
	WKT I/O Functions
	I/O Functions for the Well-Known Text (WKT) File Format.
	3MF I/O Functions
	I/O Functions for the 3D Manufacturing Format (3MF).

Functions
template<typename PointRange , typename PolygonRange , typename NamedParameters = CGAL::parameters::Default_named_parameters>
bool	CGAL::IO::read_polygon_soup (const std::string &fname, PointRange &points, PolygonRange &polygons, const NamedParameters &np=parameters::default_values())
	reads a polygon soup from a file.
template<typename PointRange , typename PolygonRange , typename NamedParameters = CGAL::parameters::Default_named_parameters>
bool	CGAL::IO::write_polygon_soup (const std::string &fname, const PointRange &points, const PolygonRange &polygons, const NamedParameters &np=parameters::default_values())
	writes the content of points and polygons in a file.

Function Documentation

read_polygon_soup()

template<typename PointRange , typename PolygonRange , typename NamedParameters = CGAL::parameters::Default_named_parameters>

bool CGAL::IO::read_polygon_soup	(	const std::string &	fname,
		PointRange &	points,
		PolygonRange &	polygons,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/IO/polygon_soup_io.h>

reads a polygon soup from a file.

Supported file formats are the following:

• Object File Format (OFF) (.off)
• Wavefront Advanced Visualizer Object Format (OBJ) (.obj)
• STereoLithography (STL) File Format (.stl)
• Polygon File Format (PLY) (.ply)
• GOCAD (TS) File Format (.ts)
• VTK (VTU / VTP / legacy) File Formats (.vtp)

The format is detected from the filename extension (letter case is not important).

Template Parameters

PointRange	a model of the concept RandomAccessContainer whose value type is the point type.
PolygonRange	a model of the concepts RandomAccessContainer and BackInsertionSequence whose value_type is itself a model of the concepts RandomAccessContainer and BackInsertionSequence whose value_type is an unsigned integer type convertible to std::size_t
NamedParameters	a sequence of Named Parameters

Parameters

fname	the name of the file.
points	points of the soup of polygons
polygons	each element in the range describes a polygon using the indices of the vertices.
np	optional Named Parameters described below

Optional Named Parameters

verbose indicates whether output warnings and error messages should be printed or not. Type: Boolean Default: false

Returns

true if reading was successful, false otherwise.

write_polygon_soup()

template<typename PointRange , typename PolygonRange , typename NamedParameters = CGAL::parameters::Default_named_parameters>

bool CGAL::IO::write_polygon_soup	(	const std::string &	fname,
		const PointRange &	points,
		const PolygonRange &	polygons,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/IO/polygon_soup_io.h>

writes the content of points and polygons in a file.

Supported file formats are the following:

• Object File Format (OFF) (.off)
• Wavefront Advanced Visualizer Object Format (OBJ) (.obj)
• STereoLithography (STL) File Format (.stl)
• Polygon File Format (PLY) (.ply)
• GOCAD (TS) File Format (.ts)
• VTK (VTU / VTP / legacy) File Formats (.vtp)

The format is detected from the filename extension (letter case is not important).

Template Parameters

PolygonRange	a model of the concept RandomAccessContainer whose value_type is a model of the concept RandomAccessContainer whose value_type is std::size_t.
PointRange	a model of the concept RandomAccessContainer whose value type is the point type
NamedParameters	a sequence of Named Parameters

Parameters

fname	the name of the file.
points	points of the soup of polygons
polygons	each element in the range describes a polygon using the indices of the vertices.
np	optional Named Parameters described below

Optional Named Parameters

point_map a property map associating points to the elements of the range points Type: a model of ReadablePropertyMap whose key type is the value type of the iterator of PointRange and value type is a model of concept Point_3 Default: CGAL::Identity_property_map<std::iterator_traits<PointRange::iterator>::value_type>
verbose indicates whether output warnings and error messages should be printed or not. Type: Boolean Default: false

Returns

true if writing was successful, false otherwise.