artec::sdk::base::io::Ply Class Reference

#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")
 
static ErrorCode saveTextures (const wchar_t *filename, const ICompositeMesh *mesh, const wchar_t *imageFormat=L"png")
 
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")
 
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")
 
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)
 
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)
 
static ErrorCode load (IFrameMesh **mesh, Matrix3x4D *calibrationMatrix, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
static ErrorCode load (ICompositeMesh **mesh, Matrix3x4D *calibrationMatrix, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
static ErrorCode load (IFrameMesh **mesh, Matrix3x4D *calibrationMatrix, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
static ErrorCode load (ICompositeMesh **mesh, Matrix3x4D *calibrationMatrix, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 

Detailed Description

Definition at line 131 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- cancel interface
Returns
error code

Definition at line 211 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- cancel interface
Returns
error code

Definition at line 216 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
load only geometry, not texture also, because image is stored in separate blob
Parameters
mesh- loaded mesh
calibrationMatrix- calibration matrix 3x4
data- blob to load image from
progr- progress interface
cncl- cancel interface
Returns
error code

Definition at line 232 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
load only geometry, not texture also, because image is stored in separate blob
Parameters
mesh- loaded mesh
calibrationMatrix- calibration matrix 3x4
data- blob to load image from
progr- progress interface
cncl- cancel interface
Returns
error code

Definition at line 237 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 to save mesh to
mesh- mesh to be saved
calibrationMatrix- calibration matrix 3x4 to be saved
progr- progress interface
cncl- cancel interface
binary- text or binary ply format
saveTexCoords- if texture coordinates should be saved
saveTexMatrix- if texture matrix should be saved
saveTextures- if texture images should be saved near PLY file (available only for out-to-file functions). this flag is valid only when save_texcoords == true
imageFormat- format for texture images if they should be saved ("png","jpg","bmp")
Returns
error code

Definition at line 151 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 to save mesh to
mesh- mesh to be saved
calibrationMatrix- calibration matrix 3x4 to be saved
progr- progress interface
cncl- cancel interface
binary- text or binary ply format
saveTexCoords- if texture coordinates should be saved
saveTexMatrix- if texture matrix should be saved
saveTextures- if texture images should be saved near PLY file (available only for out-to-file functions). this flag is valid only when save_texcoords == true
imageFormat- format for texture images if they should be saved ("png","jpg","bmp")
Returns
error code

Definition at line 160 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
save only geometry, not texture also, because images is stored in separate blob
Parameters
data- blob to save mesh to
mesh- mesh to be saved
calibrationMatrix- calibration matrix 3x4 to be saved
progr- progress interface
cncl- cancel interface
binary- text or binary ply format
saveTexCoords- if texture coordinates should be saved
saveTexMatrix- if texture matrix should be saved
saveTextures- if texture images should be saved near PLY file (available only for out-to-file functions). this flag is valid only when save_texcoords == true
imageFormat- format for texture images if they should be saved ("png","jpg","bmp")
Returns
error code

Definition at line 186 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
save only geometry, not texture also, because images is stored in separate blob
Parameters
data- blob to save mesh to
mesh- mesh to be saved
calibrationMatrix- calibration matrix 3x4 to be saved
progr- progress interface
cncl- cancel interface
binary- text or binary ply format
saveTexCoords- if texture coordinates should be saved
saveTexMatrix- if texture matrix should be saved
saveTextures- if texture images should be saved near PLY file (available only for out-to-file functions). this flag is valid only when save_texcoords == true
imageFormat- format for texture images if they should be saved ("png","jpg","bmp")
Returns
error code

Definition at line 194 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 given surface

Note
This function is called by save() (out-to-file versions) functions when save_textures == true && save_texcoords == true.
Parameters
filename- file path to .ply file. File names for textures will be generated automatically.
mesh- textured mesh to be saved
imageFormat- format for texture images if they should be saved ("png","jpg","bmp")
Returns
error code
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 given surface

Note
This function is called by save() (out-to-file versions) functions when save_textures == true && save_texcoords == true.
Parameters
filename- file path to .ply file. File names for textures will be generated automatically.
mesh- textured mesh to be saved
imageFormat- format for texture images if they should be saved ("png","jpg","bmp")
Returns
error code

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