Navigation
API > API/Runtime > API/Runtime/UMG
A Throbber widget that shows several zooming circles in a row.
| Name | UThrobber |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Components/Throbber.h |
| Include Path | #include "Components/Throbber.h" |
Syntax
UCLASS (MinimalAPI)
class UThrobber : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UThrobber
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UThrobber
(
const FObjectInitializer& ObjectInitializer |
Components/Throbber.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAnimateHorizontally | bool | Should the pieces animate horizontally? | Components/Throbber.h |
|
| bAnimateOpacity | bool | Should the pieces animate their opacity? | Components/Throbber.h |
|
| bAnimateVertically | bool | Should the pieces animate vertically? | Components/Throbber.h |
|
| Image | FSlateBrush | The animated pieces. | Components/Throbber.h |
|
| NumberOfPieces | int32 | How many pieces there are | Components/Throbber.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MyThrobber | TSharedPtr< SThrobber > | The Throbber widget managed by this object. | Components/Throbber.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FSlateBrush & GetImage() |
Components/Throbber.h | ||
int32 GetNumberOfPieces() |
Components/Throbber.h |
|
|
bool IsAnimateHorizontally() |
Components/Throbber.h |
|
|
bool IsAnimateOpacity() |
Components/Throbber.h |
|
|
bool IsAnimateVertically() |
Components/Throbber.h |
|
|
void SetAnimateHorizontally
(
bool bInAnimateHorizontally |
Sets whether the pieces animate horizontally. | Components/Throbber.h |
|
void SetAnimateOpacity
(
bool bInAnimateOpacity |
Sets whether the pieces animate their opacity. | Components/Throbber.h |
|
void SetAnimateVertically
(
bool bInAnimateVertically |
Sets whether the pieces animate vertically. | Components/Throbber.h |
|
void SetImage
(
const FSlateBrush& Brush |
Components/Throbber.h | ||
void SetNumberOfPieces
(
int32 InNumberOfPieces |
Sets how many pieces there are | Components/Throbber.h |
|
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
Gets the palette category of the widget | Components/Throbber.h | |
virtual void SynchronizeProperties () |
Applies all properties to the native widget if possible. | Components/Throbber.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
Components/Throbber.h |
Protected
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > RebuildWidget() |
Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | Components/Throbber.h |