DGtal  1.3.beta
Static Public Member Functions
DGtal::MeshReader< TPoint > Struct Template Reference

Aim: Defined to import OFF and OFS surface mesh. It allows to import a Mesh object and takes into accouts the optional color faces. More...

#include <DGtal/io/readers/MeshReader.h>

Static Public Member Functions

static bool importOFFFile (const std::string &filename, DGtal::Mesh< TPoint > &aMesh, bool invertVertexOrder=false)
 
static bool importOFSFile (const std::string &filename, DGtal::Mesh< TPoint > &aMesh, bool invertVertexOrder=false, double scale=1.0)
 
static bool importOBJFile (const std::string &filename, DGtal::Mesh< TPoint > &aMesh)
 
static bool verifyIndicesUniqueness (const std::vector< unsigned int > &indices)
 
static std::map< std::string, DGtal::ColorreadMaterial (std::istream &input)
 

Detailed Description

template<typename TPoint>
struct DGtal::MeshReader< TPoint >

Aim: Defined to import OFF and OFS surface mesh. It allows to import a Mesh object and takes into accouts the optional color faces.

Description of class 'MeshReader'

The importation can be done automatically according the input file extension with the operator <<

Example of typical use: Add these include files:

#include "DGtal/shapes/Mesh.h"
#include "DGtal/io/readers/MeshReader.h"

And automatic import the Mesh through the filename extension:

std::string filenameOFF = testPath + "samples/box.off";
Mesh<Point> a3DMesh;
bool importOK = a3DMesh << filenameOFF;

Then you can also display the resulting with a Viewer3D:

viewer.setLineColor(DGtal::Color(150,0,0,254));
viewer << a3DMesh;
See also
Mesh MeshWriter

Definition at line 96 of file MeshReader.h.

Member Function Documentation

◆ importOBJFile()

template<typename TPoint >
static bool DGtal::MeshReader< TPoint >::importOBJFile ( const std::string &  filename,
DGtal::Mesh< TPoint > &  aMesh 
)
static

Reads an input file as an OBJ file format and outputs the corresponding surface mesh.

Parameters
[in]filenamethe input filename of the OBJ file to be read.
[out]aMeshthe output mesh.
Returns
'true' if both reading the input stream was ok and the created mesh is ok.

◆ importOFFFile()

template<typename TPoint >
static bool DGtal::MeshReader< TPoint >::importOFFFile ( const std::string &  filename,
DGtal::Mesh< TPoint > &  aMesh,
bool  invertVertexOrder = false 
)
static

Main method to import OFF meshes file (Geomview Object File Format)

Parameters
filenamethe file name to import.
aMesh(return) the mesh object to be imported.
invertVertexOrderused to invert (default value=false) the order of imported points (important for normal orientation).
Returns
an instance of the imported mesh: MeshFromPoint.

Referenced by TEST_CASE().

◆ importOFSFile()

template<typename TPoint >
static bool DGtal::MeshReader< TPoint >::importOFSFile ( const std::string &  filename,
DGtal::Mesh< TPoint > &  aMesh,
bool  invertVertexOrder = false,
double  scale = 1.0 
)
static

Main method to import OFS meshes file (an equivalent of OFF format)

Parameters
filenamethe file name to import.
aMesh(return) the mesh object to be imported.
invertVertexOrderused to invert (default value=false) the order of imported points (important for normal orientation).
scaleused to avoid to display tiny shapes (since OFS shapes are generally included in a 1x1x1 cube)
Returns
an instance of the imported mesh: MeshFromPoint.

◆ readMaterial()

template<typename TPoint >
static std::map<std::string, DGtal::Color> DGtal::MeshReader< TPoint >::readMaterial ( std::istream &  input)
static

Reads an input material file associated ot an OBJ file format and outputs the corresponding materials as a map assiating name and diffuse color.

Parameters
[in,out]inputthe input stream where the OBJ file is read.
Returns
'true' if both reading the input stream was ok and the created mesh is ok.

◆ verifyIndicesUniqueness()

template<typename TPoint >
static bool DGtal::MeshReader< TPoint >::verifyIndicesUniqueness ( const std::vector< unsigned int > &  indices)
static

Checks that each index in indices is unique.

Parameters
indicesa vector of integer indices
Returns
'true' iff the integer indices are all pairwise different.

The documentation for this struct was generated from the following file:
DGtal::Color
Structure representing an RGB triple with alpha component.
Definition: Color.h:67
DGtal::Display3D< SpaceND< 3 >, KhalimskySpaceND< 3 > >::updateDisplay
@ updateDisplay
Definition: Display3D.h:249