1. Epic GamesDeveloper
  3. SWidgetCarousel

SWidgetCarousel

Implements a widget Carousel.

API > API/Runtime > API/Runtime/WidgetCarousel

Inheritance Hierarchy

References

   
Module WidgetCarousel
Header /Engine/Source/Runtime/WidgetCarousel/Public/SWidgetCarousel.h
Include #include "SWidgetCarousel.h"

Syntax

template<typename ItemType>  
class SWidgetCarousel : public SCompoundWidget

Remarks

Implements a widget Carousel.

A widget Carousel displays widgets that can be scrolled in and out.

Variables

  Type Name Description
Protected variable TSharedPtr< FCarouselDisplayItem > CenterCarouselWidget  
Protected variable float FadeRate The fade rate.
Protected variable const TArray< ItemType > * ItemsSource Pointer to the array of data items that we are observing.
Protected variable TSharedPtr< FCarouselDisplayItem > LeftCarouselWidget Holds the CarouselWidgets.
Protected variable float MoveSpeed Holds the move speed.
Protected variable FOnGenerateWidget OnGenerateWidget Hold the delegate to be invoked when a widget changes.
Protected variable FOnCarouselPageChanged OnPageChanged Hold the delegate to be invoked when the current page changes.
Protected variable float PeakValueLeftLimit Holds The peak left limit.
Protected variable float PeakValueRightLimit The peak right limit.
Protected variable TSharedPtr< FCarouselDisplayItem > RightCarouselWidget  
Protected variable float SlideValueLeftLimit Holds The left limit.
Protected variable float SlideValueRightLimit The right limit.
Protected variable TSharedPtr< SHorizontalBox > WidgetDisplayBox Holds the widget display box.
Protected variable int32 WidgetIndex Holds the visible widget index.

Functions

  Type Name Description
Public function void

Construct ( const FArguments& InArgs
)

 Constructs the widget.
Public function void  
Protected function void Regenerate the widgets to display them.
Protected function int32

GetLeftWidgetIndex ( int32 Index
)

  
Public function float  
Protected function int32

GetRightWidgetIndex ( int32 Index
)

  
Public function int32 Get the current widget index.
Protected function bool  
Public function void  
Protected function EActiveTimerReturnType

RegisteredTick ( double InCurrentTime,
float InDeltaTime
)

  
Public function void

SetActiveWidgetIndex ( int32 Index
)

 Sets the active widget to display at the specified index.
Public function void

SetItemSource ( const TArray< ItemType >* InWidgetItemsSource
)

 Set the item source, and scroll to the first item.
Public function void Scroll right.
Public function void Scroll left.
Protected function void  
Protected function void

SwapBuffer ( EWidgetCarouselScrollDirection::Type ScrollDirection,
int32 OverrideWidget
)

 Swap the buffer index.

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
FOnCarouselPageChanged  
FOnGenerateWidget  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page