GEO::MeshIOHandler Class Reference

Mesh loader and saver. More...

#include <geogram/mesh/mesh_io.h>

Inheritance diagram for GEO::MeshIOHandler:

Public Member Functions
virtual bool	load (const std::string &filename, Mesh &M, const MeshIOFlags &ioflags=MeshIOFlags())=0
	Loads a double precision mesh from a file.
virtual bool	save (const Mesh &M, const std::string &filename, const MeshIOFlags &ioflags=MeshIOFlags())=0
	Saves a mesh to a file.
Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count.
void	unref () const
	Decrements the reference count.
bool	is_shared () const
	Check if the object is shared.
int	nb_refs () const
	Gets the number of references that point to this object.

Static Public Member Functions
static MeshIOHandler *	create (const std::string &format)
	Creates a MeshIOHandler.
static MeshIOHandler *	get_handler (const std::string &filename)
	Gets the MeshIOHandler for a file.
Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count.
static void	unref (const Counted *counted)
	Decrements the reference count.

Protected Member Functions
	MeshIOHandler ()
	MeshIOHandler default constructor.
	~MeshIOHandler () override
	MeshIOHandler destructor.
virtual void	bind_attributes (const Mesh &M, const MeshIOFlags &flags, bool create)
virtual void	unbind_attributes ()
Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object.
virtual	~Counted ()
	Destroys a reference counted object.

Protected Attributes
Attribute< index_t >	vertex_region_
Attribute< index_t >	edge_region_
Attribute< index_t >	facet_region_
Attribute< index_t >	cell_region_

Related Symbols
(Note that these are not member symbols.)
typedef SmartPointer< MeshIOHandler >	MeshIOHandler_var
	A smart pointer that contains a MeshIOHandler object.
typedef Factory0< MeshIOHandler >	MeshIOHandlerFactory
	MeshIOHandler Factory.

Detailed Description

Mesh loader and saver.

MeshIOHandler is responsible to load and save meshes in a specific file format. MeshIOHandler is used internally by mesh_load() and mesh_save(), so you don't normally need to use it directly, unless you need to implement a new file format.

Vorpaline currently supports thr following file formats:

• OBJ http://en.wikipedia.org/wiki/Wavefront_.obj_file
• mesh, meshb (ASCII and binary) http://www-roc.inria.fr/gamma/gamma/Membres/CIPD/Loic.Marechal/Research/LM5.html
• ply (ASCII and binary, single and double precision) http://en.wikipedia.org/wiki/PLY_(file_format)
• OFF http://www.geomview.org/docs/html/OFF.html
• STL (ASCII and binary) http://en.wikipedia.org/wiki/STL_(file_format)

MeshIOHandlers are created using method create() which uses the Factory service. Handlers for new file formats can be implemented and registered to the factory using geo_register_MeshIOHandler_creator().

See also

MeshIOHandlerFactory

geo_register_MeshIOHandler_creator

Definition at line 352 of file mesh_io.h.

Constructor & Destructor Documentation

MeshIOHandler()

GEO::MeshIOHandler::MeshIOHandler ( )

inlineprotected

MeshIOHandler default constructor.

Definition at line 408 of file mesh_io.h.

Member Function Documentation

create()

static MeshIOHandler * GEO::MeshIOHandler::create ( const std::string &  format )

static

Creates a MeshIOHandler.

Parameters

[in]

format

format of the file

Return values

nullptr	if format is not a supported file format.
otherwise,a	pointer to a IO handler. The returned pointer must be stored in an MeshIOHandler_var that does automatic destruction: MeshIOHandler_var handler = MeshIOHandler::create("mesh");

get_handler()

static MeshIOHandler * GEO::MeshIOHandler::get_handler ( const std::string &  filename )

static

Gets the MeshIOHandler for a file.

Determines the file format from the extension of file filename and creates a MeshIOHandler for this format.

Parameters

[in]

filename

a path to a mesh file

Return values

nullptr	if format is not a supported file format.
a	pointer to a IO handler if format is supported.
nullptr	otherwise

See also

create()

load()

virtual bool GEO::MeshIOHandler::load ( const std::string &  filename, Mesh &  M, const MeshIOFlags &  ioflags = MeshIOFlags()  )

pure virtual

Loads a double precision mesh from a file.

Parameters

[in]	filename	name of the file
[out]	M	the loaded mesh
[in]	ioflags	specifies which attributes and elements should be loaded

save()

virtual bool GEO::MeshIOHandler::save ( const Mesh &  M, const std::string &  filename, const MeshIOFlags &  ioflags = MeshIOFlags()  )

pure virtual

Saves a mesh to a file.

Parameters

[in]	M	the mesh to save
[in]	filename	name of the file
[in]	ioflags	specifies which attributes and elements should be saved

Returns

true on success, false otherwise.

Friends And Related Symbol Documentation

MeshIOHandler_var

typedef SmartPointer<MeshIOHandler> MeshIOHandler_var

related

A smart pointer that contains a MeshIOHandler object.

Definition at line 432 of file mesh_io.h.

MeshIOHandlerFactory

typedef Factory0<MeshIOHandler> MeshIOHandlerFactory

related

MeshIOHandler Factory.

This Factory is used to create MeshIOHandler objects. It can also be used to register new MeshIOHandler implementations.

See also

geo_register_MeshIOHandler_creator

Factory

Definition at line 444 of file mesh_io.h.

Member Data Documentation

cell_region_

Attribute<index_t> GEO::MeshIOHandler::cell_region_

protected

Definition at line 425 of file mesh_io.h.

edge_region_

Attribute<index_t> GEO::MeshIOHandler::edge_region_

protected

Definition at line 423 of file mesh_io.h.

facet_region_

Attribute<index_t> GEO::MeshIOHandler::facet_region_

protected

Definition at line 424 of file mesh_io.h.

vertex_region_

Attribute<index_t> GEO::MeshIOHandler::vertex_region_

protected

Definition at line 422 of file mesh_io.h.

---

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

• geogram/mesh/mesh_io.h