UCircularThrobber

A throbber widget that orients images in a spinning circle. No Children Spinner Progress

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Components/CircularThrobber.h

Include

#include "Components/CircularThrobber.h"

Syntax

class UCircularThrobber : public UWidget

Remarks

A throbber widget that orients images in a spinning circle.

No Children Spinner Progress

Variables

Name Description

Public variable

FSlateBrush

 

Image

Public variable

int32

 

NumberOfPieces

How many pieces there are

Public variable

float

 

Period

The amount of time for a full circle (in seconds)

Public variable

float

 

Radius

The radius of the circle.

Constructors

Name Description

Public function

UCircularThrobber

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

SetNumberOfPieces

(
    int32 InNumberOfPieces
)

Sets how many pieces there are.

Public function

void

 

SetPeriod

(
    float InPeriod
)

Sets the amount of time for a full circle (in seconds).

Public function

void

 

SetRadius

(
    float InRadius
)

Sets the radius of the circle.

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

Name Description

Public variable

USlateBrushAsse...

 

PieceImage_DEPRECATED

Image to use for each segment of the throbber

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