PrusaSlicer-NonPlainar/src/slic3r/GUI/ProgressIndicator.hpp

71 lines
1.8 KiB
C++
Raw Normal View History

2018-09-14 07:28:00 +00:00
#ifndef IPROGRESSINDICATOR_HPP
#define IPROGRESSINDICATOR_HPP
#include <string>
#include <functional>
namespace Slic3r {
/**
* @brief Generic progress indication interface.
*/
class ProgressIndicator {
public:
using CancelFn = std::function<void(void)>; // Cancel function signature.
private:
float state_ = .0f, max_ = 1.f, step_;
CancelFn cancelfunc_ = [](){};
public:
inline virtual ~ProgressIndicator() {}
/// Get the maximum of the progress range.
float max() const { return max_; }
/// Get the current progress state
float state() const { return state_; }
/// Set the maximum of the progress range
virtual void max(float maxval) { max_ = maxval; }
/// Set the current state of the progress.
virtual void state(float val) { state_ = val; }
/**
* @brief Number of states int the progress. Can be used instead of giving a
* maximum value.
*/
virtual void states(unsigned statenum) {
step_ = max_ / statenum;
}
/// Message shown on the next status update.
2018-09-17 13:12:13 +00:00
virtual void message(const std::string&) = 0;
2018-09-14 07:28:00 +00:00
/// Title of the operation.
2018-09-17 13:12:13 +00:00
virtual void title(const std::string&) = 0;
2018-09-14 07:28:00 +00:00
/// Formatted message for the next status update. Works just like sprintf.
2018-09-17 13:12:13 +00:00
virtual void message_fmt(const std::string& fmt, ...);
2018-09-14 07:28:00 +00:00
/// Set up a cancel callback for the operation if feasible.
virtual void on_cancel(CancelFn func = CancelFn()) { cancelfunc_ = func; }
/**
* Explicitly shut down the progress indicator and call the associated
* callback.
*/
virtual void cancel() { cancelfunc_(); }
/// Convenience function to call message and status update in one function.
2018-09-17 13:12:13 +00:00
void update(float st, const std::string& msg) {
2018-09-14 07:28:00 +00:00
message(msg); state(st);
}
};
}
#endif // IPROGRESSINDICATOR_HPP