CGAL 5.4.3 - IO Streams

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).
 
 VTP I/O Functions
 I/O Functions for the VTK (VTU / VTP) 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 CGAL_BGL_NP_TEMPLATE_PARAMETERS >
bool CGAL::IO::read_polygon_soup (const std::string &fname, PointRange &points, PolygonRange &polygons, const CGAL_BGL_NP_CLASS &np)
 reads a polygon soup from a file. More...
 
template<typename PointRange , typename PolygonRange , typename CGAL_BGL_NP_TEMPLATE_PARAMETERS >
bool CGAL::IO::write_polygon_soup (const std::string &fname, const PointRange &points, const PolygonRange &polygons, const CGAL_BGL_NP_CLASS &np)
 writes the content of points and polygons in a file. More...
 

Function Documentation

◆ read_polygon_soup()

template<typename PointRange , typename PolygonRange , typename CGAL_BGL_NP_TEMPLATE_PARAMETERS >
bool CGAL::IO::read_polygon_soup ( const std::string &  fname,
PointRange &  points,
PolygonRange &  polygons,
const CGAL_BGL_NP_CLASS &  np 
)

#include <CGAL/IO/polygon_soup_io.h>

reads a polygon soup from a file.

Supported file formats are the following:

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

Template Parameters
PointRangea model of the concept RandomAccessContainer whose value type is the point type.
PolygonRangea model of the concepts SequenceContainer and BackInsertionSequence whose value_type is itself a model of the concepts SequenceContainer and BackInsertionSequence whose value_type is an unsigned integer type convertible to std::size_t
NamedParametersa sequence of Named Parameters
Parameters
fnamethe name of the file.
pointspoints of the soup of polygons
polygonseach element in the range describes a polygon using the indices of the vertices.
npoptional Named Parameters described below
Optional Named Parameters
  • 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 CGAL_BGL_NP_TEMPLATE_PARAMETERS >
bool CGAL::IO::write_polygon_soup ( const std::string &  fname,
const PointRange &  points,
const PolygonRange &  polygons,
const CGAL_BGL_NP_CLASS &  np 
)

#include <CGAL/IO/polygon_soup_io.h>

writes the content of points and polygons in a file.

Supported file formats are the following:

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

Template Parameters
PolygonRangea model of the concept RandomAccessContainer whose value_type is a model of the concept RandomAccessContainer whose value_type is std::size_t.
PointRangea model of the concept RandomAccessContainer whose value type is the point type
NamedParametersa sequence of Named Parameters
Parameters
fnamethe name of the file.
pointspoints of the soup of polygons
polygonseach element in the range describes a polygon using the indices of the vertices.
npoptional Named Parameters described below
Optional Named Parameters
  • indicates whether output warnings and error messages should be printed or not.
  • Type: Boolean
  • Default: false
Returns
true if writing was successful, false otherwise.