Navigation
API > API/Runtime > API/Runtime/WidgetCarousel
The Carousel display widget that gets animated by the carousel widget
| Name | FCarouselDisplayItem |
| Type | struct |
| Header File | /Engine/Source/Runtime/WidgetCarousel/Public/SWidgetCarousel.h |
| Include Path | #include "SWidgetCarousel.h" |
Syntax
struct FCarouselDisplayItem : public TSharedFromThis< FCarouselDisplayItem >
Inheritance Hierarchy
- TSharedFromThis< FCarouselDisplayItem > → FCarouselDisplayItem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCarouselDisplayItem() |
Construct the display widget. | SWidgetCarousel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool BlendWidget
(
const float& DeltaTime, |
Blend the widget fade / transform to the desired value. | SWidgetCarousel.h | |
const float GetMoveSpeed() |
SWidgetCarousel.h | ||
TSharedPtr< SFxWidget > GetSFXWidget() |
FText GetPositionText() const { return FText::FromString(FString::Printf(TEXT("%.2f, %.2f, %.2f"), SlideValue, DesiredSlideValue, SlideInCurve.GetLerp())); } Get the FX widget to display. | SWidgetCarousel.h | |
const float GetSlideValue() |
SWidgetCarousel.h | ||
TSharedRef< SWidget > GetWidgetContent() |
SWidgetCarousel.h | ||
bool IsInTransition() |
SWidgetCarousel.h | ||
void PeakIn
(
EWidgetCarouselScrollDirection::Type ScrollDirection |
Scroll out the widget. | SWidgetCarousel.h | |
void ScrollIn
(
EWidgetCarouselScrollDirection::Type ScrollDirection |
Scroll in the widget. @ScrollDirection The scroll direction. | SWidgetCarousel.h | |
void SetFadeRate
(
float DesiredFadeRate |
Set the fade rate. The widget fade in and out at this amount per frame. | SWidgetCarousel.h | |
void SetMoveSpeed
(
float DesiredMoveSpeed |
Set the desired move speed. | SWidgetCarousel.h | |
void SetOpacity
(
float InOpacity |
Get the widget opacity. | SWidgetCarousel.h | |
void SetSlide
(
float InSlide, |
Set the slide position. | SWidgetCarousel.h | |
void SetSliderLeftLimit
(
float DesiredLeftLimit |
Set the desired left limit. The widget will go to this position when scrolling out and left. | SWidgetCarousel.h | |
void SetSliderOptimalPostion
(
float DesiredOptimalSlideValue |
Set the optimal slide position. The widget will go to this position when in view. | SWidgetCarousel.h | |
void SetSliderPeakLeftLimit
(
float DesiredLimit |
SWidgetCarousel.h | ||
void SetSliderPeakRightLimit
(
float DesiredLimit |
SWidgetCarousel.h | ||
void SetSliderRightLimit
(
float DesiredRightLimit |
Set the desired right limit. The widget will go to this position when scrolling out and right. | SWidgetCarousel.h | |
void SetVisibility
(
EVisibility InVisibility |
SWidgetCarousel.h | ||
void SetWidgetContent
(
TSharedRef< SWidget > InContent |
Set the content of the widget to display. | SWidgetCarousel.h | |
void Tick
(
float DeltaTime |
Tick the widget - animate the slide / fade. | SWidgetCarousel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVector2D GetSlide() |
Get the slide position - used by the FX widget to get its position. | SWidgetCarousel.h |