Navigation: Up   Table of Contents   Package Overview   Bibliography   Index   Title   Acknowledging CGAL

CGAL::read_off_points

Definition

CGAL::read_off_points() reads the point from a .off ASCII stream. More specifically, it reads only the point locations and ignores all point attributes available from the stream. CGAL::read_off_points_and_normals() reads the points as well as the normals (if available) from a .off ASCII stream. In both cases the other primitives (segments, faces) are ignored.

#include <CGAL/IO/read_off_points.h>

template<typename OutputIterator, typename PointPMap, typename Kernel>
bool read_off_points ( std::istream& stream, OutputIterator output, PointPMap point_pmap, Kernel kernel)
Reads points (position only) from a .off ASCII stream. The function expects for each point a line with the x y z position. If the position is followed by the nx ny nz normal, then the normal will be ignored. Faces are ignored.
Template Parameters: 
OutputIterator: iterator over output points. PointPMap: is a model of boost::WritablePropertyMap with a value_type = Point_3<Kernel>. It can be omitted if OutputIterator value_type is convertible to Point_3<Kernel>. Kernel: Geometric traits class. It can be omitted and deduced automatically from PointPMap value_type.
Returns:  true on success.
Parameters: 
stream: input stream. output: output iterator over points. point_pmap: property map OutputIterator -> Point_3. kernel: geometric traits.
template<typename OutputIterator, typename PointPMap, typename NormalPMap, typename Kernel>
bool
read_off_points_and_normals ( std::istream& stream,
OutputIterator output,
PointPMap point_pmap,
NormalPMap normal_pmap,
Kernel kernel)
Reads points (positions + normals, if available) from a .off ASCII stream. The function expects for each point a line with the x y z position, optionally followed by the nx ny nz normal. Faces are ignored.
Template Parameters: 
OutputIterator: iterator over output points. PointPMap: is a model of boost::WritablePropertyMap with a value_type = Point_3<Kernel>. It can be omitted if OutputIterator value_type is convertible to Point_3<Kernel>. NormalPMap: is a model of boost::WritablePropertyMap with a value_type = Vector_3<Kernel>. Kernel: Geometric traits class. It can be omitted and deduced automatically from PointPMap value_type.
Returns:  true on success.
Parameters: 
stream: input stream. output: output iterator over points. point_pmap: property map OutputIterator -> Point_3. normal_pmap: property map OutputIterator -> Vector_3. kernel: geometric traits.

See Also

CGAL::read_xyz_points
CGAL::write_xyz_points
CGAL::write_off_points

Example

See read_write_xyz_point_set_example.cpp.

Next: read_xyz_points
Navigation: Up   Table of Contents   Package Overview   Bibliography   Index   Title   Acknowledging CGAL
CGAL Open Source Project. Release 3.5. 1 October 2009.