1. Epic GamesDeveloper
  3. FProgressCancel

FProgressCancel

[FProgressCancel](API\Runtime\GeometryCore\Util\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 > API/Runtime/GeometryCore/Util

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/Util/ProgressCancel.h
Include #include "Util/ProgressCancel.h"

Syntax

class FProgressCancel

Remarks

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

Variables

  Type Name Description
Public variable TFunction< bool()> CancelF  
Public variable TArray< FMessageInfo > Warnings  

Functions

  Type Name Description
Public function void

AddWarning ( const FText& MessageText,
EMessageLevel MessageLevel
)

  
Public function void  
Public function 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.
Public function bool  
Public function void  
Public function Static FProgressScope

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

  
Public function float

GetCurrentScopeDistanceTo ( float TargetProgressFrac
)

  
Public function float  
Public function Const float  
Public function Const FText  
Public function 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.
Public function void

SetMaxMessageDepth ( int32 ScopeDepth
)

  
Public function void

SetProgressMessage ( const FText& Message
)

  

Classes

  Type Name Description
Public struct FMessageInfo    
Public class 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)  

Enums

  Type Name Description
Public enum EMessageLevel    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page