SProgressBarLayer.h

Go to the documentation of this file.

// Copyright 2025 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Widgets/SLeafWidget.h"
 
class UMaterialInstanceDynamic;

class TOUCHINTERFACE_API SProgressBarLayer : public SLeafWidget
{
public:
    enum class EProgressFillType
    {
        LeftToRight,
        RightToLeft,
        FromCenter,
        FromCenterHorizontal,
        FromCenterVertical,
        TopToBottom,
        BottomToTop,
        Clockwise,
        CounterClockwise,
        CircularFromCenter
    };
 
    enum class EProgressFillStyle
    {
        Scale,
        Masked,
        Material,
        Draw
    };
    
    SLATE_BEGIN_ARGS(SProgressBarLayer)
        : _Percent(0.0f)
        , _FillStyle(EProgressFillStyle::Scale)
        , _FillType(EProgressFillType::BottomToTop)
        , _StartAngle(0.0f)
        , _EndAngle(360.0f)
        , _AngularOffset(0.0f)
        , _FillColor(FLinearColor(0.0f, 0.5f, 1.0f, 1.0f))
        , _Radius(0.8f)
        , _Thickness(4.0f)
        , _CircleResolution(50)
        , _bDrawBackground(true)
        , _BackgroundColor(FLinearColor(0.1f, 0.1f, 0.1f, 0.6f))
        , _BackgroundRadius(0.8f)
        , _BackgroundThickness(4.0f)
        , _AntiAliasing(true)
        {
        }
        SLATE_ARGUMENT(float, Percent)
        SLATE_ARGUMENT(EProgressFillStyle, FillStyle)
        SLATE_ARGUMENT(EProgressFillType, FillType)
        SLATE_ARGUMENT(float, StartAngle)
        SLATE_ARGUMENT(float, EndAngle)
        SLATE_ARGUMENT(float, AngularOffset)
        SLATE_ARGUMENT(FSlateBrush, Brush)
        SLATE_ARGUMENT(FLinearColor, FillColor)
        SLATE_ARGUMENT(float, Radius)
        SLATE_ARGUMENT(float, Thickness)
        SLATE_ARGUMENT(int32, CircleResolution)
        SLATE_ARGUMENT(bool, bDrawBackground)
        SLATE_ARGUMENT(FSlateBrush, BackgroundBrush)
        SLATE_ARGUMENT(FLinearColor, BackgroundColor)
        SLATE_ARGUMENT(float, BackgroundRadius)
        SLATE_ARGUMENT(float, BackgroundThickness)
        SLATE_ARGUMENT(bool, AntiAliasing)
 
    SLATE_END_ARGS()
 
    SProgressBarLayer();

    void Construct(const FArguments& InArgs);
 
    virtual FVector2D ComputeDesiredSize(float LayoutScaleMultiplier) const override;
 
    virtual int32 OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
    
private:
    virtual void DrawFillScale(const FGeometry& AllottedGeometry, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle) const;
 
    virtual void DrawFillMasked(const FGeometry& AllottedGeometry, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle) const;
 
    virtual void DrawFillMaterial(const FGeometry& AllottedGeometry, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle) const;
    
    virtual void Draw(const FGeometry& AllottedGeometry, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle) const;
 
    void AddSliderPointToArray(TArray<FVector2D>& SliderPoints, const bool bIsUnique, const FVector2D& SliderPoint) const;
 
public:
    void SetPercent(const float Value);
    
    void SetMaterial(TObjectPtr<UMaterialInstanceDynamic> Material);
 
    void SetFillStyle(const EProgressFillStyle NewStyle) { FillStyle = NewStyle; }
 
    void SetFillType(const EProgressFillType NewType) { FillType = NewType; }
 
    void SetStartAngle(const float Value) { StartAngle = Value; }
 
    void SetEndAngle(const float Value) { EndAngle = Value; }
 
    void SetAngularOffset(const float Value) { AngularOffset = Value; }
 
    void SetFillColor(const FLinearColor Color) { FillColor = Color; }
 
    void SetRadius(const float Value) { Radius = Value; }
 
    void SetThickness(const float Value) { Thickness = Value; }
 
    void SetBackgroundVisibility(const bool bVisible) { bDrawBackground = bVisible; }
 
    void SetBackgroundColor(const FLinearColor Color) { BackgroundColor = Color; }
    
    void SetBackgroundRadius(const float Value) { BackgroundRadius = Value; }
 
    void SetBackgroundThickness(const float Value) { BackgroundThickness = Value; }
    
    void SetCircleResolution(const int32 Value) { CircleResolution = Value; }
 
    void EnableAntiAliasing(const bool bEnable) { bAntiAliasing = bEnable; }
 
private:
    //Percent (0 = empty to 1 = full)
    float Percent;
 
    // Fill style of progress bar
    EProgressFillStyle FillStyle;
 
    // Fill type of progress bar
    EProgressFillType FillType;
 
    // Start angle value in degree
    float StartAngle;
 
    // End angle value in degree
    float EndAngle;
 
    // Rotation of circular progress
    float AngularOffset;
 
    FSlateBrush Brush;
    
    // Color of fill bar
    FLinearColor FillColor;
 
    // Radius of fill bar
    float Radius;
 
    // Thickness of fill bar
    float Thickness;
    
 
    // If enabled, add background under fill bar
    uint8 bDrawBackground:1;
 
    // Slate brush for background bar
    FSlateBrush BackgroundBrush;
    
    // Color of background bar
    FLinearColor BackgroundColor;
 
    // Radius of background bar
    float BackgroundRadius;
 
    // Thickness of background bar
    float BackgroundThickness;
 
    //TODO: Material property: Smoothness, thickness, division, etc
    
    //UPROPERTY(Category="Progress Bar Layer|Advanced", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    //uint8 bUseDivision:1;
    
    //UPROPERTY(Category="Progress Bar Layer|Advanced", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(EditCondition="bUseDivision==true", EditConditionHides))
    //int32 Division;
 
    // Precision of circle
    int32 CircleResolution;
 
    // Whether or not, the anti-aliasing is used for drawing
    uint8 bAntiAliasing:1;
};