Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > WidgetCarousel > FCarouselDisplayItem

Light Theme

Dark Theme

FCarouselDisplayItem

The Carousel display widget that gets animated by the carousel widget

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FCarouselDisplayItem

References

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

Syntax

struct FCarouselDisplayItem : public TSharedFromThis< FCarouselDisplayItem >

Remarks

The Carousel display widget that gets animated by the carousel widget

Variables

	Name	Description
bool	bFade	Holds if the widget is fading in or out.
bool	bFadeInAndOut	Holds if the widget should fade in or out.
bool	bPeak	Hold if the widget is peaking.
bool	bTransition	Holds if widget is in transition.
float	DesiredOpacityValue	The desired opacity value.
float	DesiredSlideValue	The desired slide value.
float	FadeRate	The amount by which a widget fades per frame.
TSharedPtr< SFx...	FXWidget	Holds the FX widget that does the transitioning.
float	MoveSpeed	The maximum move speed of the widget.
float	OpacityValue	Holds the Opacity Value. 0 == transparent.
float	OptimalSlideValue	The slide value to display the widget on screen.
float	PeakDistance	The Peak Distance.
float	PeakSpeed	The Peak speed.
float	PeakValueLeftLimit	The left peak position.
float	PeakValueRightLimit	The right peak position.
FCurveSequence	SlideInCurve	Holds the peak curve.
float	SlideValue	The slide position.
float	SlideValueLeftLimit	The max left position.
float	SlideValueRightLimit	The max right position.
EVisibility	Visibility	The current visibility of the display item.

Constructors

	Name	Description
	FCarouselDisplayItem()	Construct the display widget.

Functions

	Name	Description
bool	BlendWidget ( const float& DeltaTime, const float& DesiredValue, const float& Speed, float& OutCurrentValue )	Blend the widget fade / transform to the desired value.
TSharedPtr< ...	GetSFXWidget()	FText GetPositionText() const { return FText::FromString, SlideValue, DesiredSlideValue, SlideInCurve.GetLerp())); } Get the FX widget to display.
FVector2D	GetSlide()	Get the slide position - used by the FX widget to get its position.
const float	GetSlideValue()
bool	IsInTransition()
void	PeakIn ( EWidgetCarouselScrollDirection::Typ... )	Scroll out the widget.
void	ScrollIn ( EWidgetCarouselScrollDirection::Typ... )	Scroll in the widget. The scroll direction.
void	SetFadeRate ( float DesiredFadeRate )	Set the fade rate. The widget fade in and out at this amount per frame.
void	SetMoveSpeed ( float DesiredMoveSpeed )	Set the desired move speed.
void	SetOpacity ( float InOpacity )	Get the widget opacity.
void	SetSlide ( float InSlide, bool bClearTransition )	Set the slide position.
void	SetSliderLeftLimit ( float DesiredLeftLimit )	Set the desired left limit. The widget will go to this position when scrolling out and left.
void	SetSliderOptimalPostion ( float DesiredOptimalSlideValue )	Set the optimal slide position. The widget will go to this position when in view.
void	SetSliderPeakLeftLimit ( float DesiredLimit )
void	SetSliderPeakRightLimit ( float DesiredLimit )
void	SetSliderRightLimit ( float DesiredRightLimit )	Set the desired right limit. The widget will go to this position when scrolling out and right.
void	SetVisibility ( EVisibility InVisibility )
void	SetWidgetContent ( TSharedRef< SWidget > InContent )	Set the content of the widget to display.
void	Tick ( float DeltaTime )	Tick the widget - animate the slide / fade.

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

Take our survey

Dismiss