Progress.h

#pragma once
 
#include <Foundation/Basics.h>
#include <Foundation/Communication/Event.h>
#include <Foundation/Strings/String.h>
 
class plProgress;
class plProgressRange;
 
struct PL_FOUNDATION_DLL plProgressEvent
{
  enum class Type
  {
    ProgressStarted, 
    ProgressEnded,   
    ProgressChanged, 
    CancelClicked,   
  };
 
  Type m_Type;
  plProgress* m_pProgressbar;
};
 
class PL_FOUNDATION_DLL plProgress
{
public:
  plProgress();
  ~plProgress();
 
  float GetCompletion() const;
 
  void SetCompletion(float fCompletion);
 
  plStringView GetMainDisplayText() const;
 
  plStringView GetStepDisplayText() const;
 
  void UserClickedCancel();
 
  bool WasCanceled() const;
 
  bool AllowUserCancel() const;
 
  static plProgress* GetGlobalProgressbar();
 
  static void SetGlobalProgressbar(plProgress* pProgress);
 
  plEvent<const plProgressEvent&> m_Events;
 
  void* m_pUserData = nullptr;
 
private:
  friend class plProgressRange;
  void SetActiveRange(plProgressRange* pRange);
 
  plProgressRange* m_pActiveRange = nullptr;
 
  plString m_sCurrentDisplayText;
  bool m_bCancelClicked = false;
  bool m_bEnableCancel = true;
 
  float m_fLastReportedCompletion = 0.0f;
  float m_fCurrentCompletion = 0.0f;
};
 
class PL_FOUNDATION_DLL plProgressRange
{
  PL_DISALLOW_COPY_AND_ASSIGN(plProgressRange);
 
public:
  plProgressRange(plStringView sDisplayText, plUInt32 uiSteps, bool bAllowCancel, plProgress* pProgressbar = nullptr);
 
  plProgressRange(plStringView sDisplayText, bool bAllowCancel, plProgress* pProgressbar = nullptr);
 
  ~plProgressRange();
 
  plProgress* GetProgressbar() const;
 
  void SetStepWeighting(plUInt32 uiStep, float fWeight);
 
  bool BeginNextStep(plStringView sStepDisplayText, plUInt32 uiNumSteps = 1);
 
  bool SetCompletion(double fCompletionFactor);
 
  bool WasCanceled() const;
 
private:
  friend class plProgress;
 
  void Init(plStringView sDisplayText, bool bAllowCancel, plProgress* pProgressbar);
  float GetStepWeight(plUInt32 uiStep) const;
  void ComputeCurStepBaseAndRange(double& out_base, double& out_range);
 
  plProgressRange* m_pParentRange = nullptr;
  plProgress* m_pProgressbar = nullptr;
 
  plInt32 m_iCurrentStep = 0;
  plString m_sDisplayText;
  plString m_sStepDisplayText;
  plHashTable<plUInt32, float> m_StepWeights;
 
  bool m_bAllowCancel = false;
  double m_fPercentageBase = 0.0;
  double m_fPercentageRange = 0.0;
  double m_fWeightedCompletion = 0.0;
  double m_fSummedWeight = 0.0;
};