UThrobber

A Throbber widget that shows several zooming circles in a row.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UMG

Header

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

Include

#include "Components/Throbber.h"

Syntax

class UThrobber : public UWidget

Remarks

A Throbber widget that shows several zooming circles in a row.

Variables

Name Description

Public variable

bool

 

bAnimateHorizontally

Should the pieces animate horizontally?

Public variable

bool

 

bAnimateOpacity

Should the pieces animate their opacity?

Public variable

bool

 

bAnimateVertically

Should the pieces animate vertically?

Public variable

FSlateBrush

 

Image

Public variable

int32

 

NumberOfPieces

How many pieces there are

Constructors

Name Description

Public function

UThrobber

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

SetAnimateHorizontally

(
    bool bInAnimateHorizontally
)

Sets whether the pieces animate horizontally.

Public function

void

 

SetAnimateOpacity

(
    bool bInAnimateOpacity
)

Sets whether the pieces animate their opacity.

Public function

void

 

SetAnimateVertically

(
    bool bInAnimateVertically
)

Sets whether the pieces animate vertically.

Public function

void

 

SetNumberOfPieces

(
    int32 InNumberOfPieces
)

Sets how many pieces there are

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback