BuildPatchProgress.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    BuildPatchProgress.h: Declares classes involved with tracking the patch
    progress information.
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/ThreadSafeBool.h"
#include "Installer/Controllable.h"
#include "BuildPatchState.h"
 
namespace BuildPatchServices
{
    struct FBuildPatchProgress
        : public IControllable
    {
    public:
 
        FBuildPatchProgress();
 
        // IControllable interface begin.
        virtual void SetPaused(bool bIsPaused) override;
        virtual void Abort() override;
        // IControllable interface end.
 
        virtual void SetStateProgress(const EBuildPatchState& State, const float& Value);
 
        virtual void SetStateWeight(const EBuildPatchState& State, const float& Value);
 
        virtual EBuildPatchState GetState() const;
 
        virtual float GetProgress() const;
 
        virtual float GetProgressNoMarquee() const;
 
        virtual float GetStateProgress(const EBuildPatchState& State) const;
 
        virtual float GetStateWeight(const EBuildPatchState& State) const;
 
        virtual bool TogglePauseState();
 
        virtual double WaitWhilePaused() const;
 
        virtual bool GetPauseState() const;
 
        virtual void SetIsDownloading(bool bIsDownloading);
 
        virtual void CancelAbort();
 
    private:
 
        void UpdateProgressInfo();
 
        void UpdateCachedValues();
 
    private:
 
        // Defines whether each state displays progress percent or is designed for a "please wait" or marquee style progress bar
        // This is predefined and constant.
        static const bool bHasProgressValue[static_cast<int32>(EBuildPatchState::NUM_PROGRESS_STATES)];
 
        // Defines whether each state should count towards the overall progress
        // This is predefined and constant.
        static const bool bCountsTowardsProgress[static_cast<int32>(EBuildPatchState::NUM_PROGRESS_STATES)];
 
        // Holds the current percentage complete for each state, this will decide the "current" state, being the first that is not complete.
        // Range 0 to 1.
        float StateProgressValues[static_cast<int32>(EBuildPatchState::NUM_PROGRESS_STATES)];
 
        // Holds the weight that each stage has on overall progress. 
        // Range 0 to 1.
        float StateProgressWeights[static_cast<int32>(EBuildPatchState::NUM_PROGRESS_STATES)];
 
        // Cached total weight value for progress calculation
        float TotalWeight;
 
        // Externally set variable to say if the system is currently making download requests
        bool bIsDownloading;
 
        // The current state value for UI polling
        EBuildPatchState CurrentState;
 
        // The current progress value for UI polling
        float CurrentProgress;
 
        // Thread safe bool for whether the process should abort
        FThreadSafeBool bShouldAbort;
 
        // Critical section to protect variable access
        mutable FCriticalSection ThreadLock;
 
    };
}