UE::Geometry::FGeometryResult Struct Reference

#include <ProgressCancel.h>

Public Member Functions
	FGeometryResult ()
	FGeometryResult (EGeometryResultType ResultType)
void	UpdateResultType (EGeometryResultType NewType)
void	SetFailed ()
void	SetCancelled ()
void	SetSuccess ()
void	SetSuccess (bool bSuccess, FProgressCancel *Progress=nullptr)
void	SetFailed (FText ErrorMessage, int ResultCode=0)
bool	CheckAndSetCancelled (FProgressCancel *Progress)
void	AddError (FGeometryError Error)
void	AddWarning (FGeometryWarning Warning)
bool	HasFailed () const
bool	HasResult () const

Static Public Member Functions
static FGeometryResult	Failed ()
static FGeometryResult	Cancelled ()

Public Attributes
EGeometryResultType	Result
TArray< FGeometryError >	Errors
TArray< FGeometryWarning >	Warnings

Detailed Description

FGeometryResult represents a combined "success/failure/etc" state for a geometry operation along with a set of Error and Warning codes/messages.

Constructor & Destructor Documentation

FGeometryResult() [1/2]

UE::Geometry::FGeometryResult::FGeometryResult ( )

inline

FGeometryResult() [2/2]

UE::Geometry::FGeometryResult::FGeometryResult ( EGeometryResultType  ResultType )

inline

Member Function Documentation

AddError()

void UE::Geometry::FGeometryResult::AddError ( FGeometryError  Error )

inline

Append an Error to the result

AddWarning()

void UE::Geometry::FGeometryResult::AddWarning ( FGeometryWarning  Warning )

inline

Append a Warning to the result

Cancelled()

static FGeometryResult UE::Geometry::FGeometryResult::Cancelled ( )

inlinestatic

CheckAndSetCancelled()

bool UE::Geometry::FGeometryResult::CheckAndSetCancelled ( FProgressCancel *  Progress )

inline

Test if the given Progress has been cancelled, if so, set the Result to Cancelled

Returns

true if cancelled, false if not cancelled

Failed()

static FGeometryResult UE::Geometry::FGeometryResult::Failed ( )

inlinestatic

HasFailed()

bool UE::Geometry::FGeometryResult::HasFailed ( ) const

inline

Returns

true if the geometry operation failed

HasResult()

bool UE::Geometry::FGeometryResult::HasResult ( ) const

inline

Returns

true if the geometry operation has some result (ie was a Success or returned a PartialResult)

SetCancelled()

void UE::Geometry::FGeometryResult::SetCancelled ( )

inline

SetFailed() [1/2]

void UE::Geometry::FGeometryResult::SetFailed ( )

inline

SetFailed() [2/2]

void UE::Geometry::FGeometryResult::SetFailed ( FText  ErrorMessage, int  ResultCode = 0  )

inline

Set state of the Result to Failure, and append a FGeometryError with the given ErrorMessage and ResultCode

SetSuccess() [1/2]

void UE::Geometry::FGeometryResult::SetSuccess ( )

inline

SetSuccess() [2/2]

void UE::Geometry::FGeometryResult::SetSuccess ( bool  bSuccess, FProgressCancel *  Progress = nullptr  )

inline

Set to Success/Failure based on bSuccess, or Cancelled if the (optional) FProgressCancel indicates that it was Cancelled

UpdateResultType()

void UE::Geometry::FGeometryResult::UpdateResultType ( EGeometryResultType  NewType )

inline

Member Data Documentation

Errors

TArray<FGeometryError> UE::Geometry::FGeometryResult::Errors

Result

EGeometryResultType UE::Geometry::FGeometryResult::Result

Warnings

TArray<FGeometryWarning> UE::Geometry::FGeometryResult::Warnings

---

The documentation for this struct was generated from the following file:

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