1. Epic GamesDeveloper
  3. FProgressCancel

FProgressCancel

[FProgressCancel](API\Runtime\GeometryCore\FProgressCancel) is intended to be passed to long-running computes to do two things: 1) provide progress info back to caller 2) allow caller to cancel the computation

API > API/Runtime > API/Runtime/GeometryCore

FProgressCancel is intended to be passed to long-running computes to do two things: 1) provide progress info back to caller 2) allow caller to cancel the computation

   
Name FProgressCancel
Type class
Header File /Engine/Source/Runtime/GeometryCore/Public/Util/ProgressCancel.h
Include Path #include "Util/ProgressCancel.h"

Syntax

class FProgressCancel

Classes

Name Remarks
FProgressScope Simple helper to track progress in a local scope on an optional FProgressCancel Will still work if the ProgressCancel is null (just does nothing in that case)

Structs

Name Remarks
FMessageInfo  
FProgressData Progress tracking data.

Enums

Public

Name Remarks
EMessageLevel  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CancelF TFunction< bool()>   Util/ProgressCancel.h  
Warnings TArray< FMessageInfo >   Util/ProgressCancel.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
MaxMessageDepth int   Util/ProgressCancel.h  
MessageCS FCriticalSection Critical section for accesses to the Progress Message Util/ProgressCancel.h  
Progress FProgressData   Util/ProgressCancel.h  
ProgressFraction std::atomic< float > Current total progress, in range [0, 1]. Util/ProgressCancel.h  
ProgressMessage FText   Util/ProgressCancel.h  
WasCancelled bool   Util/ProgressCancel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddWarning ( const FText& MessageText,
EMessageLevel MessageLevel
)

   Util/ProgressCancel.h  

void AdvanceCurrentScopeProgressBy ( float Amount
)

   Util/ProgressCancel.h  

void AdvanceCurrentScopeProgressToward ( float TargetProgressFrac,
float FractionToward
)

 Advance current progress a fraction of the way toward a target value For example: if progress is .5, AdvanceProgressToward(1, .5) will take a half step to 1 and set progress to .75 As with all public progress function, progress is expressed relative to the current active progress range and cannot go backward. Util/ProgressCancel.h  

bool Cancelled()

   Util/ProgressCancel.h  

void ClearMaxMessageDepth()

   Util/ProgressCancel.h  

float GetCurrentScopeDistanceTo ( float TargetProgressFrac
)

   Util/ProgressCancel.h  

float GetCurrentScopeProgress()

   Util/ProgressCancel.h  

float GetProgress()

   Util/ProgressCancel.h  

FText GetProgressMessage()

   Util/ProgressCancel.h  

void SetCurrentScopeProgressTo ( float NewProgressFrac
)

 Note: This function will leave the current progress unchanged if the target value is less than the current progress it will not allow the progress value to go backward. Util/ProgressCancel.h  

void SetMaxMessageDepth ( int32 ScopeDepth
)

   Util/ProgressCancel.h  

void SetProgressMessage ( const FText& Message
)

   Util/ProgressCancel.h  

Static

Name Remarks Include Path Unreal Specifiers

static FProgressScope CreateScopeTo ( FProgressCancel* ProgressCancel,
float ProgressTo,
const FText& Message
)

   Util/ProgressCancel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page