#include <kis_progress_update_helper.h>

Public Member Functions
	KisProgressUpdateHelper (KoUpdaterPtr progressUpdater, int portion, int numSteps)

void	step ()

	~KisProgressUpdateHelper ()

Private Attributes
int	m_baseProgress

int	m_currentStep

int	m_lastReportedLocalProgress

int	m_numSteps

int	m_portion

KoUpdaterPtr	m_progressUpdater

Detailed Description

Definition at line 13 of file kis_progress_update_helper.h.

Constructor & Destructor Documentation

◆ KisProgressUpdateHelper()

KisProgressUpdateHelper::KisProgressUpdateHelper	(	KoUpdaterPtr	progressUpdater,
		int	portion,
		int	numSteps )

inline

Definition at line 15 of file kis_progress_update_helper.h.

        : m_progressUpdater(progressUpdater),
          m_baseProgress(0),
          m_portion(portion),
          m_currentStep(0),
          m_numSteps(numSteps),
          m_lastReportedLocalProgress(-1)
     {
         if (m_progressUpdater) {
             m_baseProgress = m_progressUpdater->progress();
         }
     }

References m_baseProgress, and m_progressUpdater.

◆ ~KisProgressUpdateHelper()

KisProgressUpdateHelper::~KisProgressUpdateHelper ( )

inline

Definition at line 28 of file kis_progress_update_helper.h.

                               {
        if (m_progressUpdater) {
            m_progressUpdater->setProgress(m_baseProgress + m_portion);
        }
    }

References m_baseProgress, m_portion, and m_progressUpdater.

Member Function Documentation

◆ step()

void KisProgressUpdateHelper::step ( )

inline

Definition at line 34 of file kis_progress_update_helper.h.

                {
        int localProgress = m_numSteps ?
            m_portion * (++m_currentStep) / m_numSteps : m_portion;
 
        if (m_progressUpdater && m_lastReportedLocalProgress != localProgress) {
            m_lastReportedLocalProgress = localProgress;
            m_progressUpdater->setProgress(m_baseProgress + localProgress);
        }
        // TODO: handle interrupted processing (connect to other layers, i.e. undo)
    }