UCommonRotator

A button that can rotate between given text labels.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonRotator.h

Include

#include "CommonRotator.h"

Syntax

UCLASS(Meta=(DisableNativeTick))
class UCommonRotator : public UCommonButtonBase

Remarks

A button that can rotate between given text labels.

Variables

Name Description

Protected variable UProperty Category, Meta BlueprintReadOnly

UCommonTextBloc...

 

MyText

The displayed text

Public variable

FNavigationDele...

 

OnNavigation

Handle and use controller navigation to rotate text

Public variable UProperty Category BlueprintAssignable

FOnRotated

 

OnRotated

Called when the Selected state of this button changes

Public variable

FRotationEvent

 

OnRotatedEvent

Protected variable

int32

 

SelectedIndex

The index of the current text item

Protected variable

TArray< FText >

 

TextLabels

Holds the array of display texts.

Constructors

Name Description

Public function

UCommonRotator

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function UFunction Category, Meta, BlueprintImplementableEvent

void

 

BP_OnOptionSelected

(
    int32 Index
)

Protected function UFunction Category, Meta, BlueprintImplementableEvent

void

 

BP_OnOptionsPopulated

(
    int32 Count
)

Public function Const UFunction BlueprintCallable, Category

int32

 

GetSelectedIndex()

Gets the current selected index

Public function Const UFunction BlueprintCallable, Category

FText

 

GetSelectedText()

Gets the current text value of the slider.

Public function

TSharedPtr< ...

 

HandleNavigation

(
    EUINavigation UINavigation
)

Public function UFunction BlueprintCallable, Category

void

 

PopulateTextLabels

(
    TArray< FText > Labels
)

Set the array of texts available

Public function Virtual UFunction BlueprintCallable, Category

void

 

SetSelectedItem

(
    int32 InValue
)

Sets the current value of the slider.

Public function UFunction BlueprintCallable, Category

void

 

ShiftTextLeft()

Shift the current text left.

Protected function

void

 

ShiftTextLeftInternal

(
    bool bFromNavigation
)

Public function UFunction BlueprintCallable, Category

void

 

ShiftTextRight()

Shift the current text right.

Protected function

void

 

ShiftTextRightInternal

(
    bool bFromNavigation
)

Overridden from UUserWidget

Name Description

Public function Virtual

bool

 

Initialize()

Public function Virtual

FNavigationR...

 

NativeOnNavigation

(
    const FGeometry& MyGeometry,
    const FNavigationEvent& InNavigati...,
    const FNavigationReply& InDefaultR...
)

Classes

Name

Description

Public class

FRotationEvent