SlowTask.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreGlobals.h"
#include "CoreTypes.h"
#include "Internationalization/Text.h"
#include "Misc/Optional.h"
 
class FFeedbackContext;
 
enum class ESlowTaskVisibility
{
    Default,
    ForceVisible,
    Important,
    Invisible,
};
 
struct FSlowTask
{
    FText DefaultMessage;
 
    FText FrameMessage;
 
    float TotalAmountOfWork;
 
    float CompletedWork;
 
    float CurrentFrameScope;
 
    ESlowTaskVisibility Visibility;
 
    double StartTime;
 
    TOptional<float> OpenDialogThreshold;
 
private:
 
    bool bEnabled;
 
    bool bCreatedDialog;
    
    FFeedbackContext& Context;
 
    bool bDelayedDialogShowCancelButton : 1;
 
    bool bDelayedDialogAllowInPIE : 1;
 
    bool bSkipRecursiveDialogCreation : 1;
 
    uint64 RegionId;
 
    FSlowTask(const FSlowTask&);
 
    static void ForceRefresh(FFeedbackContext& Context);
 
    bool MakeDialogIfNeeded();
 
    void MakeRecursiveDialogIfNeeded();
 
public:
 
    static CORE_API bool ShouldCreateThrottledSlowTask();
 
    CORE_API FSlowTask(float InAmountOfWork, const FText& InDefaultMessage = FText(), bool bInEnabled = true, FFeedbackContext& InContext = *GWarn);
 
    CORE_API void Initialize();
 
    CORE_API void Destroy();
 
    CORE_API void MakeDialogDelayed(float Threshold, bool bShowCancelButton = false, bool bAllowInPIE = false);
 
    CORE_API void MakeDialog(bool bShowCancelButton = false, bool bAllowInPIE = false);
 
    CORE_API void EnterProgressFrame(float ExpectedWorkThisFrame = 1.f, const FText& Text = FText());
 
    CORE_API void TickProgress();
 
    CORE_API void ForceRefresh();
 
    CORE_API const FText& GetCurrentMessage() const;
 
    CORE_API bool ShouldCancel() const;
};