1. Epic GamesDeveloper
  3. FProgressScope

FProgressScope

Simple helper to track progress in a local scope on an optional [FProgressCancel](API\Runtime\GeometryCore\FProgressCancel) Will still work if the ProgressCancel is null (just does nothing in that case)

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/FProgressCancel

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)

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

Syntax

class FProgressScope

Constructors

Name Remarks Include Path Unreal Specifiers
Create a dummy/inactive FProgressScope Util/ProgressCancel.h  

FProgressScope ( const FProgressScope& Other
)

   Util/ProgressCancel.h  
  Util/ProgressCancel.h  

FProgressScope ( FProgressCancel* ProgressCancel,
float ProgressAmount,
const FText& Message
)

   Util/ProgressCancel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FProgressScope()

   Util/ProgressCancel.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnded bool   Util/ProgressCancel.h  
ProgressCancel FProgressCancel *   Util/ProgressCancel.h  
SavedProgressData FProgressData   Util/ProgressCancel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AdvanceProgressBy ( float Amount
)

   Util/ProgressCancel.h  

void AdvanceProgressToward ( 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  

void Done()

 Advance to the end of the scope's progress range and close the scope Util/ProgressCancel.h  

float GetDistanceTo ( float TargetProgressFrac
)

   Util/ProgressCancel.h  

float GetProgress()

   Util/ProgressCancel.h  

void SetProgressTo ( 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  

Operators

Name Remarks Include Path Unreal Specifiers
  Util/ProgressCancel.h  
  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