Developer Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
OpenMesh::IO::_OMWriter_ Class Reference

#include <OpenFlipper/libs_required/OpenMesh/src/OpenMesh/Core/IO/writer/OMWriter.hh>

Inheritance diagram for OpenMesh::IO::_OMWriter_:
OpenMesh::IO::BaseWriter

Public Member Functions

 _OMWriter_ ()
 Constructor. More...
 
virtual ~_OMWriter_ ()
 Destructor. More...
 
std::string get_description () const override
 Return short description of the supported file format. More...
 
std::string get_extensions () const override
 Return file format's extension. More...
 
bool write (std::ostream &, BaseExporter &, const Options &_writeOptions, std::streamsize _precision=6) const override
 
size_t binary_size (BaseExporter &_be, const Options &_opt) const override
 Returns expected size of file if binary format is supported else 0. More...
 
- Public Member Functions inherited from OpenMesh::IO::BaseWriter
virtual ~BaseWriter ()
 Destructor. More...
 
virtual std::string get_description () const =0
 Return short description of the supported file format. More...
 
virtual std::string get_extensions () const =0
 Return file format's extension. More...
 
virtual bool can_u_write (const std::string &_filename) const
 Returns true if writer can write _filename (checks extension). _filename can also provide an extension without a name for a file e.g. _filename == "om" checks, if the writer can write the "om" extension. More...
 
virtual bool write (const std::string &_filename, BaseExporter &_be, const Options &_writeOptions, std::streamsize _precision=6) const =0
 
virtual bool write (std::ostream &_os, BaseExporter &_be, const Options &_writeOptions, std::streamsize _precision=6) const =0
 
virtual size_t binary_size (BaseExporter &, const Options &) const
 Returns expected size of file if binary format is supported else 0. More...
 

Static Public Member Functions

static OMFormat::uint8 get_version ()
 

Protected Member Functions

bool write (const std::string &, BaseExporter &, const Options &_writeOptions, std::streamsize _precision=6) const override
 
bool write_binary (std::ostream &, BaseExporter &, const Options &_writeOptions) const
 
size_t store_binary_custom_chunk (std::ostream &, BaseProperty &, OMFormat::Chunk::Entity, bool) const
 
- Protected Member Functions inherited from OpenMesh::IO::BaseWriter
bool check (BaseExporter &_be, const Options &_writeOptions) const
 

Static Protected Attributes

static const OMFormat::uchar magic_ [3] = "OM"
 
static const OMFormat::uint8 version_ = OMFormat::mk_version(2,2)
 

Additional Inherited Members

- Public Types inherited from OpenMesh::IO::BaseWriter
typedef unsigned int Option
 

Detailed Description

Implementation of the OM format writer. This class is singleton'ed by SingletonT to OMWriter.

Definition at line 91 of file OMWriter.hh.

Constructor & Destructor Documentation

◆ _OMWriter_()

OpenMesh::IO::_OMWriter_::_OMWriter_ ( )

Constructor.

Definition at line 87 of file OMWriter.cc.

◆ ~_OMWriter_()

virtual OpenMesh::IO::_OMWriter_::~_OMWriter_ ( )
inlinevirtual

Destructor.

Definition at line 99 of file OMWriter.hh.

Member Function Documentation

◆ binary_size()

size_t OpenMesh::IO::_OMWriter_::binary_size ( BaseExporter &  ,
const Options &   
) const
overridevirtual

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

Reimplemented from OpenMesh::IO::BaseWriter.

Definition at line 675 of file OMWriter.cc.

◆ get_description()

std::string OpenMesh::IO::_OMWriter_::get_description ( ) const
inlineoverridevirtual

Return short description of the supported file format.

Implements OpenMesh::IO::BaseWriter.

Definition at line 101 of file OMWriter.hh.

◆ get_extensions()

std::string OpenMesh::IO::_OMWriter_::get_extensions ( ) const
inlineoverridevirtual

Return file format's extension.

Implements OpenMesh::IO::BaseWriter.

Definition at line 104 of file OMWriter.hh.

◆ get_version()

static OMFormat::uint8 OpenMesh::IO::_OMWriter_::get_version ( )
inlinestatic

Definition at line 111 of file OMWriter.hh.

◆ store_binary_custom_chunk()

size_t OpenMesh::IO::_OMWriter_::store_binary_custom_chunk ( std::ostream &  _os,
BaseProperty &  _bp,
OMFormat::Chunk::Entity  _entity,
bool  _swap 
) const
protected

Definition at line 613 of file OMWriter.cc.

◆ write() [1/2]

bool OpenMesh::IO::_OMWriter_::write ( const std::string &  _filename,
BaseExporter &  _be,
const Options &  _writeOptions,
std::streamsize  _precision = 6 
) const
overrideprotectedvirtual

Write to a file

Parameters
_filenamewrite to file with the given filename
_beBaseExporter, which specifies the data source
_writeOptionswriting options
_precisioncan be used to specify the precision of the floating point notation.

Implements OpenMesh::IO::BaseWriter.

Definition at line 95 of file OMWriter.cc.

◆ write() [2/2]

bool OpenMesh::IO::_OMWriter_::write ( std::ostream &  _os,
BaseExporter &  _be,
const Options &  _writeOptions,
std::streamsize  _precision = 6 
) const
overridevirtual

Write to a std::ostream

Parameters
_oswrite to std::ostream
_beBaseExporter, which specifies the data source
_writeOptionswriting options
_precisioncan be used to specify the precision of the floating point notation.

Implements OpenMesh::IO::BaseWriter.

Definition at line 133 of file OMWriter.cc.

◆ write_binary()

bool OpenMesh::IO::_OMWriter_::write_binary ( std::ostream &  _os,
BaseExporter &  _be,
const Options &  _writeOptions 
) const
protected

Definition at line 177 of file OMWriter.cc.

Member Data Documentation

◆ magic_

const OMFormat::uchar OpenMesh::IO::_OMWriter_::magic_ = "OM"
staticprotected

Definition at line 116 of file OMWriter.hh.

◆ version_

const OMFormat::uint8 OpenMesh::IO::_OMWriter_::version_ = OMFormat::mk_version(2,2)
staticprotected

Definition at line 117 of file OMWriter.hh.

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