SWidgetCarousel

Implements a widget Carousel.

Windows
MacOS
Linux

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

Name Description

Protected variable

TSharedPtr< FCa...

 

CenterCarouselWidget

Protected variable

float

 

FadeRate

The fade rate.

Protected variable

const TArray< I...

 

ItemsSource

Pointer to the array of data items that we are observing.

Protected variable

TSharedPtr< FCa...

 

LeftCarouselWidget

Holds the CarouselWidgets.

Protected variable

float

 

MoveSpeed

Holds the move speed.

Protected variable

FOnGenerateWidg...

 

OnGenerateWidget

Hold the delegate to be invoked when a widget changes.

Protected variable

FOnCarouselPage...

 

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< FCa...

 

RightCarouselWidget

Protected variable

float

 

SlideValueLeftLimit

Holds The left limit.

Protected variable

float

 

SlideValueRightLimit

The right limit.

Protected variable

TSharedPtr< SHo...

 

WidgetDisplayBox

Holds the widget display box.

Protected variable

int32

 

WidgetIndex

Holds the visible widget index.

Functions

Name Description

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Constructs the widget.

Public function

void

 

GenerateCurrentWidgets()

Protected function

void

 

GenerateWidgets()

Regenerate the widgets to display them.

Protected function

int32

 

GetLeftWidgetIndex

(
    int32 Index
)

Public function

float

 

GetPrimarySlide()

Protected function

int32

 

GetRightWidgetIndex

(
    int32 Index
)

Public function

int32

 

GetWidgetIndex()

Get the current widget index.

Protected function

bool

 

IsInTransition()

Public function

void

 

Peak

(
    EWidgetCarouselScrollDirection::Typ...
)

Protected function

EActiveTimer...

 

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 >* InWi...
)

Set the item source, and scroll to the first item.

Public function

void

 

SetNextWidget()

Scroll right.

Public function

void

 

SetPreviousWidget()

Scroll left.

Protected function

void

 

SetSliderLimits()

Protected function

void

 

SwapBuffer

(
    EWidgetCarouselScrollDirection::Typ...,
    int32 OverrideWidget
)

Swap the buffer index.

Classes

Name

Description

Public struct

FArguments

Typedefs

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss