TuttleOFX/libraries/tuttle/src/tuttle/plugin/OfxProgress.hpp

Go to the documentation of this file.

/**
 * @brief This file provides a set of member function that
 *        are needed to manage algorithm progression.
 */
#ifndef _TUTTLE_PLUGIN_OFXPROGRESS_HPP_
#define _TUTTLE_PLUGIN_OFXPROGRESS_HPP_

#include "IProgress.hpp"
#include "exceptions.hpp"

#include <tuttle/plugin/global.hpp>
#include <tuttle/plugin/IProgress.hpp>

#include <ofxsImageEffect.h>
#include <ofxsMultiThread.h>

#include <string>

namespace tuttle {
namespace plugin {

class OfxProgress : public IProgress
{
private:
        OFX::ImageEffect& _effect; ///< Used to access Ofx progress bar
        OFX::MultiThread::Mutex _mutex;
        OfxProgress& operator=( const OfxProgress& p );

protected:
        double _stepSize; ///< Step size of progess bar
        double _counter; ///< Current position in [0; 1]

public:
        OfxProgress( OFX::ImageEffect& effect )
        : _effect( effect )
        , _mutex( 0 )
        , _stepSize( 0 )
        , _counter( 0 )
        {}

        virtual ~OfxProgress() {}

        void progressBegin( const int numSteps, const std::string& msg = "" );
        void progressEnd();
        bool progressForward( const int nSteps );
        
        bool progressUpdate( const double p );
        
        OfxProgress& getOfxProgress() { return *this; }
};

}
}

#endif