FCarouselDisplayItem Struct Reference

#include <SWidgetCarousel.h>

Inheritance diagram for FCarouselDisplayItem:

Public Member Functions
	FCarouselDisplayItem ()
void	ScrollIn (EWidgetCarouselScrollDirection::Type ScrollDirection)
void	PeakIn (EWidgetCarouselScrollDirection::Type ScrollDirection)
void	Tick (float DeltaTime)
bool	BlendWidget (const float &DeltaTime, const float &DesiredValue, const float &Speed, float &OutCurrentValue)
void	SetWidgetContent (TSharedRef< SWidget > InContent)
TSharedRef< SWidget >	GetWidgetContent () const
TSharedPtr< SFxWidget >	GetSFXWidget ()
void	SetOpacity (float InOpacity)
void	SetVisibility (EVisibility InVisibility)
void	SetSlide (float InSlide, bool bClearTransition=false)
void	SetMoveSpeed (float DesiredMoveSpeed)
void	SetSliderLeftLimit (float DesiredLeftLimit)
void	SetSliderRightLimit (float DesiredRightLimit)
void	SetSliderPeakLeftLimit (float DesiredLimit)
void	SetSliderPeakRightLimit (float DesiredLimit)
void	SetSliderOptimalPostion (float DesiredOptimalSlideValue)
void	SetFadeRate (float DesiredFadeRate)
bool	IsInTransition ()
const float	GetSlideValue () const
const float	GetMoveSpeed () const
Public Member Functions inherited from TSharedFromThis< FCarouselDisplayItem >
TSharedRef< FCarouselDisplayItem, Mode >	AsShared ()
TSharedRef< FCarouselDisplayItem const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FCarouselDisplayItem, Mode >	AsWeak ()
TWeakPtr< FCarouselDisplayItem const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Protected Member Functions
FVector2D	GetSlide () const
Protected Member Functions inherited from TSharedFromThis< FCarouselDisplayItem >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Protected Attributes
float	OpacityValue
float	SlideValue
float	DesiredOpacityValue
float	SlideValueLeftLimit
float	SlideValueRightLimit
float	PeakValueLeftLimit
float	PeakValueRightLimit
float	OptimalSlideValue
float	DesiredSlideValue
bool	bTransition
bool	bPeak
bool	bFade
bool	bFadeInAndOut
float	MoveSpeed
float	PeakSpeed
float	PeakDistance
float	FadeRate
TSharedPtr< SFxWidget >	FXWidget
FCurveSequence	SlideInCurve
EVisibility	Visibility

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< FCarouselDisplayItem >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

The Carousel display widget that gets animated by the carousel widget

Constructor & Destructor Documentation

FCarouselDisplayItem()

FCarouselDisplayItem::FCarouselDisplayItem ( )

inline

Construct the display widget.

Member Function Documentation

BlendWidget()

bool FCarouselDisplayItem::BlendWidget ( const float &  DeltaTime, const float &  DesiredValue, const float &  Speed, float &  OutCurrentValue  )

inline

Blend the widget fade / transform to the desired value.

Parameters

DeltaTime	- The delta time.
DesiredValue	- The desired value.
Speed	- Speed to transform.
OutCurrentValue	- The value to set.

Returns

True if still blending, false otherwise

GetMoveSpeed()

const float FCarouselDisplayItem::GetMoveSpeed ( ) const

inline

GetSFXWidget()

TSharedPtr< SFxWidget > FCarouselDisplayItem::GetSFXWidget ( )

inline

Get the FX widget to display.

Returns

The FX widget.

GetSlide()

FVector2D FCarouselDisplayItem::GetSlide ( ) const

inlineprotected

Get the slide position - used by the FX widget to get its position.

Returns

The slide position.

GetSlideValue()

const float FCarouselDisplayItem::GetSlideValue ( ) const

inline

GetWidgetContent()

TSharedRef< SWidget > FCarouselDisplayItem::GetWidgetContent ( ) const

inline

IsInTransition()

bool FCarouselDisplayItem::IsInTransition ( )

inline

PeakIn()

void FCarouselDisplayItem::PeakIn ( EWidgetCarouselScrollDirection::Type  ScrollDirection )

inline

Scroll out the widget.

Parameters

ScrollDirection

- The scroll direction.

ScrollIn()

void FCarouselDisplayItem::ScrollIn ( EWidgetCarouselScrollDirection::Type  ScrollDirection )

inline

Scroll in the widget. @ScrollDirection The scroll direction.

SetFadeRate()

void FCarouselDisplayItem::SetFadeRate ( float  DesiredFadeRate )

inline

Set the fade rate. The widget fade in and out at this amount per frame.

Parameters

DesiredFadeRate

- the desired fade value.

SetMoveSpeed()

void FCarouselDisplayItem::SetMoveSpeed ( float  DesiredMoveSpeed )

inline

Set the desired move speed.

Parameters

DesiredMoveSpeed

- the desired move speed.

SetOpacity()

void FCarouselDisplayItem::SetOpacity ( float  InOpacity )

inline

Get the widget opacity.

Parameters

InOpacity

- the desired opacity.

SetSlide()

void FCarouselDisplayItem::SetSlide ( float  InSlide, bool  bClearTransition = false  )

inline

Set the slide position.

Parameters

InSlide	- the desired slide position.
bClearTransition	- Clear any transitions.

SetSliderLeftLimit()

void FCarouselDisplayItem::SetSliderLeftLimit ( float  DesiredLeftLimit )

inline

Set the desired left limit. The widget will go to this position when scrolling out and left.

Parameters

DesiredLeftLimit

- the desired left limit.

SetSliderOptimalPostion()

void FCarouselDisplayItem::SetSliderOptimalPostion ( float  DesiredOptimalSlideValue )

inline

Set the optimal slide position. The widget will go to this position when in view.

Parameters

DesiredOptimalSlideValue

- the desired optimal position.

SetSliderPeakLeftLimit()

void FCarouselDisplayItem::SetSliderPeakLeftLimit ( float  DesiredLimit )

inline

SetSliderPeakRightLimit()

void FCarouselDisplayItem::SetSliderPeakRightLimit ( float  DesiredLimit )

inline

SetSliderRightLimit()

void FCarouselDisplayItem::SetSliderRightLimit ( float  DesiredRightLimit )

inline

Set the desired right limit. The widget will go to this position when scrolling out and right.

Parameters

DesiredRightLimit

- the desired right limit.

SetVisibility()

void FCarouselDisplayItem::SetVisibility ( EVisibility  InVisibility )

inline

SetWidgetContent()

void FCarouselDisplayItem::SetWidgetContent ( TSharedRef< SWidget >  InContent )

inline

Set the content of the widget to display.

Parameters

InContent

- The widget to display.

Tick()

void FCarouselDisplayItem::Tick ( float  DeltaTime )

inline

Tick the widget - animate the slide / fade.

Parameters

DeltaTime

- The delta time.

Member Data Documentation

bFade

bool FCarouselDisplayItem::bFade

protected

bFadeInAndOut

bool FCarouselDisplayItem::bFadeInAndOut

protected

bPeak

bool FCarouselDisplayItem::bPeak

protected

bTransition

bool FCarouselDisplayItem::bTransition

protected

DesiredOpacityValue

float FCarouselDisplayItem::DesiredOpacityValue

protected

DesiredSlideValue

float FCarouselDisplayItem::DesiredSlideValue

protected

FadeRate

float FCarouselDisplayItem::FadeRate

protected

FXWidget

TSharedPtr< SFxWidget > FCarouselDisplayItem::FXWidget

protected

MoveSpeed

float FCarouselDisplayItem::MoveSpeed

protected

OpacityValue

float FCarouselDisplayItem::OpacityValue

protected

OptimalSlideValue

float FCarouselDisplayItem::OptimalSlideValue

protected

PeakDistance

float FCarouselDisplayItem::PeakDistance

protected

PeakSpeed

float FCarouselDisplayItem::PeakSpeed

protected

PeakValueLeftLimit

float FCarouselDisplayItem::PeakValueLeftLimit

protected

PeakValueRightLimit

float FCarouselDisplayItem::PeakValueRightLimit

protected

SlideInCurve

FCurveSequence FCarouselDisplayItem::SlideInCurve

protected

SlideValue

float FCarouselDisplayItem::SlideValue

protected

SlideValueLeftLimit

float FCarouselDisplayItem::SlideValueLeftLimit

protected

SlideValueRightLimit

float FCarouselDisplayItem::SlideValueRightLimit

protected

Visibility

EVisibility FCarouselDisplayItem::Visibility

protected

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/WidgetCarousel/Public/SWidgetCarousel.h