IScanningProcedureObserver.h

Go to the documentation of this file.

/********************************************************************
*
*   Project     Artec 3D Scanning SDK
*
*   Purpose:    Scanning procedure observer interface. 
*
*   Copyright:  Artec Group
*
********************************************************************/

#ifndef _ISCANNINGPROCEDUREOBSERVER_H_ 
#define _ISCANNINGPROCEDUREOBSERVER_H_

#include <artec/sdk/base/Errors.h>
#include <artec/sdk/base/RefBase.h>
#include <artec/sdk/base/IScan.h>
#include <artec/sdk/base/IFrameMesh.h>
#include <artec/sdk/scanning/ScanningSdkDefines.h>


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

/// Scanned frame state
enum FrameState
{
    FrameState_Ok,
    FrameState_TriggerCaptureFailed,
    FrameState_CaptureFailed,
    FrameState_ReconstructionFailed,
    FrameState_RegistrationFailed,
    FrameState_TextureMappingFailed,
    FrameState_AddToScanFailed,
    FrameState_ForceDword = 0x7fffffff /* force 32-bit size enum */     
};

struct RegistrationInfo
{
    const artec::sdk::base::IFrameMesh* frame;              ///< new frame to add
    artec::sdk::base::Matrix4x4D        transformation;     ///< frame's transformation matrix
    const artec::sdk::base::IImage*     rawTexture;         ///< raw frame texture camera image
    double                              registrationError;  ///< registration error (negative means registration failed)
    bool                                geometryKeyFrame;   ///< frame is geometry skeleton  
    bool                                textureKeyFrame;    ///< frame is texture keyframe    
    FrameState                          frameState;         ///< state of the frame (processing stage, where error occurred: capture/reconstruction/registration)
    ErrorCode                           errorCode;          ///< type of error, which occurred during processing. ErrorCode_OK if frameState == FrameState_Okay
    int                                 scannerIndex;       ///< scanner index in bundle.  0 - when no bundle used
};

class IScanningProcedureObserver : public artec::sdk::base::IRef
{
public:
    /// Called after new scanned frame was captured
    /// Synchronized, but will be called from many different threads
    /// This function called in such order, as frame was captured, no additional sorting needed
    /// Do not make large calculation here - just save data for handling in other thread
    virtual void onFrameCaptured(const RegistrationInfo* frameInfo) = 0;    

    /// Called after new scanned frame was added to scan
    /// Synchronized, but will be called from many different threads
    /// This function called in such order, as frame was captured and registered, no additional sorting needed
    /// Do not make large calculation here - just save data for handling in other thread
    virtual void onFrameScanned(const RegistrationInfo* frameInfo) = 0;

    /// called after scanning in finished, but before texture conversion
    virtual void onScanningFinished(int scannerIndex) = 0;
};

/// You can inherit this class instead of IScanningProcedureObserver interface
/// Reference counting already implemented
class ScanningProcedureObserverBase : public artec::sdk::base::RefBase<IScanningProcedureObserver>
{
};

} } } // namespace artec::sdk::scanning

#endif // _ISCANNINGPROCEDUREOBSERVER_H_