CGAL 5.3 - Point Set Processing

Functions

template<typename OutputIteratorValueType , typename PointOutputIterator , typename NamedParameters >
bool CGAL::IO::read_OFF (std::istream &is, PointOutputIterator output, const NamedParameters &np)
 reads points (positions + normals, if available), using the Object File Format (OFF). More...
 
template<typename OutputIteratorValueType , typename PointOutputIterator , typename NamedParameters >
bool CGAL::IO::read_OFF (const std::string &fname, PointOutputIterator output, const NamedParameters &np)
 reads points (positions + normals, if available), using the Object File Format (OFF). More...
 
template<typename PointRange , typename NamedParameters >
bool CGAL::IO::write_OFF (std::ostream &os, const PointRange &points, const NamedParameters &np)
 writes the range of points (positions + normals, if available), using the Object File Format (OFF). More...
 
template<typename PointRange , typename NamedParameters >
bool CGAL::IO::write_OFF (const std::string &filename, const PointRange &points, const NamedParameters &np)
 writes the range of points (positions + normals, if available), using the Object File Format (OFF). More...
 

Function Documentation

◆ read_OFF() [1/2]

template<typename OutputIteratorValueType , typename PointOutputIterator , typename NamedParameters >
bool CGAL::IO::read_OFF ( std::istream &  is,
PointOutputIterator  output,
const NamedParameters &  np 
)

#include <CGAL/IO/read_off_points.h>

reads points (positions + normals, if available), using the Object File Format (OFF).

Template Parameters
OutputIteratorValueTypetype of objects that can be put in PointOutputIterator. It must be a model of DefaultConstructible and defaults to value_type_traits<PointOutputIterator>::type. It can be omitted when the default is fine.
PointOutputIteratoriterator over output points.
NamedParametersa sequence of Named Parameters
Parameters
isinput stream
outputoutput iterator over points
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters

  • a property map associating normals to the elements of the point range
  • Type: a model of WritablePropertyMap with value type geom_traits::Vector_3
  • Default: If this parameter is omitted, normals in the input stream are ignored.

Returns
true if reading was successful, false otherwise.
See also
Object File Format (OFF)

◆ read_OFF() [2/2]

template<typename OutputIteratorValueType , typename PointOutputIterator , typename NamedParameters >
bool CGAL::IO::read_OFF ( const std::string &  fname,
PointOutputIterator  output,
const NamedParameters &  np 
)

#include <CGAL/IO/read_off_points.h>

reads points (positions + normals, if available), using the Object File Format (OFF).

Template Parameters
OutputIteratorValueTypetype of objects that can be put in PointOutputIterator. It must be a model of DefaultConstructible and defaults to value_type_traits<PointOutputIterator>::type. It can be omitted when the default is fine.
PointOutputIteratoriterator over output points.
NamedParametersa sequence of Named Parameters
Parameters
fnameinput file name
outputoutput iterator over points
npoptional sequence of Named Parameters among the ones listed below.
Optional Named Parameters

  • a property map associating normals to the elements of the point range
  • Type: a model of WritablePropertyMap with value type geom_traits::Vector_3
  • Default: If this parameter is omitted, normals in the input stream are ignored.

Returns
true if reading was successful, false otherwise.
See also
Object File Format (OFF)

◆ write_OFF() [1/2]

template<typename PointRange , typename NamedParameters >
bool CGAL::IO::write_OFF ( std::ostream &  os,
const PointRange &  points,
const NamedParameters &  np 
)

#include <CGAL/IO/write_off_points.h>

writes the range of points (positions + normals, if available), using the Object File Format (OFF).

Template Parameters
PointRangeis a model of ConstRange. The value type of its iterator is the key type of the named parameter point_map.
NamedParametersa sequence of Named Parameters
Parameters
osoutput stream
pointsinput point range
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters

  • a property map associating normals to the elements of the point range
  • Type: a model of ReadablePropertyMap with value type geom_traits::Vector_3
  • Default: If this parameter is omitted, normals are not written in the output stream.

  • 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 streamos``
Returns
true if writing was successful, false otherwise.

◆ write_OFF() [2/2]

template<typename PointRange , typename NamedParameters >
bool CGAL::IO::write_OFF ( const std::string &  filename,
const PointRange &  points,
const NamedParameters &  np 
)

#include <CGAL/IO/write_off_points.h>

writes the range of points (positions + normals, if available), using the Object File Format (OFF).

Template Parameters
PointRangeis a model of ConstRange. The value type of its iterator is the key type of the named parameter point_map.
NamedParametersa sequence of Named Parameters
Parameters
filenamethe path to the output file
pointsinput point range
npan optional sequence of Named Parameters among the ones listed below
Optional Named Parameters

  • a property map associating normals to the elements of the point range
  • Type: a model of ReadablePropertyMap with value type geom_traits::Vector_3
  • Default: If this parameter is omitted, normals are not written in the output file.

  • 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 writing was successful, false otherwise.
See also
Object File Format (OFF)