BuffIO.h

Go to the documentation of this file.

/********************************************************************
*
*   Project     Artec 3D Scanning SDK
*
*   Purpose:    Internal BUFF file format support. 
*
*  Copyright:   Artec Group
*
********************************************************************/

#ifndef _BUFFIO_H_
#define _BUFFIO_H_

#include <artec/sdk/base/BaseSdkDefines.h>
#include <artec/sdk/base/IFrameMesh.h>

namespace artec { namespace sdk { namespace base
{

class ICancellationToken;
class IProgressInfo;

namespace io {

extern "C" {

/** Save IFrameMesh to BUFF file
*   @param  path - file path to save mesh to
*   @param  mesh - mesh to be saved
*   @param  progr - progress interface
*   @param  cncl - cancel interface
*   @return error code
*/
ErrorCode ABASESDK_LINK_SPEC
    saveBuffFrameToFile(const wchar_t* path, const IFrameMesh* mesh, IProgressInfo* progr = 0, ICancellationToken* cncl = 0);
        
/** Save IFrameMesh to BUFF blob
*   @note   save only geometry, not texture also, because image is stored in separate blob
*   @param  data - blob to save mesh to
*   @param  mesh - mesh to be saved
*   @param  progr - progress interface
*   @param  cncl - cancel interface
*   @return error code
*/
ErrorCode ABASESDK_LINK_SPEC
    saveBuffFrameToBlob(IBlob** data, const IFrameMesh* mesh, IProgressInfo* progr = 0, ICancellationToken* cncl = 0);

/** Load IFrameMesh from BUFF file
*   @param  mesh - loaded mesh
*   @param  path - file path to load image from
*   @param  progr - progress interface
*   @param  cncl - cancel interface
*   @return error code
*/
ErrorCode ABASESDK_LINK_SPEC
    loadBuffFrameFromFile(IFrameMesh** mesh, const wchar_t* path, IProgressInfo* progr = 0, ICancellationToken* cncl = 0);

/** Load IFrameMesh from BUFF blob
*   @note   load only geometry, not texture also, because image is stored in separate blob
*   @param  mesh - loaded mesh
*   @param  data - blob to load image from
*   @param  progr - progress interface
*   @param  cncl - cancel interface
*   @return error code
*/
ErrorCode ABASESDK_LINK_SPEC
    loadBuffFrameFromBlob(IFrameMesh** mesh, const IBlob* data, IProgressInfo* progr = 0, ICancellationToken* cncl = 0);

}

class Buff
{
public:

    /** Save IFrameMesh to BUFF file
    *   @param  path - file path to save mesh to
    *   @param  mesh - mesh to be saved
    *   @param  progr - progress interface
    *   @param  cncl - cancel interface
    *   @return error code
    */
    static ErrorCode save(const wchar_t* path, const IFrameMesh* mesh, IProgressInfo* progr = 0, ICancellationToken* cncl = 0)
    {
        return  saveBuffFrameToFile(path, mesh, progr, cncl);
    }
        
    /** Save IFrameMesh to BUFF blob
    *   @note   save only geometry, not texture also, because image is stored in separate blob
    *   @param  data - blob to save mesh to
    *   @param  mesh - mesh to be saved
    *   @param  progr - progress interface
    *   @param  cncl - cancel interface
    *   @return error code
    */
    static ErrorCode save(IBlob** data, const IFrameMesh* mesh, IProgressInfo* progr = 0, ICancellationToken* cncl = 0)
    {
        return  saveBuffFrameToBlob(data, mesh, progr, cncl);
    }

    /** Load IFrameMesh from BUFF file
    *   @param  mesh - loaded mesh
    *   @param  path - file path to load image from
    *   @param  progr - progress interface
    *   @param  cncl - cancel interface
    *   @return error code
    */
    static ErrorCode load(IFrameMesh** mesh, const wchar_t* path, IProgressInfo* progr = 0, ICancellationToken* cncl = 0)
    {
        return  loadBuffFrameFromFile(mesh, path, progr, cncl);
    }

    /** Load IFrameMesh from BUFF blob
    *   @note   load only geometry, not texture also, because image is stored in separate blob
    *   @param  mesh - loaded mesh
    *   @param  data - blob to load image from
    *   @param  progr - progress interface
    *   @param  cncl - cancel interface
    *   @return error code
    */
    static ErrorCode load(IFrameMesh** mesh, const IBlob* data, IProgressInfo* progr = 0, ICancellationToken* cncl = 0)
    {
        return  loadBuffFrameFromBlob(mesh, data, progr, cncl);
    }
};

} } } } // namespace artec::sdk::base::io

#endif // _BUFFIO_H_