1. Epic GamesDeveloper
  3. UCommonAnimatedSwitcher

UCommonAnimatedSwitcher

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

API > API/Plugins > API/Plugins/CommonUI

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

   
Name UCommonAnimatedSwitcher
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonAnimatedSwitcher.h
Include Path #include "CommonAnimatedSwitcher.h"

Syntax

UCLASS (MinimalAPI)  
class UCommonAnimatedSwitcher : public UWidgetSwitcher

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonAnimatedSwitcher ( const FObjectInitializer& ObjectInitializer
)

   CommonAnimatedSwitcher.h  

Classes

Name Remarks
FOnActiveIndexChanged Fires when the active widget displayed by the switcher changes
FOnTransitioningChanged Fires when the switcher changes its transition animation state

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnActiveWidgetIndexChanged UCommonAnimatedSwitcher::FOnActiveIndexChanged   CommonAnimatedSwitcher.h  
OnActiveWidgetIndexChangedBP FOnActiveIndexChangedDelegate Fires when the active widget displayed by the switcher changes CommonAnimatedSwitcher.h
  • BlueprintAssignable
  • Category="Common Widget Switcher"
OnTransitioningChanged UCommonAnimatedSwitcher::FOnTransitioningChanged   CommonAnimatedSwitcher.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ActivateNextWidget ( bool bCanWrap
)

   CommonAnimatedSwitcher.h
  • BlueprintCallable
  • Category="Common Widget Switcher"

void ActivatePreviousWidget ( bool bCanWrap
)

   CommonAnimatedSwitcher.h
  • BlueprintCallable
  • Category="Common Widget Switcher"

UWidget * GetPendingActiveWidget()

   CommonAnimatedSwitcher.h  

int32 GetPendingActiveWidgetIndex()

   CommonAnimatedSwitcher.h  

bool HasWidgets()

   CommonAnimatedSwitcher.h
  • BlueprintCallable
  • Category="Common Widget Switcher"

bool IsCurrentlySwitching()

   CommonAnimatedSwitcher.h
  • BlueprintCallable
  • Category="Common Widget Switcher"

bool IsTransitionPlaying()

 Is the switcher playing a transition animation? CommonAnimatedSwitcher.h
  • BlueprintCallable
  • Category="Common Widget Switcher"

void SetDisableTransitionAnimation ( bool bDisableAnimation
)

   CommonAnimatedSwitcher.h
  • BlueprintCallable
  • Category="Common Widget Switcher"

Overridden from UWidgetSwitcher

Name Remarks Include Path Unreal Specifiers

virtual void SetActiveWidget ( UWidget* Widget
)

   CommonAnimatedSwitcher.h  

virtual void SetActiveWidgetIndex ( int32 Index
)

   CommonAnimatedSwitcher.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   CommonAnimatedSwitcher.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   CommonAnimatedSwitcher.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void HandleOutgoingWidget()

   CommonAnimatedSwitcher.h  

virtual void HandleSlateActiveIndexChanged ( int32 ActiveIndex
)

   CommonAnimatedSwitcher.h  

virtual void HandleSlateIsTransitioningChanged ( bool bIsTransitioning
)

   CommonAnimatedSwitcher.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

   CommonAnimatedSwitcher.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page