CGAL 6.0.1 - IO Streams
Loading...
Searching...
No Matches

I/O Functions for the VTK (VTU / VTP / legacy) File Formats.

Functions

template<typename PointRange , typename PolygonRange >
bool CGAL::IO::read_VTP (const std::string &fname, PointRange &points, PolygonRange &polygons)
 reads the content of the input file into points and polygons, using the VTK (VTU / VTP / legacy) File Formats.
 
template<typename PointRange , typename PolygonRange >
bool CGAL::IO::read_VTK (const std::string &fname, PointRange &points, PolygonRange &polygons)
 reads the content of the input file into points and polygons, using the legacy file format of the VTK (VTU / VTP / legacy) File Formats.
 
template<typename PointRange , typename PolygonRange , typename NamedParameters = CGAL::parameters::Default_named_parameters>
bool CGAL::IO::write_VTP (std::ostream &os, const PointRange &points, const PolygonRange &polygons, const NamedParameters &np=parameters::default_values())
 writes the content of points and polygons in out, using the VTK (VTU / VTP / legacy) File Formats.
 
template<typename PointRange , typename PolygonRange , typename NamedParameters = CGAL::parameters::Default_named_parameters>
bool CGAL::IO::write_VTP (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 named fname, using the VTK (VTU / VTP / legacy) File Formats.
 

Function Documentation

◆ read_VTK()

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

#include <CGAL/IO/VTK.h>

reads the content of the input file into points and polygons, using the legacy file format of the VTK (VTU / VTP / legacy) File Formats.

Attention
The polygon soup is not cleared, and the data from the file are appended.
Template Parameters
PointRangea model of the concepts RandomAccessContainer and BackInsertionSequence whose value_type is the point type
PolygonRangea model of the concepts SequenceContainer and BackInsertionSequence whose value_type is itself a model of the concept SequenceContainer and BackInsertionSequence whose value_type is an unsigned integer type convertible to std::size_t
Parameters
fnamethe path to the input file
pointspoints of the soup of polygons
polygonsa range of polygons. Each element in it describes a polygon using the indices of the points in points.
Returns
true if the reading was successful, false otherwise.

◆ read_VTP()

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

#include <CGAL/IO/VTK.h>

reads the content of the input file into points and polygons, using the VTK (VTU / VTP / legacy) File Formats.

Attention
The polygon soup is not cleared, and the data from the file are appended.
Template Parameters
PointRangea model of the concepts RandomAccessContainer and BackInsertionSequence whose value_type is the point type
PolygonRangea model of the concepts SequenceContainer and BackInsertionSequence whose value_type is itself a model of the concept SequenceContainer and BackInsertionSequence whose value_type is an unsigned integer type convertible to std::size_t
Parameters
fnamethe path to the input file
pointspoints of the soup of polygons
polygonsa range of polygons. Each element in it describes a polygon using the indices of the points in points.
Returns
true if the reading was successful, false otherwise.

◆ write_VTP() [1/2]

template<typename PointRange , typename PolygonRange , typename NamedParameters = CGAL::parameters::Default_named_parameters>
bool CGAL::IO::write_VTP ( const std::string &  fname,
const PointRange &  points,
const PolygonRange &  polygons,
const NamedParameters &  np = parameters::default_values() 
)

#include <CGAL/IO/VTK.h>

writes the content of points and polygons in a file named fname, using the VTK (VTU / VTP / legacy) File Formats.

Template Parameters
PointRangea model of the concept RandomAccessContainer whose valuetype is the point type
PolygonRangea model of the concept SequenceContainer whose value_type is itself a model of the concept SequenceContainer whose value_type is an unsigned integer type convertible to std::size_t
NamedParametersa sequence of Named Parameters
Parameters
fnamethe path to the output file
pointspoints of the soup of polygons
polygonsa range of polygons. Each element in it describes a polygon using the indices of the points in points.
npoptional sequence of Named Parameters among the ones listed below
Optional Named Parameters
  • indicates whether data should be written in binary (true) or in ASCII (false)
  • Type: Boolean
  • Default: true

  • a parameter used to set the precision (i.e. how many digits are generated) of the output stream
  • Type: int
  • Default: 6
Returns
true if the writing was successful, false otherwise.

◆ write_VTP() [2/2]

template<typename PointRange , typename PolygonRange , typename NamedParameters = CGAL::parameters::Default_named_parameters>
bool CGAL::IO::write_VTP ( std::ostream &  os,
const PointRange &  points,
const PolygonRange &  polygons,
const NamedParameters &  np = parameters::default_values() 
)

#include <CGAL/IO/VTK.h>

writes the content of points and polygons in out, using the VTK (VTU / VTP / legacy) File Formats.

Template Parameters
PointRangea model of the concept RandomAccessContainer whose value_type is the point type
PolygonRangea model of the concept SequenceContainer whose value_type is itself a model of the concept SequenceContainer whose value_type is an unsigned integer type convertible to std::size_t
NamedParametersa sequence of Named Parameters
Parameters
osthe output stream
pointspoints of the soup of polygons
polygonsa range of polygons. Each element in it describes a polygon using the indices of the points in points.
npoptional sequence of Named Parameters among the ones listed below
Optional Named Parameters
  • indicates whether data should be written in binary (true) or in ASCII (false)
  • Type: Boolean
  • Default: true

  • 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 the writing was successful, false otherwise.