Artec 3D Scanning SDK  2.0
Static Public Member Functions | List of all members
artec::sdk::base::io::Ply Class Reference

Class to save/load PLY files (Stanford Polygon File Format) More...

#include <artec/sdk/base/io/PlyIO.h>

Static Public Member Functions

static ErrorCode saveTexture (const wchar_t *filename, const IFrameMesh *mesh, const wchar_t *imageFormat=L"png")
 Save texture for a given surface. More...
 
static ErrorCode saveTextures (const wchar_t *filename, const ICompositeMesh *mesh, const wchar_t *imageFormat=L"png")
 Save textures for a given surface. More...
 
static ErrorCode save (const wchar_t *path, const IFrameMesh *mesh, const Matrix3x4D *calibrationMatrix=NULL, IProgressInfo *progr=NULL, ICancellationToken *cncl=NULL, bool binary=true, bool saveTexCoords=true, bool saveTexMatrix=false, bool saveTextures=true, const wchar_t *imageFormat=L"png")
 Save IFrameMesh/ICompositeMesh to PLY file. More...
 
static ErrorCode save (const wchar_t *path, const ICompositeMesh *mesh, const Matrix3x4D *calibrationMatrix=NULL, IProgressInfo *progr=NULL, ICancellationToken *cncl=NULL, bool binary=true, bool saveTexCoords=true, bool saveTexMatrix=false, bool saveTextures=true, const wchar_t *imageFormat=L"png")
 Save IFrameMesh/ICompositeMesh to PLY file. More...
 
static ErrorCode save (IBlob **data, const IFrameMesh *mesh, const Matrix3x4D *calibrationMatrix, IProgressInfo *progr=0, ICancellationToken *cncl=0, bool binary=true, bool saveTexCoords=true, bool saveTexMatrix=false)
 Save IFrameMesh/ICompositeMesh to PLY blob. More...
 
static ErrorCode save (IBlob **data, const ICompositeMesh *mesh, const Matrix3x4D *calibrationMatrix, IProgressInfo *progr=0, ICancellationToken *cncl=0, bool binary=true, bool saveTexCoords=true, bool saveTexMatrix=false)
 Save IFrameMesh/ICompositeMesh to PLY blob. More...
 
static ErrorCode load (IFrameMesh **mesh, Matrix3x4D *calibrationMatrix, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from PLY file. More...
 
static ErrorCode load (ICompositeMesh **mesh, Matrix3x4D *calibrationMatrix, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from PLY file. More...
 
static ErrorCode load (IFrameMesh **mesh, Matrix3x4D *calibrationMatrix, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from PLY blob. More...
 
static ErrorCode load (ICompositeMesh **mesh, Matrix3x4D *calibrationMatrix, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from PLY blob. More...
 

Detailed Description

Class to save/load PLY files (Stanford Polygon File Format)

Definition at line 125 of file PlyIO.h.

Member Function Documentation

static ErrorCode artec::sdk::base::io::Ply::load ( IFrameMesh **  mesh,
Matrix3x4D *  calibrationMatrix,
const wchar_t *  path,
IProgressInfo *  progr = 0,
ICancellationToken *  cncl = 0 
)
inlinestatic

Load IFrameMesh/ICompositeMesh from PLY file.

Parameters
mesh- loaded mesh
calibrationMatrix- calibration matrix 3x4
path- file path to load image from
progr- progress interface
cncl- cancellation interface

Definition at line 202 of file PlyIO.h.

static ErrorCode artec::sdk::base::io::Ply::load ( ICompositeMesh **  mesh,
Matrix3x4D *  calibrationMatrix,
const wchar_t *  path,
IProgressInfo *  progr = 0,
ICancellationToken *  cncl = 0 
)
inlinestatic

Load IFrameMesh/ICompositeMesh from PLY file.

Parameters
mesh- loaded mesh
calibrationMatrix- calibration matrix 3x4
path- file path to load image from
progr- progress interface
cncl- cancellation interface

Definition at line 207 of file PlyIO.h.

static ErrorCode artec::sdk::base::io::Ply::load ( IFrameMesh **  mesh,
Matrix3x4D *  calibrationMatrix,
const IBlob *  data,
IProgressInfo *  progr = 0,
ICancellationToken *  cncl = 0 
)
inlinestatic

Load IFrameMesh/ICompositeMesh from PLY blob.

Note
Loads only geometry without texture (image is stored in a separate blob)
Parameters
mesh- loaded mesh
calibrationMatrix- calibration matrix 3x4
data- blob to load image from
progr- progress interface
cncl- cancellation interface

Definition at line 222 of file PlyIO.h.

static ErrorCode artec::sdk::base::io::Ply::load ( ICompositeMesh **  mesh,
Matrix3x4D *  calibrationMatrix,
const IBlob *  data,
IProgressInfo *  progr = 0,
ICancellationToken *  cncl = 0 
)
inlinestatic

Load IFrameMesh/ICompositeMesh from PLY blob.

Note
Loads only geometry without texture (image is stored in a separate blob)
Parameters
mesh- loaded mesh
calibrationMatrix- calibration matrix 3x4
data- blob to load image from
progr- progress interface
cncl- cancellation interface

Definition at line 227 of file PlyIO.h.

static ErrorCode artec::sdk::base::io::Ply::save ( const wchar_t *  path,
const IFrameMesh *  mesh,
const Matrix3x4D *  calibrationMatrix = NULL,
IProgressInfo *  progr = NULL,
ICancellationToken *  cncl = NULL,
bool  binary = true,
bool  saveTexCoords = true,
bool  saveTexMatrix = false,
bool  saveTextures = true,
const wchar_t *  imageFormat = L"png" 
)
inlinestatic

Save IFrameMesh/ICompositeMesh to PLY file.

Parameters
path- file path where to save mesh
mesh- mesh to save
calibrationMatrix- calibration matrix 3x4 to save
progr- progress interface
cncl- cancellation interface
binary- text or binary PLY format
saveTexCoords- save texture coordinates
saveTexMatrix- save texture matrix
saveTextures- save texture images alongside with PLY file (available only for out-to-file functions). This flag is valid only when saveTexCoords == true
imageFormat- texture image format if applicable ("png", "jpg", "bmp")

Definition at line 144 of file PlyIO.h.

static ErrorCode artec::sdk::base::io::Ply::save ( const wchar_t *  path,
const ICompositeMesh *  mesh,
const Matrix3x4D *  calibrationMatrix = NULL,
IProgressInfo *  progr = NULL,
ICancellationToken *  cncl = NULL,
bool  binary = true,
bool  saveTexCoords = true,
bool  saveTexMatrix = false,
bool  saveTextures = true,
const wchar_t *  imageFormat = L"png" 
)
inlinestatic

Save IFrameMesh/ICompositeMesh to PLY file.

Parameters
path- file path where to save mesh
mesh- mesh to save
calibrationMatrix- calibration matrix 3x4 to save
progr- progress interface
cncl- cancellation interface
binary- text or binary PLY format
saveTexCoords- save texture coordinates
saveTexMatrix- save texture matrix
saveTextures- save texture images alongside with PLY file (available only for out-to-file functions). This flag is valid only when saveTexCoords == true
imageFormat- texture image format if applicable ("png", "jpg", "bmp")

Definition at line 153 of file PlyIO.h.

static ErrorCode artec::sdk::base::io::Ply::save ( IBlob **  data,
const IFrameMesh *  mesh,
const Matrix3x4D *  calibrationMatrix,
IProgressInfo *  progr = 0,
ICancellationToken *  cncl = 0,
bool  binary = true,
bool  saveTexCoords = true,
bool  saveTexMatrix = false 
)
inlinestatic

Save IFrameMesh/ICompositeMesh to PLY blob.

Note
Saves only geometry without texture (images are stored in a separate blob)
Parameters
data- blob where to save mesh
mesh- mesh to save
calibrationMatrix- calibration matrix 3x4 to save
progr- progress interface
cncl- cancellation interface
binary- text or binary PLY format
saveTexCoords- save texture coordinates
saveTexMatrix- save texture matrix
saveTextures- save texture images alongside with PLY file (available only for out-to-file functions). This flag is valid only when saveTexCoords == true
imageFormat- texture image format if applicable ("png", "jpg", "bmp")

Definition at line 178 of file PlyIO.h.

static ErrorCode artec::sdk::base::io::Ply::save ( IBlob **  data,
const ICompositeMesh *  mesh,
const Matrix3x4D *  calibrationMatrix,
IProgressInfo *  progr = 0,
ICancellationToken *  cncl = 0,
bool  binary = true,
bool  saveTexCoords = true,
bool  saveTexMatrix = false 
)
inlinestatic

Save IFrameMesh/ICompositeMesh to PLY blob.

Note
Saves only geometry without texture (images are stored in a separate blob)
Parameters
data- blob where to save mesh
mesh- mesh to save
calibrationMatrix- calibration matrix 3x4 to save
progr- progress interface
cncl- cancellation interface
binary- text or binary PLY format
saveTexCoords- save texture coordinates
saveTexMatrix- save texture matrix
saveTextures- save texture images alongside with PLY file (available only for out-to-file functions). This flag is valid only when saveTexCoords == true
imageFormat- texture image format if applicable ("png", "jpg", "bmp")

Definition at line 186 of file PlyIO.h.

static ErrorCode artec::sdk::base::io::Ply::saveTexture ( const wchar_t *  filename,
const IFrameMesh *  mesh,
const wchar_t *  imageFormat = L"png" 
)
static

Save texture for a given surface.

Note
This function is called by the save() functions (out-to-file versions) when save_textures == true && save_texcoords == true.
Parameters
filename- file path to the PLY file. File names for textures will be generated automatically.
mesh- textured mesh to save
imageFormat- texture image format if applicable ("png", "jpg", "bmp")
static ErrorCode artec::sdk::base::io::Ply::saveTextures ( const wchar_t *  filename,
const ICompositeMesh *  mesh,
const wchar_t *  imageFormat = L"png" 
)
static

Save textures for a given surface.

Note
This function is called by the save() functions (out-to-file versions) when save_textures == true && save_texcoords == true.
Parameters
filename- file path to the PLY file. File names for textures will be generated automatically.
mesh- textured mesh to save
imageFormat- texture image format if applicable ("png", "jpg", "bmp")
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.9.1