1. Epic GamesDeveloper
  3. UCommonActivatableWidgetContainerBase

UCommonActivatableWidgetContainerBase

Base of widgets built to manage N activatable widgets, displaying one at a time.

API > API/Plugins > API/Plugins/CommonUI > API/Plugins/CommonUI/Widgets

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract)  
class UCommonActivatableWidgetContainerBase : public UWidget

Remarks

Base of widgets built to manage N activatable widgets, displaying one at a time. Intentionally meant to be black boxes that do not expose child/slot modification like a normal panel widget.

Variables

  Type Name Description
Protected variable UProperty Transient TObjectPtr< UCommonActivatableWidget > DisplayedWidget  
Protected variable UProperty Transient FUserWidgetPool GeneratedWidgetsPool  
Protected variable TSharedPtr< SSpacer > MyInputGuard  
Protected variable TSharedPtr< SOverlay > MyOverlay  
Protected variable TSharedPtr< SCommonAnimatedSwitcher > MySwitcher  
Public variable FTransitioningChanged OnTransitioningChanged  
Protected variable UProperty Category, EditAnywhere ETransitionCurve TransitionCurveType The curve function type to apply to the transition animation
Protected variable UProperty Category, EditAnywhere float TransitionDuration The total duration of a single transition between widgets
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly ECommonSwitcherTransitionFallbackStrategy TransitionFallbackStrategy Controls how we will choose another widget if a transitioning widget is removed during the transition.
Protected variable UProperty Category, EditAnywhere ECommonSwitcherTransition TransitionType The type of transition to play between widgets
Protected variable UProperty Transient TArray< TObjectPtr< UCommonActivatableWidget > > WidgetList  

Constructors

  Type Name Description
Public function  

UCommonActivatableWidgetContainerBase ( const FObjectInitializer& Initializer
)

  

Functions

  Type Name Description
Public function ActivatableWidgetT *

AddWidget ( TSubclassOf< UCommonActivatableWidget > ActivatableWidgetClass,
TFunctionRef< void(ActivatableWidgetT&)> InstanceInitFunc
)

 Generates (either creates or pulls from the inactive pool) instance of the given widget class and adds it to the container.
Public function ActivatableWidgetT *

AddWidget ( TSubclassOf< UCommonActivatableWidget > ActivatableWidgetClass
)

 Adds an activatable widget to the container. See BP_AddWidget for more info.
Public function void Adds an activatable widget instance to the container.
Public function UFunction BlueprintCallable, Category void  
Public function Const UFunction BlueprintCallable, Category UCommonActivatableWidget *  
Public function Const int32  
Public function Const UFunction BlueprintCallable, Category float  
Public function Const const TArray< UCommonActivatableWidget * > &  
Public function Const FOnDisplayedWidgetChanged &  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual TSharedRef< SWidget >  
Protected function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  
Public function void  
Protected function void

SetSwitcherIndex ( int32 TargetIndex,
bool bInstantTransition
)

  
Public function UFunction BlueprintCallable, Category void

SetTransitionDuration ( float Duration
)

  

Classes

  Type Name Description
Public class FOnDisplayedWidgetChanged    
Public class FTransitioningChanged    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page