1. Epic GamesDeveloper
  3. FCarouselDisplayItem

FCarouselDisplayItem

The Carousel display widget that gets animated by the carousel widget

API > API/Runtime > API/Runtime/WidgetCarousel

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function   Construct the display widget.

Functions

  Type Name Description
Public function bool

BlendWidget ( const float& DeltaTime,
const float& DesiredValue,
const float& Speed,
float& OutCurrentValue
)

 Blend the widget fade / transform to the desired value.
Public function TSharedPtr< SFxWidget > FText GetPositionText() const { return FText::FromString(FString::Printf(TEXT("%.2f, %.2f, %.2f"), SlideValue, DesiredSlideValue, SlideInCurve.GetLerp())); } Get the FX widget to display.
Protected function Const FVector2D Get the slide position - used by the FX widget to get its position.
Public function Const const float  
Public function bool  
Public function void Scroll out the widget.
Public function void Scroll in the widget. The scroll direction.
Public function void

SetFadeRate ( float DesiredFadeRate
)

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

SetMoveSpeed ( float DesiredMoveSpeed
)

 Set the desired move speed.
Public function void

SetOpacity ( float InOpacity
)

 Get the widget opacity.
Public function void

SetSlide ( float InSlide,
bool bClearTransition
)

 Set the slide position.
Public function void

SetSliderLeftLimit ( float DesiredLeftLimit
)

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

SetSliderOptimalPostion ( float DesiredOptimalSlideValue
)

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

SetSliderPeakLeftLimit ( float DesiredLimit
)

  
Public function void

SetSliderPeakRightLimit ( float DesiredLimit
)

  
Public function void

SetSliderRightLimit ( float DesiredRightLimit
)

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

SetVisibility ( EVisibility InVisibility
)

  
Public function void Set the content of the widget to display.
Public function void

Tick ( float DeltaTime
)

 Tick the widget - animate the slide / fade.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page