OpenMesh::IO::BaseWriter Class Reference

#include <BaseWriter.hh>

Inheritance diagram for OpenMesh::IO::BaseWriter:

[legend]

List of all members.

Public Types
typedef unsigned int	Option
Public Member Functions
virtual size_t	binary_size (BaseExporter &, Options) const
	Returns expected size of file if binary format is supported else 0.
virtual bool	can_u_write (const std::string &_filename) const
	Returns true if writer can parse _filename (checks extension).
virtual std::string	get_description () const =0
	Return short description of the supported file format.
virtual std::string	get_extensions () const =0
	Return file format's extension.
virtual bool	write (std::ostream &_os, BaseExporter &_be, Options _opt) const =0
	Write to std::ostream _os. Data source specified by BaseExporter _be.
virtual bool	write (const std::string &_filename, BaseExporter &_be, Options _opt) const =0
	Write to file _filename. Data source specified by BaseExporter _be.
virtual	~BaseWriter ()
	Destructor.
Protected Member Functions
bool	check (BaseExporter &_be, Options _opt) const

---

Detailed Description

Base class for all writer modules. The module should register itself at the IOManager by calling the register_module function.

Definition at line 81 of file BaseWriter.hh.

---

Member Typedef Documentation

typedef unsigned int OpenMesh::IO::BaseWriter::Option

Definition at line 85 of file BaseWriter.hh.

---

Constructor & Destructor Documentation

virtual OpenMesh::IO::BaseWriter::~BaseWriter

(

)

[inline, virtual]

Destructor.

Definition at line 88 of file BaseWriter.hh.

---

Member Function Documentation

virtual size_t OpenMesh::IO::BaseWriter::binary_size	(	BaseExporter &	,
		Options
	)			const [inline, virtual]

Returns expected size of file if binary format is supported else 0.

Reimplemented in OpenMesh::IO::_OBJWriter_, OpenMesh::IO::_OFFWriter_, OpenMesh::IO::_OMWriter_, OpenMesh::IO::_PLYWriter_, and OpenMesh::IO::_STLWriter_.

Definition at line 110 of file BaseWriter.hh.

virtual bool OpenMesh::IO::BaseWriter::can_u_write

(

const std::string &

_filename

)

const [virtual]

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

bool OpenMesh::IO::BaseWriter::check	(	BaseExporter &	_be,
		Options	_opt
	)			const [inline, protected]

Definition at line 116 of file BaseWriter.hh.

virtual std::string OpenMesh::IO::BaseWriter::get_description

(

)

const [pure virtual]

Return short description of the supported file format.

Implemented in OpenMesh::IO::_OBJWriter_, OpenMesh::IO::_OFFWriter_, OpenMesh::IO::_OMWriter_, OpenMesh::IO::_PLYWriter_, and OpenMesh::IO::_STLWriter_.

virtual std::string OpenMesh::IO::BaseWriter::get_extensions

(

)

const [pure virtual]

Return file format's extension.

Implemented in OpenMesh::IO::_OBJWriter_, OpenMesh::IO::_OFFWriter_, OpenMesh::IO::_OMWriter_, OpenMesh::IO::_PLYWriter_, and OpenMesh::IO::_STLWriter_.

virtual bool OpenMesh::IO::BaseWriter::write	(	std::ostream &	_os,
		BaseExporter &	_be,
		Options	_opt
	)			const [pure virtual]

Write to std::ostream _os. Data source specified by BaseExporter _be.

Implemented in OpenMesh::IO::_OBJWriter_, OpenMesh::IO::_OFFWriter_, OpenMesh::IO::_OMWriter_, OpenMesh::IO::_PLYWriter_, and OpenMesh::IO::_STLWriter_.

virtual bool OpenMesh::IO::BaseWriter::write	(	const std::string &	_filename,
		BaseExporter &	_be,
		Options	_opt
	)			const [pure virtual]

Write to file _filename. Data source specified by BaseExporter _be.

Implemented in OpenMesh::IO::_OBJWriter_, OpenMesh::IO::_OFFWriter_, OpenMesh::IO::_OMWriter_, OpenMesh::IO::_PLYWriter_, and OpenMesh::IO::_STLWriter_.

---

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

• BaseWriter.hh