OpenMesh::IO::_OFFReader_ Class Reference

#include <OFFReader.hh>

Inheritance diagram for OpenMesh::IO::_OFFReader_:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 _OFFReader_ ()
bool can_u_read (const std::string &_filename) const
 Returns true if reader can parse _filename (checks extension).
std::string get_description () const
 Returns a brief description of the file type that can be parsed.
std::string get_extensions () const
std::string get_magic () const
 Return magic bits used to determine file format.
bool read (std::istream &_in, BaseImporter &_bi, Options &_opt)
bool read (const std::string &_filename, BaseImporter &_bi, Options &_opt)
virtual ~_OFFReader_ ()
 Destructor.

Private Member Functions

bool can_u_read (std::istream &_is) const
int getColorType (std::string &_line, bool _texCoordsAvailable) const
bool read_ascii (std::istream &_in, BaseImporter &_bi) const
bool read_binary (std::istream &_in, BaseImporter &_bi, bool swap) const
void readValue (std::istream &_in, unsigned int &_value) const
void readValue (std::istream &_in, int &_value) const
void readValue (std::istream &_in, float &_value) const

Private Attributes

Options options_
Options userOptions_

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.

Definition at line 114 of file OFFReader.hh.


Constructor & Destructor Documentation

OpenMesh::IO::_OFFReader_::_OFFReader_ (  ) 
virtual OpenMesh::IO::_OFFReader_::~_OFFReader_ (  )  [inline, virtual]

Destructor.

Definition at line 121 of file OFFReader.hh.


Member Function Documentation

bool OpenMesh::IO::_OFFReader_::can_u_read ( std::istream &  _is  )  const [private]
bool OpenMesh::IO::_OFFReader_::can_u_read ( const std::string &  _filename  )  const [virtual]

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

Reimplemented from OpenMesh::IO::BaseReader.

std::string OpenMesh::IO::_OFFReader_::get_description (  )  const [inline, virtual]

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

Implements OpenMesh::IO::BaseReader.

Definition at line 123 of file OFFReader.hh.

std::string OpenMesh::IO::_OFFReader_::get_extensions (  )  const [inline, virtual]

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

Implements OpenMesh::IO::BaseReader.

Definition at line 124 of file OFFReader.hh.

std::string OpenMesh::IO::_OFFReader_::get_magic (  )  const [inline, virtual]

Return magic bits used to determine file format.

Reimplemented from OpenMesh::IO::BaseReader.

Definition at line 125 of file OFFReader.hh.

int OpenMesh::IO::_OFFReader_::getColorType ( std::string &  _line,
bool  _texCoordsAvailable 
) const [private]
bool OpenMesh::IO::_OFFReader_::read ( std::istream &  _is,
BaseImporter _bi,
Options _opt 
) [virtual]

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

Implements OpenMesh::IO::BaseReader.

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

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.

bool OpenMesh::IO::_OFFReader_::read_ascii ( std::istream &  _in,
BaseImporter _bi 
) const [private]
bool OpenMesh::IO::_OFFReader_::read_binary ( std::istream &  _in,
BaseImporter _bi,
bool  swap 
) const [private]
void OpenMesh::IO::_OFFReader_::readValue ( std::istream &  _in,
unsigned int &  _value 
) const [private]
void OpenMesh::IO::_OFFReader_::readValue ( std::istream &  _in,
int &  _value 
) const [private]
void OpenMesh::IO::_OFFReader_::readValue ( std::istream &  _in,
float &  _value 
) const [private]

Member Data Documentation

Definition at line 149 of file OFFReader.hh.

Definition at line 151 of file OFFReader.hh.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


openmesh
Author(s): Benjamin Pitzer
autogenerated on Fri Jan 11 12:11:17 2013