UCircularThrobber | Unreal Engine 5.7 Documentation

A throbber widget that orients images in a spinning circle.


Name	UCircularThrobber
Type	class
Header File	/Engine/Source/Runtime/UMG/Public/Components/CircularThrobber.h
Include Path	#include "Components/CircularThrobber.h"

Syntax

UCLASS (MinimalAPI)  
class UCircularThrobber : public UWidget

Name	Remarks	Include Path	Unreal Specifiers
UCircularThrobber ( const FObjectInitializer& ObjectInitializer )		Components/CircularThrobber.h

Name	Type	Remarks	Include Path	Unreal Specifiers
Image	FSlateBrush	The throbber image.	Components/CircularThrobber.h	EditAnywhere BlueprintReadWrite Getter Setter Category=Appearance
NumberOfPieces	int32	How many pieces there are	Components/CircularThrobber.h	EditAnywhere BlueprintReadWrite Getter Setter BlueprintSetter="SetNumberOfPieces" Category=Appearance Meta=(ClampMin="1", ClampMax="25", UIMin="1", UIMax="25")
Period	float	The amount of time for a full circle (in seconds)	Components/CircularThrobber.h	EditAnywhere BlueprintReadWrite Getter Setter BlueprintSetter="SetPeriod" Category=Appearance Meta=(ClampMin="0", UIMin="0")
Radius	float	The radius of the circle.	Components/CircularThrobber.h	EditAnywhere BlueprintReadWrite Getter Setter BlueprintSetter="SetRadius" Category=Appearance Meta=(EditCondition="bEnableRadius")

Name	Type	Remarks	Include Path	Unreal Specifiers
bEnableRadius	bool		Components/CircularThrobber.h	Transient EditAnywhere Category="Appearance" Meta=(InlineEditConditionToggle)
MyCircularThrobber	TSharedPtr< SCircularThrobber >	The CircularThrobber widget managed by this object.	Components/CircularThrobber.h

Name	Remarks	Include Path	Unreal Specifiers
const FSlateBrush & GetImage()		Components/CircularThrobber.h
int32 GetNumberOfPieces()		Components/CircularThrobber.h	BlueprintCallable Category="Appearance"
float GetPeriod()		Components/CircularThrobber.h	BlueprintCallable Category="Appearance"
float GetRadius()		Components/CircularThrobber.h	BlueprintCallable Category="Appearance"
void SetImage ( const FSlateBrush& InRadius )	Sets the throbber image.	Components/CircularThrobber.h
void SetNumberOfPieces ( int32 InNumberOfPieces )	Sets how many pieces there are.	Components/CircularThrobber.h	BlueprintCallable Category="Appearance"
void SetPeriod ( float InPeriod )	Sets the amount of time for a full circle (in seconds).	Components/CircularThrobber.h	BlueprintCallable Category="Appearance"
void SetRadius ( float InRadius )	Sets the radius of the circle.	Components/CircularThrobber.h	BlueprintCallable Category="Appearance"

Name	Remarks	Include Path	Unreal Specifiers
virtual const FText GetPaletteCategory()	Gets the palette category of the widget	Components/CircularThrobber.h
virtual void SynchronizeProperties ()	Applies all properties to the native widget if possible.	Components/CircularThrobber.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void ReleaseSlateResources ( bool bReleaseChildren )		Components/CircularThrobber.h

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/CircularThrobber.h