OpenMesh::IO::_OFFReader_ Class Reference

Implementation of the OFF format reader. More...

#include <OpenMesh/Core/IO/reader/OFFReader.hh>

Inheritance diagram for OpenMesh::IO::_OFFReader_:

Collaboration diagram for OpenMesh::IO::_OFFReader_:

Public Member Functions
virtual	~_OFFReader_ ()
	Destructor.
std::string	get_description () const override
	Returns a brief description of the file type that can be parsed. More...
std::string	get_extensions () const override
	Returns a string with the accepted file extensions separated by a whitespace and in small caps. More...
std::string	get_magic () const override
	Return magic bits used to determine file format. More...
bool	read (const std::string &_filename, BaseImporter &_bi, Options &_opt) override
	Reads a mesh given by a filename. More...
bool	can_u_read (const std::string &_filename) const override
	Returns true if writer can parse _filename (checks extension). More...
bool	read (std::istream &_in, BaseImporter &_bi, Options &_opt) override
	Reads a mesh given by a std::stream. More...
Public Member Functions inherited from OpenMesh::IO::BaseReader
virtual	~BaseReader ()
	Destructor.
virtual std::string	get_description () const =0
	Returns a brief description of the file type that can be parsed. More...
virtual std::string	get_extensions () const =0
	Returns a string with the accepted file extensions separated by a whitespace and in small caps. More...
virtual std::string	get_magic () const
	Return magic bits used to determine file format. More...
virtual bool	read (const std::string &_filename, BaseImporter &_bi, Options &_opt)=0
	Reads a mesh given by a filename. More...
virtual bool	read (std::istream &_is, BaseImporter &_bi, Options &_opt)=0
	Reads a mesh given by a std::stream. More...
virtual bool	can_u_read (const std::string &_filename) const
	Returns true if writer can parse _filename (checks extension). More...

Additional Inherited Members
Protected Member Functions inherited from OpenMesh::IO::BaseReader
bool	check_extension (const std::string &_fname, const std::string &_ext) const

Detailed Description

Implementation of the OFF format reader.

This class is singleton'ed by SingletonT to OFFReader.

By passing Options to the read function you can manipulate the reading behavoir. The following options can be set:

VertexNormal VertexColor VertexTexCoord FaceColor ColorAlpha [only when reading binary]

These options define if the corresponding data should be read (if available) or if it should be omitted.

After execution of the read function. The options object contains information about what was actually read.

e.g. if VertexNormal was true when the read function was called, but the file did not contain vertex normals then it is false afterwards.

When reading a binary off with Color Flag in the header it is assumed that all vertices and faces have colors in the format "int int int". If ColorAlpha is set the format "int int int int" is assumed.

Member Function Documentation

can_u_read()

bool OpenMesh::IO::_OFFReader_::can_u_read ( const std::string &  _filename ) const

overridevirtual

Returns true if writer can parse _filename (checks extension).

_filename can also provide an extension without a name for a file e.g. _filename == "om" checks, if the reader can read the "om" extension

Parameters

_filename

complete name of a file or just the extension

Returns

true, if reader can read data with the given extension

Reimplemented from OpenMesh::IO::BaseReader.

get_description()

std::string OpenMesh::IO::_OFFReader_::get_description ( ) const

inlineoverridevirtual

Returns a brief description of the file type that can be parsed.

Implements OpenMesh::IO::BaseReader.

get_extensions()

std::string OpenMesh::IO::_OFFReader_::get_extensions ( ) const

inlineoverridevirtual

Returns a string with the accepted file extensions separated by a whitespace and in small caps.

Implements OpenMesh::IO::BaseReader.

get_magic()

std::string OpenMesh::IO::_OFFReader_::get_magic ( ) const

inlineoverridevirtual

Return magic bits used to determine file format.

Reimplemented from OpenMesh::IO::BaseReader.

read() [1/2]

bool OpenMesh::IO::_OFFReader_::read ( const std::string &  _filename, BaseImporter &  _bi, Options &  _opt  )

overridevirtual

Reads a mesh given by a filename.

Usually this method opens a stream and passes it to stream read method. Acceptance checks by filename extension can be placed here.

Options can be passed via _opt. After execution _opt contains the Options that were available

Implements OpenMesh::IO::BaseReader.

read() [2/2]

bool OpenMesh::IO::_OFFReader_::read ( std::istream &  _is, BaseImporter &  _bi, Options &  _opt  )

overridevirtual

Reads a mesh given by a std::stream.

This method usually uses the same stream reading method that read uses. Options can be passed via _opt. After execution _opt contains the Options that were available.

Please make sure that if _is is std::ifstream, the correct std::ios_base::openmode flags are set.

Implements OpenMesh::IO::BaseReader.

---

The documentation for this class was generated from the following files:

• OpenMesh/Core/IO/reader/OFFReader.hh
• OpenMesh/Core/IO/reader/OFFReader.cc