FProgressScope | Unreal Engine 5.2 Documentation

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

References


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

Syntax

class FProgressScope

Remarks

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)

Constructors

	Type	Name	Description
		FProgressScope ()	Create a dummy/inactive FProgressScope
		FProgressScope ( const FProgressScope& Other )
		FProgressScope ( FProgressScope&& Other )
		FProgressScope ( FProgressCancel* ProgressCancel, float ProgressAmount, const FText& Message )

Destructors

	Type	Name	Description
		~FProgressScope ()

Functions

Type	Name	Description
void	AdvanceProgressBy ( float Amount )
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.
void	Done ()	Advance to the end of the scope's progress range and close the scope
float	GetDistanceTo ( float TargetProgressFrac )
float	GetProgress ()
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.