Artec 3D Scanning SDK  2.0
Classes | Functions
artec::sdk::base::io Namespace Reference

Classes

class  Aop
 Export to AOP format (American Academy of Orthotists & Prosthetists) More...
 
class  Bmp
 Class to save/load BMP files. More...
 
class  Buff
 Class to save/load BUFF (simple format to store mesh data). More...
 
class  Jpg
 Class to save/load JPG files. More...
 
class  Obj
 Class to save/load OBJ files. More...
 
class  Ply
 Class to save/load PLY files (Stanford Polygon File Format) More...
 
class  Png
 Class to save/load PNG files. More...
 
class  Stl
 Class to save/load STL files (STereoLithography) More...
 

Functions

ErrorCode ABASESDK_LINK_SPEC saveAopImageToFile (const wchar_t *path, const IRangeImageCylindric *ri)
 Save range image to AOP file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveAopMeshToFile (const wchar_t *path, const IMesh *surface, int width, int height, bool interpolateHoles, bool cutEdges=false, int edgeQualityFactor=80)
 Save surface in AOP format by converting it to the image. More...
 
ErrorCode ABASESDK_LINK_SPEC saveBuffFrameToFile (const wchar_t *path, const IFrameMesh *mesh, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Save IFrameMesh to BUFF file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveBuffFrameToBlob (IBlob **data, const IFrameMesh *mesh, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Save IFrameMesh to BUFF blob. More...
 
ErrorCode ABASESDK_LINK_SPEC loadBuffFrameFromFile (IFrameMesh **mesh, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh from BUFF file. More...
 
ErrorCode ABASESDK_LINK_SPEC loadBuffFrameFromBlob (IFrameMesh **mesh, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh from BUFF blob. More...
 
ErrorCode ABASESDK_LINK_SPEC loadImage32fFromFile (IImage **image, const wchar_t *path)
 Load float-value image from file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveImage32fToFile (const wchar_t *path, const IImage *image)
 Save float-value image to file. More...
 
ErrorCode ABASESDK_LINK_SPEC loadImageFromFile (IImage **image, const wchar_t *path)
 Load image from file having automatically detected its type based on its extension. More...
 
ErrorCode ABASESDK_LINK_SPEC loadImageFromBlob (IImage **image, const IBlob *data, const wchar_t *formatExt)
 Load image from data in the memory buffer having automatically detected its type based on its extension. More...
 
ErrorCode ABASESDK_LINK_SPEC saveImageToFile (const wchar_t *path, const IImage *image)
 Save image to file having automatically detected its type based on its extension. More...
 
ErrorCode ABASESDK_LINK_SPEC saveImageToBlob (IBlob **data, const IImage *image, const wchar_t *formatExt)
 Save image to memory buffer having automatically detected its type based on its extension. More...
 
ErrorCode ABASESDK_LINK_SPEC savePlyTexture (const wchar_t *filename, const IFrameMesh *mesh, const wchar_t *imageFormat=L"png")
 Save texture for a given surface. More...
 
ErrorCode ABASESDK_LINK_SPEC savePlyTextures (const wchar_t *filename, const ICompositeMesh *mesh, const wchar_t *imageFormat=L"png")
 Save textures for a given surface. More...
 
ErrorCode ABASESDK_LINK_SPEC saveStlMeshToFile (const wchar_t *path, const IMesh *surf, bool binary=true, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Save IMesh surface to STL file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveStlMeshToFileAscii (const wchar_t *path, const IMesh *surf, const char *name=NULL, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Save IMesh surface to ASCII STL file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveStlMeshToFileBinary (const wchar_t *path, const IMesh *surf, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Save IMesh surface to binary STL file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveStlMeshToBlob (IBlob **data, const IMesh *surf, bool binary=true, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Save IMesh surface to STL blob. More...
 
ErrorCode ABASESDK_LINK_SPEC saveStlMeshToBlobAscii (IBlob **data, const IMesh *surf, const char *name=NULL, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Save IMesh surface to ASCII STL blob. More...
 
ErrorCode ABASESDK_LINK_SPEC saveStlMeshToBlobBinary (IBlob **data, const IMesh *surf, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Save IMesh surface to binary STL blob. More...
 
bool ABASESDK_LINK_SPEC isStlBinary (const wchar_t *path)
 Determines the format of the saved file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveBmpImageToFile (const wchar_t *path, const IImage *image)
 
ErrorCode ABASESDK_LINK_SPEC saveBmpImageToBlob (IBlob **data, const IImage *image)
 
ErrorCode ABASESDK_LINK_SPEC loadBmpImageFromFile (IImage **image, const wchar_t *path)
 
ErrorCode ABASESDK_LINK_SPEC loadBmpImageFromBlob (IImage **image, const IBlob *data)
 
ErrorCode ABASESDK_LINK_SPEC saveJpgImageToFile (const wchar_t *path, const IImage *image, int quality=100)
 
ErrorCode ABASESDK_LINK_SPEC saveJpgImageToBlob (IBlob **data, const IImage *image, int quality=100)
 
ErrorCode ABASESDK_LINK_SPEC loadJpgImageFromFile (IImage **image, const wchar_t *path)
 
ErrorCode ABASESDK_LINK_SPEC loadJpgImageFromBlob (IImage **image, const IBlob *data)
 
ErrorCode ABASESDK_LINK_SPEC saveObjFrameToFile (const wchar_t *path, const IFrameMesh *mesh, IProgressInfo *progr=0, ICancellationToken *cncl=0, bool saveNormals=true, bool saveTexCoords=true, const wchar_t *imageFormat=L"png")
 Save IFrameMesh/ICompositeMesh to OBJ file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveObjCompositeToFile (const wchar_t *path, const ICompositeMesh *mesh, IProgressInfo *progr=0, ICancellationToken *cncl=0, bool saveNormals=true, bool saveTexCoords=true, const wchar_t *imageFormat=L"png")
 Save IFrameMesh/ICompositeMesh to OBJ file. More...
 
ErrorCode ABASESDK_LINK_SPEC saveObjFrameToBlob (IBlob **data, const IFrameMesh *mesh, IProgressInfo *progr=0, ICancellationToken *cncl=0, bool saveNormals=true, bool saveTexCoords=true, const wchar_t *materialFilename=NULL)
 Save IFrameMesh/ICompositeMesh to OBJ blob. More...
 
ErrorCode ABASESDK_LINK_SPEC saveObjCompositeToBlob (IBlob **data, const ICompositeMesh *mesh, IProgressInfo *progr=0, ICancellationToken *cncl=0, bool saveNormals=true, bool saveTexCoords=true, const wchar_t *materialFilename=NULL)
 Save IFrameMesh/ICompositeMesh to OBJ blob. More...
 
ErrorCode ABASESDK_LINK_SPEC loadObjFrameFromFile (IFrameMesh **mesh, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from OBJ file. More...
 
ErrorCode ABASESDK_LINK_SPEC loadObjCompositeFromFile (ICompositeMesh **mesh, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from OBJ file. More...
 
ErrorCode ABASESDK_LINK_SPEC loadObjFrameFromBlob (IFrameMesh **mesh, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from OBJ blob. More...
 
ErrorCode ABASESDK_LINK_SPEC loadObjCompositeFromBlob (ICompositeMesh **mesh, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from OBJ blob. More...
 
ErrorCode ABASESDK_LINK_SPEC savePlyFrameToFile (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...
 
ErrorCode ABASESDK_LINK_SPEC savePlyCompositeToFile (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...
 
ErrorCode ABASESDK_LINK_SPEC savePlyFrameToBlob (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...
 
ErrorCode ABASESDK_LINK_SPEC savePlyCompositeToBlob (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...
 
ErrorCode ABASESDK_LINK_SPEC loadPlyFrameFromFile (IFrameMesh **mesh, Matrix3x4D *calibrationMatrix, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from PLY file. More...
 
ErrorCode ABASESDK_LINK_SPEC loadPlyCompositeFromFile (ICompositeMesh **mesh, Matrix3x4D *calibrationMatrix, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from PLY file. More...
 
ErrorCode ABASESDK_LINK_SPEC loadPlyFrameFromBlob (IFrameMesh **mesh, Matrix3x4D *calibrationMatrix, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from PLY blob. More...
 
ErrorCode ABASESDK_LINK_SPEC loadPlyCompositeFromBlob (ICompositeMesh **mesh, Matrix3x4D *calibrationMatrix, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 Load IFrameMesh/ICompositeMesh from PLY blob. More...
 
ErrorCode ABASESDK_LINK_SPEC savePngImageToFile (const wchar_t *path, const IImage *image)
 
ErrorCode ABASESDK_LINK_SPEC savePngImageToBlob (IBlob **data, const IImage *image)
 
ErrorCode ABASESDK_LINK_SPEC loadPngImageFromFile (IImage **image, const wchar_t *path)
 
ErrorCode ABASESDK_LINK_SPEC loadPngImageFromBlob (IImage **image, const IBlob *data)
 
ErrorCode ABASESDK_LINK_SPEC loadStlMeshFromFile (IMesh **surf, const wchar_t *path, bool binary, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
ErrorCode ABASESDK_LINK_SPEC loadStlMeshFromFileAutodetect (IMesh **surf, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
ErrorCode ABASESDK_LINK_SPEC loadStlMeshFromFileAscii (IMesh **surf, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
ErrorCode ABASESDK_LINK_SPEC loadStlMeshFromFileBinary (IMesh **surf, const wchar_t *path, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
ErrorCode ABASESDK_LINK_SPEC loadStlMeshFromBlob (IMesh **surf, const IBlob *data, bool binary, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
ErrorCode ABASESDK_LINK_SPEC loadStlMeshFromBlobAscii (IMesh **surf, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 
ErrorCode ABASESDK_LINK_SPEC loadStlMeshFromBlobBinary (IMesh **surf, const IBlob *data, IProgressInfo *progr=0, ICancellationToken *cncl=0)
 

Function Documentation

bool ABASESDK_LINK_SPEC artec::sdk::base::io::isStlBinary ( const wchar_t *  path)

Determines the format of the saved file.

ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadBmpImageFromBlob ( IImage **  image,
const IBlob data 
)

Load image from BMP file/blob

Parameters
image- loaded image
path- file path to load image from
data- blob to load image from
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadBmpImageFromFile ( IImage **  image,
const wchar_t *  path 
)

Load image from BMP file/blob

Parameters
image- loaded image
path- file path to load image from
data- blob to load image from
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadBuffFrameFromBlob ( IFrameMesh **  mesh,
const IBlob data,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load IFrameMesh from BUFF blob.

Note
Loads only geometry without texture (image is stored in a separate blob)
Parameters
mesh- loaded mesh
data- blob to load image from
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadBuffFrameFromFile ( IFrameMesh **  mesh,
const wchar_t *  path,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load IFrameMesh from BUFF file.

Parameters
mesh- loaded mesh
path- file path to load image from
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadImage32fFromFile ( IImage **  image,
const wchar_t *  path 
)

Load float-value image from file.

ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadImageFromBlob ( IImage **  image,
const IBlob data,
const wchar_t *  formatExt 
)

Load image from data in the memory buffer having automatically detected its type based on its extension.

Note
currently BMP, JPG, PNG
Parameters
formatExt".bmp" for BMP ".jpg" or ".jpeg" or ".jpe" for JPG ".png" for PNG
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadImageFromFile ( IImage **  image,
const wchar_t *  path 
)

Load image from file having automatically detected its type based on its extension.

Note
currently BMP, JPG, PNG
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadJpgImageFromBlob ( IImage **  image,
const IBlob data 
)

Load image from JPEG file/blob

Parameters
image- loaded image
path- file path to load image from
data- blob to load image from
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadJpgImageFromFile ( IImage **  image,
const wchar_t *  path 
)

Load image from JPEG file/blob

Parameters
image- loaded image
path- file path to load image from
data- blob to load image from
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadObjCompositeFromBlob ( ICompositeMesh **  mesh,
const IBlob data,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load IFrameMesh/ICompositeMesh from OBJ blob.

Note
Loads only geometry without texture (image is stored in a separate blob)
Parameters
mesh- loaded mesh
data- blob to load image from
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadObjCompositeFromFile ( ICompositeMesh **  mesh,
const wchar_t *  path,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load IFrameMesh/ICompositeMesh from OBJ file.

Parameters
mesh- loaded mesh
path- file path to load image from
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadObjFrameFromBlob ( IFrameMesh **  mesh,
const IBlob data,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load IFrameMesh/ICompositeMesh from OBJ blob.

Note
Loads only geometry without texture (image is stored in a separate blob)
Parameters
mesh- loaded mesh
data- blob to load image from
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadObjFrameFromFile ( IFrameMesh **  mesh,
const wchar_t *  path,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load IFrameMesh/ICompositeMesh from OBJ file.

Parameters
mesh- loaded mesh
path- file path to load image from
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadPlyCompositeFromBlob ( ICompositeMesh **  mesh,
Matrix3x4D calibrationMatrix,
const IBlob data,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

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
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadPlyCompositeFromFile ( ICompositeMesh **  mesh,
Matrix3x4D calibrationMatrix,
const wchar_t *  path,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

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
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadPlyFrameFromBlob ( IFrameMesh **  mesh,
Matrix3x4D calibrationMatrix,
const IBlob data,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

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
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadPlyFrameFromFile ( IFrameMesh **  mesh,
Matrix3x4D calibrationMatrix,
const wchar_t *  path,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

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
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadPngImageFromBlob ( IImage **  image,
const IBlob data 
)

Load image from PNG file/blob

Parameters
image- loaded image
path- file path to load image from
data- blob to load image from
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadPngImageFromFile ( IImage **  image,
const wchar_t *  path 
)

Load image from PNG file/blob

Parameters
image- loaded image
path- file path to load image from
data- blob to load image from
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadStlMeshFromBlob ( IMesh **  surf,
const IBlob data,
bool  binary,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load surface from file/blob in STL format

Parameters
stream- where the surface will be loaded from
path- file path to load surface from
surf- loaded surface
binary- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadStlMeshFromBlobAscii ( IMesh **  surf,
const IBlob data,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load surface from file/blob in STL format

Parameters
stream- where the surface will be loaded from
path- file path to load surface from
surf- loaded surface
binary- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadStlMeshFromBlobBinary ( IMesh **  surf,
const IBlob data,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load surface from file/blob in STL format

Parameters
stream- where the surface will be loaded from
path- file path to load surface from
surf- loaded surface
binary- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadStlMeshFromFile ( IMesh **  surf,
const wchar_t *  path,
bool  binary,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load surface from file/blob in STL format

Parameters
stream- where the surface will be loaded from
path- file path to load surface from
surf- loaded surface
binary- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadStlMeshFromFileAscii ( IMesh **  surf,
const wchar_t *  path,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load surface from file/blob in STL format

Parameters
stream- where the surface will be loaded from
path- file path to load surface from
surf- loaded surface
binary- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadStlMeshFromFileAutodetect ( IMesh **  surf,
const wchar_t *  path,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load surface from file/blob in STL format

Parameters
stream- where the surface will be loaded from
path- file path to load surface from
surf- loaded surface
binary- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::loadStlMeshFromFileBinary ( IMesh **  surf,
const wchar_t *  path,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Load surface from file/blob in STL format

Parameters
stream- where the surface will be loaded from
path- file path to load surface from
surf- loaded surface
binary- data format: binary or text. Load-from-file functions use the isBinary() call to determine it.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveAopImageToFile ( const wchar_t *  path,
const IRangeImageCylindric ri 
)

Save range image to AOP file.

Parameters
pathFile path where to save mesh
riRange image to save
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveAopMeshToFile ( const wchar_t *  path,
const IMesh surface,
int  width,
int  height,
bool  interpolateHoles,
bool  cutEdges = false,
int  edgeQualityFactor = 80 
)

Save surface in AOP format by converting it to the image.

Parameters
pathFile path where to save mesh
surfaceSurface to save
width,heightDimensions of range image texture in pixels
interpolateHolesIf it is true, then holes will be interpolated linearly on cylinder
cutEdgesCut top and bottom of the cylinder if the percentage of populated cells in range image is less than the edgeQualityFactor
edgeQualityFactorThe required percentage of populated cells on edges (in [0..100]).
Note
Surface must be in the origin and aligned along the OY axis, so that OY is inside the surface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveBmpImageToBlob ( IBlob **  data,
const IImage image 
)

Save image to BMP file/blob

Parameters
path- file path where to save image
data- blob pointer where to save image
image- image to save (not empty, 1 or 3 channels)
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveBmpImageToFile ( const wchar_t *  path,
const IImage image 
)

Save image to BMP file/blob

Parameters
path- file path where to save image
data- blob pointer where to save image
image- image to save (not empty, 1 or 3 channels)
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveBuffFrameToBlob ( IBlob **  data,
const IFrameMesh mesh,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Save IFrameMesh to BUFF blob.

Note
Saves only geometry without texture (image is stored in a separate blob)
Parameters
data- blob where to save mesh
mesh- mesh to save
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveBuffFrameToFile ( const wchar_t *  path,
const IFrameMesh mesh,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Save IFrameMesh to BUFF file.

Parameters
path- file path where to save mesh
mesh- mesh to save
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveImage32fToFile ( const wchar_t *  path,
const IImage image 
)

Save float-value image to file.

ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveImageToBlob ( IBlob **  data,
const IImage image,
const wchar_t *  formatExt 
)

Save image to memory buffer having automatically detected its type based on its extension.

Note
currently BMP, JPG, PNG
Parameters
$formatExt".bmp" for BMP ".jpg" or ".jpeg" or ".jpe" for JPG ".png" for PNG
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveImageToFile ( const wchar_t *  path,
const IImage image 
)

Save image to file having automatically detected its type based on its extension.

Note
currently BMP, JPG, PNG
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveJpgImageToBlob ( IBlob **  data,
const IImage image,
int  quality = 100 
)

Save image to JPEG file/blob

Parameters
path- file path where to save image
data- blob pointer where to save image
image- image to save (not empty, 1 or 3 channels)
quality- saved image quality
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveJpgImageToFile ( const wchar_t *  path,
const IImage image,
int  quality = 100 
)

Save image to JPEG file/blob

Parameters
path- file path where to save image
data- blob pointer where to save image
image- image to save (not empty, 1 or 3 channels)
quality- saved image quality
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveObjCompositeToBlob ( IBlob **  data,
const ICompositeMesh mesh,
IProgressInfo progr = 0,
ICancellationToken cncl = 0,
bool  saveNormals = true,
bool  saveTexCoords = true,
const wchar_t *  materialFilename = NULL 
)

Save IFrameMesh/ICompositeMesh to OBJ blob.

Note
Saves only geometry without texture and material (material and images are stored in a separate blob)
Parameters
data- blob where to save mesh
mesh- mesh to save
progr- progress interface
cncl- cancellation interface
saveNormals- save normals to file
saveTexCoords- save texture coordinates
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveObjCompositeToFile ( const wchar_t *  path,
const ICompositeMesh mesh,
IProgressInfo progr = 0,
ICancellationToken cncl = 0,
bool  saveNormals = true,
bool  saveTexCoords = true,
const wchar_t *  imageFormat = L"png" 
)

Save IFrameMesh/ICompositeMesh to OBJ file.

Parameters
path- file path where to save mesh
mesh- mesh to save
progr- progress interface
cncl- cancellation interface
saveNormals- save normals to file
saveTexCoords- save texture coordinates
imageFormat- texture image format if applicable ("png","jpg","bmp")
Note
If you set the saveTexCoords flag, then texture images will also be saved.
Examples:
scanning-and-process-sample.cpp.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveObjFrameToBlob ( IBlob **  data,
const IFrameMesh mesh,
IProgressInfo progr = 0,
ICancellationToken cncl = 0,
bool  saveNormals = true,
bool  saveTexCoords = true,
const wchar_t *  materialFilename = NULL 
)

Save IFrameMesh/ICompositeMesh to OBJ blob.

Note
Saves only geometry without texture and material (material and images are stored in a separate blob)
Parameters
data- blob where to save mesh
mesh- mesh to save
progr- progress interface
cncl- cancellation interface
saveNormals- save normals to file
saveTexCoords- save texture coordinates
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveObjFrameToFile ( const wchar_t *  path,
const IFrameMesh mesh,
IProgressInfo progr = 0,
ICancellationToken cncl = 0,
bool  saveNormals = true,
bool  saveTexCoords = true,
const wchar_t *  imageFormat = L"png" 
)

Save IFrameMesh/ICompositeMesh to OBJ file.

Parameters
path- file path where to save mesh
mesh- mesh to save
progr- progress interface
cncl- cancellation interface
saveNormals- save normals to file
saveTexCoords- save texture coordinates
imageFormat- texture image format if applicable ("png","jpg","bmp")
Note
If you set the saveTexCoords flag, then texture images will also be saved.
Examples:
scanning-and-process-sample.cpp.
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::savePlyCompositeToBlob ( 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.

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 a PLY file (available only for out-to-file functions). This flag is valid only when saveTexCoords is true
imageFormat- texture image format if applicable ("png", "jpg", "bmp")
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::savePlyCompositeToFile ( 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.

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 a PLY file (available only for out-to-file functions). This flag is valid only when saveTexCoords is true
imageFormat- texture image format if applicable ("png", "jpg", "bmp")
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::savePlyFrameToBlob ( 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.

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 a PLY file (available only for out-to-file functions). This flag is valid only when saveTexCoords is true
imageFormat- texture image format if applicable ("png", "jpg", "bmp")
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::savePlyFrameToFile ( 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.

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 a PLY file (available only for out-to-file functions). This flag is valid only when saveTexCoords is true
imageFormat- texture image format if applicable ("png", "jpg", "bmp")
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::savePlyTexture ( const wchar_t *  filename,
const IFrameMesh mesh,
const wchar_t *  imageFormat = L"png" 
)

Save texture for a given surface.

Note
This function is called by the 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 save
imageFormat- texture image format if applicable ("png", "jpg", "bmp")
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::savePlyTextures ( const wchar_t *  filename,
const ICompositeMesh mesh,
const wchar_t *  imageFormat = L"png" 
)

Save textures for a given surface.

Note
This function is called by the 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 save
imageFormat- texture image format if applicable ("png", "jpg", "bmp")
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::savePngImageToBlob ( IBlob **  data,
const IImage image 
)

Save image to PNG file/blob

Parameters
path- file path where to save image
data- blob pointer where to save image
image- image to save (not empty, 1,3,4 channels)
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::savePngImageToFile ( const wchar_t *  path,
const IImage image 
)

Save image to PNG file/blob

Parameters
path- file path where to save image
data- blob pointer where to save image
image- image to save (not empty, 1,3,4 channels)
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveStlMeshToBlob ( IBlob **  data,
const IMesh surf,
bool  binary = true,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Save IMesh surface to STL blob.

Parameters
data- blob where to save mesh
surf- surface to save (not empty)
binary- text or binary STL format
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveStlMeshToBlobAscii ( IBlob **  data,
const IMesh surf,
const char *  name = NULL,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Save IMesh surface to ASCII STL blob.

Parameters
data- blob where to save mesh
surf- surface to save (not empty)
name- mesh name
progr- progress interface
cncl- cancel interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveStlMeshToBlobBinary ( IBlob **  data,
const IMesh surf,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Save IMesh surface to binary STL blob.

Parameters
data- blob where to save mesh
surf- surface to save (not empty)
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveStlMeshToFile ( const wchar_t *  path,
const IMesh surf,
bool  binary = true,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Save IMesh surface to STL file.

Parameters
path- file path where to save mesh
surf- surface to save (not empty)
binary- text or binary STL format
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveStlMeshToFileAscii ( const wchar_t *  path,
const IMesh surf,
const char *  name = NULL,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Save IMesh surface to ASCII STL file.

Parameters
path- file path where to save mesh
surf- surface to save (not empty)
name- mesh name
progr- progress interface
cncl- cancellation interface
ErrorCode ABASESDK_LINK_SPEC artec::sdk::base::io::saveStlMeshToFileBinary ( const wchar_t *  path,
const IMesh surf,
IProgressInfo progr = 0,
ICancellationToken cncl = 0 
)

Save IMesh surface to binary STL file.

Parameters
path- file path where to save mesh
surf- surface to save (not empty)
progr- progress interface
cncl- cancellation interface