SThrobber.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Animation/CurveHandle.h"
#include "Animation/CurveSequence.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SCompoundWidget.h"
#include "Widgets/SLeafWidget.h"
#include "Styling/CoreStyle.h"
 
class FPaintArgs;
class FSlateWindowElementList;
class SHorizontalBox;
 
 
template <>
struct TWidgetTypeTraits<class SThrobber>
{
    static constexpr bool SupportsInvalidation() { return true; }
};
 
class SThrobber
    : public SCompoundWidget
{
    static const int32 DefaultNumPieces = 3;
 
public:
 
    enum EAnimation
    {
        Vertical = 0x1 << 0,
        Horizontal = 0x1 << 1,
        Opacity = 0x1 << 2,
        VerticalAndOpacity = Vertical | Opacity,
        All = Vertical | Horizontal | Opacity,
        None = 0x0
    };
 
    SLATE_BEGIN_ARGS(SThrobber) 
        : _PieceImage( FCoreStyle::Get().GetBrush( "Throbber.Chunk" ) )
        , _NumPieces( DefaultNumPieces )
        , _Animate( SThrobber::All )
        {}
 
        SLATE_ARGUMENT( const FSlateBrush*, PieceImage )
        SLATE_ARGUMENT( int32, NumPieces )
        SLATE_ARGUMENT( EAnimation, Animate )
    SLATE_END_ARGS()
 
    SLATE_API void Construct(const FArguments& InArgs);
 
    SLATE_API void SetPieceImage(const FSlateBrush* InPieceImage);
 
    SLATE_API void InvalidatePieceImage();
 
    SLATE_API void SetNumPieces(int InNumPieces);
 
    SLATE_API void SetAnimate(EAnimation InAnimate);
 
    //~ Begin SWidget interface
    SLATE_API virtual bool ComputeVolatility() const override;
    //~ End SWidget interface
 
private:
 
    FVector2D GetPieceScale(int32 PieceIndex) const;
    FLinearColor GetPieceColor(int32 PieceIndex) const;
 
    void ConstructPieces();
 
    const FSlateBrush* GetPieceBrush() const;
 
private:
    
    FCurveSequence AnimCurves;
    TArray<FCurveHandle, TInlineAllocator<DefaultNumPieces> > ThrobberCurve;
 
    TSharedPtr<SHorizontalBox> HBox;
 
    const FSlateBrush* PieceImage;
 
    int32 NumPieces;
 
    EAnimation Animate;
};
 
 
template <>
struct TWidgetTypeTraits<class SCircularThrobber>
{
    static constexpr bool SupportsInvalidation() { return true; }
};
 
class SCircularThrobber
    : public SLeafWidget
{
    SLATE_DECLARE_WIDGET_API(SCircularThrobber, SLeafWidget, SLATE_API)
 
public:
    static SLATE_API const float MinimumPeriodValue;
 
    SLATE_BEGIN_ARGS(SCircularThrobber) 
        : _PieceImage( FCoreStyle::Get().GetBrush( "Throbber.CircleChunk" ) )
        , _NumPieces( 6 )
        , _Period( 0.75f )
        , _Radius( 16.f )
        {}
 
        SLATE_ARGUMENT( const FSlateBrush*, PieceImage )
        SLATE_ARGUMENT( int32, NumPieces )
        SLATE_ARGUMENT( float, Period )
        SLATE_ARGUMENT( float, Radius )
        SLATE_ATTRIBUTE(FSlateColor, ColorAndOpacity)
 
    SLATE_END_ARGS()
 
    SLATE_API SCircularThrobber();
    SLATE_API virtual ~SCircularThrobber();
 
    SLATE_API void Construct(const FArguments& InArgs);
 
    SLATE_API void SetPieceImage(const FSlateBrush* InPieceImage);
 
    SLATE_API void InvalidatePieceImage();
 
    SLATE_API void SetNumPieces(int32 InNumPieces);
 
    SLATE_API void SetPeriod(float InPeriod);
 
    SLATE_API void SetRadius(float InRadius);
 
    //~ Begin SWidget interface
    SLATE_API virtual int32 OnPaint( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled ) const override;
    SLATE_API virtual FVector2D ComputeDesiredSize(float) const override;
    SLATE_API virtual bool ComputeVolatility() const override;
    //~ End SWidget interface
 
private:
 
    void ConstructSequence();
 
private:
 
    FCurveSequence Sequence;
    FCurveHandle Curve;
 
    const FSlateBrush* PieceImage;
 
    int32 NumPieces;
 
    float Period;
 
    float Radius;
 
    TSlateAttribute<FSlateColor> ColorAndOpacity;
    bool bColorAndOpacitySet;
};