UCommonAnimatedSwitcher

A widget switcher that activates / deactivates CommonActivatableWidgets, allowing for associated animations to trigger.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CommonUI

Header

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

Include

#include "CommonAnimatedSwitcher.h"

Syntax

UCLASS()
class UCommonAnimatedSwitcher : public UWidgetSwitcher

Remarks

A widget switcher that activates / deactivates CommonActivatableWidgets, allowing for associated animations to trigger.

Variables

Name Description

Protected variable

bool

 

bInstantTransition

If set, transition animations will not play

Protected variable

bool

 

bSetOnce

Protected variable

TSharedPtr< SCo...

 

MyAnimatedSwitcher

Protected variable

TSharedPtr< SSp...

 

MyInputGuard

Protected variable

TSharedPtr< SOv...

 

MyOverlay

Public variable

UCommonAnimated...

 

OnActiveWidgetIndexChanged

Protected variable UProperty Category, EditAnywhere BlueprintReadOnly

ETransitionCurv...

 

TransitionCurveType

The curve function type to apply to the transition animation

Protected variable UProperty Category, EditAnywhere BlueprintReadOnly

float

 

TransitionDuration

The total duration of a single transition between widgets

Protected variable UProperty Category, EditAnywhere BlueprintReadOnly

ECommonSwitcher...

 

TransitionType

The type of transition to play between widgets

Constructors

Name Description

Public function

UCommonAnimatedSwitcher

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function UFunction BlueprintCallable, Category

void

 

ActivateNextWidget

(
    bool bCanWrap
)

Public function UFunction BlueprintCallable, Category

void

 

ActivatePreviousWidget

(
    bool bCanWrap
)

Protected function Virtual

void

 

HandleOutgoingWidget()

Protected function Virtual

void

 

HandleSlateActiveIndexChanged

(
    int32 ActiveIndex
)

Protected function Virtual

void

 

HandleSlateIsTransitioningChanged

(
    bool bIsTransitioning
)

Public function Const UFunction BlueprintCallable, Category

bool

 

HasWidgets()

Public function UFunction BlueprintCallable, Category

void

 

SetDisableTransitionAnimation

(
    bool bDisableAnimation
)

Overridden from UWidgetSwitcher

Name Description

Public function Virtual

void

 

SetActiveWidget

(
    UWidget* Widget
)

Activates the widget and makes it the active index.

Public function Virtual

void

 

SetActiveWidgetIndex

(
    int32 Index
)

Activates the widget at the specified index.

Overridden from UWidget

Name Description

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Classes

Name

Description

Public class

FOnActiveIndexChanged

Fires when the active widget displayed by the switcher changes