SProgressBar.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Misc/Attribute.h"
#include "Styling/SlateColor.h"
#include "Styling/SlateWidgetStyleAsset.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SLeafWidget.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "SProgressBar.generated.h"
 
class FActiveTimerHandle;
class FPaintArgs;
class FSlateWindowElementList;
 
UENUM(BlueprintType)
namespace EProgressBarFillType
{
    enum Type : int
    {
        // will fill up from the left side to the right
        LeftToRight,
        // will fill up from the right side to the left side
        RightToLeft,
        // will scale up from the midpoint to the outer edges both vertically and horizontally
        FillFromCenter,
        // will fill up from the centerline to the outer edges horizontally
        FillFromCenterHorizontal,
        // will fill up from the centerline to the outer edges vertically
        FillFromCenterVertical,
        // will fill up from the top to the the bottom
        TopToBottom,
        // will fill up from the bottom to the the top
        BottomToTop,
    };
}
 
UENUM(BlueprintType)
namespace EProgressBarFillStyle
{
    enum Type : int
    {
        // a mask is used to paint the fill image
        Mask,
        // the fill image is scaled to the fill percentage
        Scale,
    };
}
 
class SProgressBar : public SLeafWidget
{
 
public:
    SLATE_BEGIN_ARGS(SProgressBar)
        : _Style( &FAppStyle::Get().GetWidgetStyle<FProgressBarStyle>("ProgressBar") )
        , _BarFillType(EProgressBarFillType::LeftToRight)
        , _BarFillStyle(EProgressBarFillStyle::Mask)
        , _Percent( TOptional<float>() )
        , _FillColorAndOpacity( FLinearColor::White )
        , _BorderPadding( FVector2D(0,0) )
        , _BackgroundImage(nullptr)
        , _FillImage(nullptr)
        , _MarqueeImage(nullptr)
        , _RefreshRate(2.0f)
        {
            _Visibility = EVisibility::SelfHitTestInvisible;
        }
 
        SLATE_STYLE_ARGUMENT( FProgressBarStyle, Style )
 
        
        SLATE_ARGUMENT( EProgressBarFillType::Type, BarFillType )
 
        
        SLATE_ARGUMENT( EProgressBarFillStyle::Type, BarFillStyle )
 
        
        SLATE_ATTRIBUTE( TOptional<float>, Percent )
 
        
        SLATE_ATTRIBUTE( FSlateColor, FillColorAndOpacity )
 
        
        SLATE_ATTRIBUTE( FVector2D, BorderPadding )
    
        
        SLATE_ARGUMENT(const FSlateBrush*, BackgroundImage)
    
        
        SLATE_ARGUMENT(const FSlateBrush*, FillImage)
    
        
        SLATE_ARGUMENT(const FSlateBrush*, MarqueeImage)
 
        
        SLATE_ARGUMENT(float, RefreshRate)
 
    SLATE_END_ARGS()
 
    
    SLATE_API void Construct(const FArguments& InArgs);
 
    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;
 
    SLATE_API void SetPercent(TAttribute< TOptional<float> > InPercent);
    
    SLATE_API void SetStyle(const FProgressBarStyle* InStyle);
    
    SLATE_API void SetBarFillType(EProgressBarFillType::Type InBarFillType);
 
    SLATE_API void SetBarFillStyle(EProgressBarFillStyle::Type InBarFillStyle);
    
    SLATE_API void SetFillColorAndOpacity(TAttribute< FSlateColor > InFillColorAndOpacity);
    
    SLATE_API void SetBorderPadding(TAttribute< FVector2D > InBorderPadding);
    
    SLATE_API void SetBackgroundImage(const FSlateBrush* InBackgroundImage);
    
    SLATE_API void SetFillImage(const FSlateBrush* InFillImage);
    
    SLATE_API void SetMarqueeImage(const FSlateBrush* InMarqueeImage);
    
private:
 
    void SetActiveTimerTickRate(float TickRate);
 
    void UpdateMarqueeActiveTimer();
 
    EActiveTimerReturnType ActiveTick(double InCurrentTime, float InDeltaTime);
 
    const FSlateBrush* GetBackgroundImage() const;
    const FSlateBrush* GetFillImage() const;
    const FSlateBrush* GetMarqueeImage() const;
 
private:
    
    const FProgressBarStyle* Style;
 
    TAttribute< TOptional<float> > Percent;
 
    EProgressBarFillType::Type BarFillType;
 
    EProgressBarFillStyle::Type BarFillStyle;
 
    const FSlateBrush* BackgroundImage;
 
    const FSlateBrush* FillImage;
 
    const FSlateBrush* MarqueeImage;
 
    TAttribute<FSlateColor> FillColorAndOpacity;
 
    TAttribute<FVector2D> BorderPadding;
 
    float MarqueeOffset;
 
    TWeakPtr<FActiveTimerHandle> ActiveTimerHandle;
 
    float CurrentTickRate;
 
    float MinimumTickRate;
};