ProgressBarLayer.h

Go to the documentation of this file.

// Copyright 2025 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "ComponentDecorator.h"
#include "ProgressBarLayer.generated.h"
 
class SProgressBarLayer;
class UMaterialInterface;
class UMaterialInstanceDynamic;
 
UENUM(BlueprintType)
enum class EProgressFillType : uint8
{
    LeftToRight,
    RightToLeft,
    FromCenter,
    FromCenterHorizontal,
    FromCenterVertical,
    TopToBottom,
    BottomToTop,
    Clockwise,
    CounterClockwise,
    CircularCenter
};
 
//TODO: Show this fill type only for linear progress bar
UENUM(BlueprintType)
enum class EProgressFillStyle : uint8
{
    Scale,

    Masked,
 
    //Use material to fill geometry
    Material,
    
    //Draw lines
    Draw,
};
 
UCLASS()
class TOUCHINTERFACE_API UProgressBarLayer : public UComponentDecorator
{
    GENERATED_BODY()
 
public:
    UProgressBarLayer();
 
    virtual void BeginDestroy() override;
 
    virtual void Initialize(TObjectPtr<ULayoutComponent> Component) override;
 
    virtual TSharedRef<SWidget> CreateWidgetInstance() override;
 
#if WITH_EDITOR
    virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
    
    virtual void SynchronizeProperties() override;
#endif
    
    UFUNCTION(Category="ProgressBar", BlueprintCallable, BlueprintPure)
    virtual float GetPercent() { return Percent; }
 
    UFUNCTION(Category="ProgressBar", BlueprintCallable)
    virtual void SetPercent(const float InPercent);
 
    UFUNCTION(Category="ProgressBar", BlueprintCallable)
    virtual float AddPercent(const float Value);
 
    UFUNCTION(Category="ProgressBar", BlueprintCallable)
    virtual float SubtractPercent(const float Value);
 
    //TODO: Set type, style
 
private:
 
public:
    //Percent (0 = empty to 1 = full)
    UPROPERTY(Category="ProgressBar", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(ClampMin=0.0f, ClampMax=1.0f))
    float Percent;
 
    // Fill style of progress bar
    UPROPERTY(Category="ProgressBar|Style", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    EProgressFillStyle FillStyle;
 
    // Fill type of progress bar
    UPROPERTY(Category="ProgressBar|Style", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(EditCondition="FillStyle!=EProgressFillStyle::Material", EditConditionHides))
    EProgressFillType FillType;
    
    // Material used for fill bar
    UPROPERTY(Category="ProgressBar|Style", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(EditCondition="FillStyle==EProgressFillStyle::Material", EditConditionHides))
    FSoftObjectPath FillMaterial;
 
    // Color of fill bar
    UPROPERTY(Category="ProgressBar|Style", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    FLinearColor FillColor;
    
 
    // Start angle value in degree
    UPROPERTY(Category="ProgressBar|Style|Circular", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(ClampMin=0.0f, ClampMax=360.0f))
    float StartAngle;
 
    // End angle value in degree
    UPROPERTY(Category="ProgressBar|Style|Circular", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(ClampMin=0.0f, ClampMax=360.f))
    float EndAngle;
 
    // Rotation of circular progress
    UPROPERTY(Category="ProgressBar|Style|Circular", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    float AngularOffset;
    
    // Radius of fill bar
    UPROPERTY(Category="ProgressBar|Style|Circular", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(ClampMin=0.0f, ClampMax=1.0f))
    float Radius;
 
    // Thickness of fill bar
    UPROPERTY(Category="ProgressBar|Style|Circular", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    float Thickness;
 
    // Precision of circle
    UPROPERTY(Category="ProgressBar|Style|Circular", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    int32 CircleResolution;
    
 
    // If enabled, add background under fill bar
    UPROPERTY(Category="ProgressBar|Style|Background", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bDrawBackground:1;
 
    // Slate brush for background bar
    UPROPERTY(Category="ProgressBar|Style|Background", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(EditCondition="bDrawBackground==true", EditConditionHides))
    FSlateBrush BackgroundBrush;
    
    // Color of background bar
    UPROPERTY(Category="ProgressBar|Style|Background", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(EditCondition="bDrawBackground==true", EditConditionHides))
    FLinearColor BackgroundColor;
 
    // Radius of background bar
    UPROPERTY(Category="ProgressBar|Style|Background|Circular", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(ClampMin=0.0f, ClampMax=1.0f), meta=(EditCondition="bDrawBackground==true", EditConditionHides))
    float BackgroundRadius;
 
    // Thickness of background bar
    UPROPERTY(Category="ProgressBar|Style|Background|Circular", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"), meta=(EditCondition="bDrawBackground==true", EditConditionHides))
    float BackgroundThickness;
    
    
    // If enabled, use custom material instead of pre-build material
    UPROPERTY(Category="ProgressBar|Style", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bOverrideMaterial:1;
 
    //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;
 
    
 
    // Whether or not, the anti-aliasing is used for drawing
    UPROPERTY(Category="ProgressBar|Advanced|Optimization", EditAnywhere, BlueprintReadOnly, meta=(AllowPrivateAccess="true"))
    uint8 bAntiAliasing:1;
 
private:
    UPROPERTY()
    TObjectPtr<UMaterialInstanceDynamic> MaterialInstance;
 
    TSharedPtr<SProgressBarLayer> ProgressBarWidget;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(Transient)
    TObjectPtr<UMaterialInterface> PreviewMaterial;
#endif
};