FProgressCancel::FProgressScope Class Reference

#include <ProgressCancel.h>

Public Member Functions
GEOMETRYCORE_API	FProgressScope (FProgressCancel *ProgressCancel, float ProgressAmount, const FText &Message=FText())
	FProgressScope ()
	FProgressScope (const FProgressScope &Other)=delete
FProgressScope &	operator= (const FProgressScope &Other)=delete
	FProgressScope (FProgressScope &&Other) noexcept
FProgressScope &	operator= (FProgressScope &&Other) noexcept
	~FProgressScope ()
GEOMETRYCORE_API void	Done ()
void	AdvanceProgressBy (float Amount)
void	AdvanceProgressToward (float TargetProgressFrac, float FractionToward)
float	GetDistanceTo (float TargetProgressFrac)
float	GetProgress ()
void	SetProgressTo (float NewProgressFrac)

Constructor & Destructor Documentation

FProgressScope() [1/4]

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

Parameters

ProgressCancel	Progress will be tracked on this. If null, the FProgressScope will do nothing.
ProgressAmount	Amount to increase progress w/in this scope (as a fraction of the current outer-scope active progress range)

FProgressScope() [2/4]

FProgressCancel::FProgressScope::FProgressScope ( )

inline

Create a dummy/inactive FProgressScope

FProgressScope() [3/4]

FProgressCancel::FProgressScope::FProgressScope ( const FProgressScope &  Other )

delete

FProgressScope() [4/4]

FProgressCancel::FProgressScope::FProgressScope ( FProgressScope &&  Other )

inlinenoexcept

~FProgressScope()

FProgressCancel::FProgressScope::~FProgressScope ( )

inline

Member Function Documentation

AdvanceProgressBy()

void FProgressCancel::FProgressScope::AdvanceProgressBy ( float  Amount )

inline

Parameters

Amount

Amount to increase the progress fraction, as a fraction of the current active progress range

AdvanceProgressToward()

void FProgressCancel::FProgressScope::AdvanceProgressToward ( float  TargetProgressFrac, float  FractionToward  )

inline

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.

Done()

void FProgressCancel::FProgressScope::Done

(

)

Advance to the end of the scope's progress range and close the scope

GetDistanceTo()

float FProgressCancel::FProgressScope::GetDistanceTo ( float  TargetProgressFrac )

inline

Returns

Amount to progress in the current scope to reach the target (scope-relative) progress value

GetProgress()

float FProgressCancel::FProgressScope::GetProgress ( )

inline

Returns

Progress in the current scope

operator=() [1/2]

FProgressScope & FProgressCancel::FProgressScope::operator= ( const FProgressScope &  Other )

delete

operator=() [2/2]

FProgressScope & FProgressCancel::FProgressScope::operator= ( FProgressScope &&  Other )

inlinenoexcept

SetProgressTo()

void FProgressCancel::FProgressScope::SetProgressTo ( float  NewProgressFrac )

inline

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.

Parameters

ProgressFrac

Value to set current progress to, as a fraction of the current active progress range

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/GeometryCore/Public/Util/ProgressCancel.h
• Engine/Source/Runtime/GeometryCore/Private/Util/ProgressCancel.cpp