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

Inheritance Hierarchy

References

   
Module CommonUI
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonAnimatedSwitcher.h
Include #include "CommonAnimatedSwitcher.h"

Syntax

UCLASS&40;&41;  
class UCommonAnimatedSwitcher : public UWidgetSwitcher

Remarks

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

Variables

  Type Name Description
Protected variable bool bCurrentlySwitching  
Protected variable bool bInstantTransition If set, transition animations will not play
Protected variable bool bSetOnce  
Protected variable TSharedPtr< SCommonAnimatedSwitcher > MyAnimatedSwitcher  
Protected variable TSharedPtr< SSpacer > MyInputGuard  
Protected variable TSharedPtr< SOverlay > MyOverlay  
Public variable UCommonAnimatedSwitcher::FOnActiveIndexChanged OnActiveWidgetIndexChanged  
Public variable UCommonAnimatedSwitcher::FOnTransitioningChanged OnTransitioningChanged  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly ETransitionCurve 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 ECommonSwitcherTransition TransitionType The type of transition to play between widgets

Constructors

  Type Name Description
Public function  

UCommonAnimatedSwitcher ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

ActivateNextWidget ( bool bCanWrap
)

  
Public function UFunction BlueprintCallable, Category void

ActivatePreviousWidget ( bool bCanWrap
)

  
Protected function Virtual void  
Protected function Virtual void

HandleSlateActiveIndexChanged ( int32 ActiveIndex
)

  
Protected function Virtual void

HandleSlateIsTransitioningChanged ( bool bIsTransitioning
)

  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool Is the switcher playing a transition animation?
Public function UFunction BlueprintCallable, Category void

SetDisableTransitionAnimation ( bool bDisableAnimation
)

  

Overridden from UWidgetSwitcher

  Type 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

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FOnActiveIndexChanged Fires when the active widget displayed by the switcher changes  
Public class FOnTransitioningChanged Fires when the switcher changes its transition animation state  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page