IFrameProcessor.h

Go to the documentation of this file.

/********************************************************************
*
*   Project     Artec 3D Scanning SDK
*
*   Purpose:    Process raw data from scanner
*
*   Copyright:  Artec Group
*
********************************************************************/
#ifndef _IFRAMEPROCESSOR_H_
#define _IFRAMEPROCESSOR_H_

#include <artec/sdk/base/Errors.h>
#include <artec/sdk/base/IRef.h>
#include <artec/sdk/base/Rect.h>
#include <artec/sdk/base/IFrameMesh.h>
#include <artec/sdk/capturing/CaptureSdkDefines.h>
#include <artec/sdk/capturing/ScannerInfo.h>

namespace artec { namespace sdk { namespace capturing
{
using namespace artec::sdk::base::errors;

class IFrame;

class IFrameProcessor : public artec::sdk::base::IRef
{
public:
    /**
     * Method reconstructs a surface from a frame data but don't texturize
     * the output even if texture is captured. Texture mapping should be made
     * explicitly through IFrameMesh::mapTexture() method
     */
    virtual ErrorCode reconstructMesh(artec::sdk::base::IFrameMesh** mesh, const IFrame* frame) = 0;

    /**
     * Method reconstructs a surface from a frame data and texturize
     * the output if texture is captured. This is slow method.
     */
    virtual ErrorCode reconstructAndTexturizeMesh(artec::sdk::base::IFrameMesh** mesh, const IFrame* frame) = 0;

    /**
     * Set "improve by neighbor" sensitivity parameter
     * used im mesh reconstruction
     * can be changed while capture in progress
     * @param sensitivity - value between 0.0f and 1.0f
     */
    virtual ErrorCode setSensitivity(float sensitivity) = 0;

    /**
     * Get "improve by neighbor" sensitivity parameter
     * used im mesh reconstruction
     * @return sensitivity - value between 0.0f and 1.0f
     */
    virtual float getSensitivity() const = 0;

    /**
     * Update scanning range
     * can be changed while capture in progress
     */
    virtual ErrorCode setScanningRange(float  rangeNear, float rangeFar) = 0;

    /**
     * Update scanning range
     * @param rangeNear - near range limit
     * @param rangeFar  - far range limit
     */
    virtual ErrorCode getScanningRange(float* rangeNear, float* rangeFar) const = 0;

    /**
     * Update scanning region of interest
     * can be changed while capture in progress
     * call with rect == NULL for disable ROI
     */
    virtual ErrorCode setROI(artec::sdk::base::RectF* rect) = 0;

    /**
     * Get scanning region of interest
     * @param rect - rect to return
     */
    virtual ErrorCode getROI(artec::sdk::base::RectF* rect) const = 0;
};

} } } // namespace artec::sdk::capturing

#endif // _IFRAMEPROCESSOR_H_