GenericProgressCallback.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
// Local
#include "CVConst.h"
#include "CVCoreLib.h"
 
class AtomicCounter;
 
namespace cloudViewer {
 
class CV_CORE_LIB_API GenericProgressCallback {
public:
    virtual ~GenericProgressCallback() = default;
 
 
    virtual void update(float percent) = 0;
 
 
    virtual void setMethodTitle(const char* methodTitle) = 0;
 
 
    virtual void setInfo(const char* infoStr) = 0;
 
 
    virtual void start() = 0;
 
 
    virtual void stop() = 0;
 
 
    virtual bool isCancelRequested() = 0;
 
    virtual bool textCanBeEdited() const { return true; }
};
 
 
class CV_CORE_LIB_API NormalizedProgress {
public:
 
    NormalizedProgress(GenericProgressCallback* callback,
                       unsigned totalSteps,
                       unsigned totalPercentage = 100);
 
    virtual ~NormalizedProgress();
 
    void scale(unsigned totalSteps,
               unsigned totalPercentage = 100,
               bool updateCurrentProgress = false);
 
    void reset();
 
    bool oneStep();
 
    bool steps(unsigned n);
 
protected:
    float m_percent;
 
    unsigned m_step;
 
    float m_percentAdd;
 
 
    AtomicCounter* m_counter;
 
    GenericProgressCallback* progressCallback;
};
 
}  // namespace cloudViewer