CGAL 5.4.1 - 3D Point Set

I/O Functions for the XYZ File Format.

Functions

template<typename Point , typename Vector >
bool CGAL::IO::read_XYZ (std::istream &is, CGAL::Point_set_3< Point, Vector > &point_set)
 reads the content of an intput stream in the XYZ File Format into a point set. More...
 
template<typename Point , typename Vector >
bool CGAL::IO::read_XYZ (const std::string &fname, CGAL::Point_set_3< Point, Vector > &point_set)
 reads the content of an input file in the XYZ File Format into a point set. More...
 
template<typename Point , typename Vector , typename NamedParameters >
bool CGAL::IO::write_XYZ (std::ostream &os, const CGAL::Point_set_3< Point, Vector > &point_set, const NamedParameters &np)
 writes the content of a point set into an output stream in the XYZ File Format. More...
 
template<typename Point , typename Vector , typename NamedParameters >
bool CGAL::IO::write_XYZ (const std::string &fname, const CGAL::Point_set_3< Point, Vector > &point_set, const NamedParameters &np)
 writes the content of a point set into an output file in the XYZ File Format. More...
 

Function Documentation

◆ read_XYZ() [1/2]

template<typename Point , typename Vector >
bool CGAL::IO::read_XYZ ( std::istream &  is,
CGAL::Point_set_3< Point, Vector > &  point_set 
)

#include <CGAL/Point_set_3/IO/XYZ.h>

reads the content of an intput stream in the XYZ File Format into a point set.

If normals are present in the input stream, a normal map will be created and filled.

Parameters
isthe input stream
point_setthe point set
Returns
true if the reading was successful, false otherwise.
Examples:
Point_set_3/point_set_read_xyz.cpp.

◆ read_XYZ() [2/2]

template<typename Point , typename Vector >
bool CGAL::IO::read_XYZ ( const std::string &  fname,
CGAL::Point_set_3< Point, Vector > &  point_set 
)

#include <CGAL/Point_set_3/IO/XYZ.h>

reads the content of an input file in the XYZ File Format into a point set.

If normals are present in the input file, a normal map will be created and filled.

Parameters
fnamethe path to the input file
point_setthe point set
Returns
true if the reading was successful, false otherwise.

◆ write_XYZ() [1/2]

template<typename Point , typename Vector , typename NamedParameters >
bool CGAL::IO::write_XYZ ( std::ostream &  os,
const CGAL::Point_set_3< Point, Vector > &  point_set,
const NamedParameters &  np 
)

#include <CGAL/Point_set_3/IO/XYZ.h>

writes the content of a point set into an output stream in the XYZ File Format.

If it exists, the normal map associated to the point set is inserted in the stream.

Template Parameters
Pointthe point type of the Point_set_3
Vectorthe vector type of the Point_set_3
NamedParametersa sequence of Named Parameters
Parameters
osthe output stream
point_setthe point set
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters
  • 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.

◆ write_XYZ() [2/2]

template<typename Point , typename Vector , typename NamedParameters >
bool CGAL::IO::write_XYZ ( const std::string &  fname,
const CGAL::Point_set_3< Point, Vector > &  point_set,
const NamedParameters &  np 
)

#include <CGAL/Point_set_3/IO/XYZ.h>

writes the content of a point set into an output file in the XYZ File Format.

If it exists, the normal map associated to the point set is inserted in the stream.

Template Parameters
Pointthe point type of the Point_set_3
Vectorthe vector type of the Point_set_3
NamedParametersa sequence of Named Parameters
Parameters
fnamethe path to the output file
point_setthe point set
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters
  • 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.