Navigation
API > API/Plugins > API/Plugins/CommonUI
A button that can rotate between given text labels.
| Name | UCommonRotator |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonRotator.h |
| Include Path | #include "CommonRotator.h" |
Syntax
UCLASS (MinimalAPI, Meta=(DisableNativeTick))
class UCommonRotator : public UCommonButtonBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UUserWidget → UCommonUserWidget → UCommonButtonBase → UCommonRotator
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonRotator
(
const FObjectInitializer& ObjectInitializer |
CommonRotator.h |
Classes
| Name | Remarks |
|---|---|
| FRotationEvent |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnNavigation | FNavigationDelegate | Handle and use controller navigation to rotate text | CommonRotator.h | |
| OnRotated | FOnRotated | Called when the Selected state of this button changes | CommonRotator.h |
|
| OnRotatedEvent | FRotationEvent | CommonRotator.h | ||
| OnRotatedWithDirection | FOnRotatedWithDirection | Called when the Selected state of this button changes. Provides the direction of rotation. | CommonRotator.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetSelectedIndex() |
Gets the current selected index | CommonRotator.h |
|
FText GetSelectedText() |
Gets the current text value of the slider. | CommonRotator.h |
|
TSharedPtr< SWidget > HandleNavigation
(
EUINavigation UINavigation |
CommonRotator.h | ||
| Set the array of texts available | CommonRotator.h |
|
|
virtual void SetSelectedItem
(
int32 InValue |
Sets the current value of the slider. | CommonRotator.h |
|
void ShiftTextLeft() |
Shift the current text left. | CommonRotator.h |
|
void ShiftTextRight() |
Shift the current text right. | CommonRotator.h |
|
Overridden from UUserWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Initialize() |
CommonRotator.h | ||
virtual FNavigationReply NativeOnNavigation
(
const FGeometry& MyGeometry, |
CommonRotator.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BP_OnOptionSelected
(
int32 Index |
CommonRotator.h |
|
|
void BP_OnOptionsPopulated
(
int32 Count |
CommonRotator.h |
|
|
void ShiftTextLeftInternal
(
bool bFromNavigation |
CommonRotator.h | ||
void ShiftTextRightInternal
(
bool bFromNavigation |
CommonRotator.h |