FAbortableBackgroundTask

[FAbortableBackgroundTask](API\Plugins\ModelingOperators\FAbortableBackgroundTask) is a [FNonAbandonableTask](API\Runtime\Core\Async\FNonAbandonableTask) intended for long-running background computations that might need to be interrupted, such as expensive operations driven by a UI tool that the user may wish to cancel.

Windows
MacOS
Linux

Inheritance Hierarchy

FNonAbandonableTask

FAbortableBackgroundTask

TModelingOpTask

References

Module

ModelingOperators

Header

/Engine/Plugins/Experimental/MeshModelingToolset/Source/ModelingOperators/Public/ModelingTaskTypes.h

Include

#include "ModelingTaskTypes.h"

Syntax

class FAbortableBackgroundTask : public FNonAbandonableTask

Remarks

FAbortableBackgroundTask is a FNonAbandonableTask intended for long-running background computations that might need to be interrupted, such as expensive operations driven by a UI tool that the user may wish to cancel.

This class is intended to be used with FAsyncTaskExecuterWithAbort. In that case the SetAbortSource() function will be automatically called/configured.

A FProgressCancel object can be returned which will allow expensive computations to check the value of this internal flag.

Constructors

Name Description

Public function

FAbortableBackgroundTask()

Functions

Name Description

Public function

FProgressCan...

 

GetProgress()

Public function

bool

 

IsAborted()

Public function

void

 

SetAbortSource

(
    bool* bAbortFlagLocation
)

Set the abort source flag.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss