Navigation
API > API/Runtime > API/Runtime/Slate
A throbber widget that orients images in a spinning circle.
| Name | SCircularThrobber |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Images/SThrobber.h |
| Include Path | #include "Widgets/Images/SThrobber.h" |
Syntax
class SCircularThrobber : public SLeafWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SLeafWidget → SCircularThrobber
- FSlateControlledConstruction → SWidget → SLeafWidget → SCircularThrobber
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SCircularThrobber() |
Widgets/Images/SThrobber.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SCircularThrobber() |
Widgets/Images/SThrobber.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PrivateParentType | SLeafWidget | Widgets/Images/SThrobber.h | |
| PrivateThisType | SCircularThrobber | Widgets/Images/SThrobber.h | |
| Super | SLeafWidget | Widgets/Images/SThrobber.h | |
| ThisClass | SCircularThrobber | Widgets/Images/SThrobber.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MinimumPeriodValue | const float | Widgets/Images/SThrobber.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bColorAndOpacitySet | bool | Widgets/Images/SThrobber.h | ||
| ColorAndOpacity | TSlateAttribute< FSlateColor > | Color and opacity of the throbber images. | Widgets/Images/SThrobber.h | |
| Curve | FCurveHandle | Widgets/Images/SThrobber.h | ||
| NumPieces | int32 | How many pieces there are | Widgets/Images/SThrobber.h | |
| Period | float | The amount of time in seconds for a full circle | Widgets/Images/SThrobber.h | |
| PieceImage | const FSlateBrush * | What each segment of the throbber looks like | Widgets/Images/SThrobber.h | |
| Radius | float | The radius of the circle | Widgets/Images/SThrobber.h | |
| Sequence | FCurveSequence | The sequence to drive the spinning animation | Widgets/Images/SThrobber.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Constructs the widget | Widgets/Images/SThrobber.h | |
void InvalidatePieceImage () |
Invalidate the SCircularThrobber with the correct reason. | Widgets/Images/SThrobber.h | |
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Images/SThrobber.h | ||
void SetNumPieces
(
int32 InNumPieces |
Sets how many pieces there are | Widgets/Images/SThrobber.h | |
void SetPeriod
(
float InPeriod |
Sets the amount of time in seconds for a full circle | Widgets/Images/SThrobber.h | |
void SetPieceImage
(
const FSlateBrush* InPieceImage |
Sets what each segment of the throbber looks like | Widgets/Images/SThrobber.h | |
void SetRadius
(
float InRadius |
Sets the radius of the circle | Widgets/Images/SThrobber.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Widgets/Images/SThrobber.h | ||
virtual bool ComputeVolatility() |
Widgets/Images/SThrobber.h |
Overridden from FSlateControlledConstruction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FSlateWidgetClassData & GetWidgetClass() |
Widgets/Images/SThrobber.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FSlateWidgetClassData & GetPrivateWidgetClass() |
Widgets/Images/SThrobber.h | ||
static SLATE_API void PrivateRegisterAttributes
(
FSlateAttributeInitializer& |
Widgets/Images/SThrobber.h | ||
static const FSlateWidgetClassData & StaticWidgetClass() |
Widgets/Images/SThrobber.h |