Navigation
API > API/Plugins > API/Plugins/ModelingOperators
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.
| Name | FAbortableBackgroundTask |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingOperators/Public/ModelingTaskTypes.h |
| Include Path | #include "ModelingTaskTypes.h" |
Syntax
class FAbortableBackgroundTask : public FNonAbandonableTask
Inheritance Hierarchy
- FNonAbandonableTask → FAbortableBackgroundTask
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAbortableBackgroundTask() |
ModelingTaskTypes.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExternalAbortFlag | bool * | Pointer to a bool owned somewhere else. | ModelingTaskTypes.h | |
| Progress | FProgressCancel | Internal ProgressCancel instance that can be passed to expensive compute functions, etc | ModelingTaskTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FProgressCancel * GetProgress() |
ModelingTaskTypes.h | ||
bool IsAborted() |
ModelingTaskTypes.h | ||
void SetAbortSource
(
bool* bAbortFlagLocation |
Set the abort source flag. | ModelingTaskTypes.h |