WSBase.h

/* 
* Copyright (c) 2021 THEIA INTERACTIVE.  All rights reserved.
*
* Website: https://widgetstudio.design
* Documentation: https://docs.widgetstudio.design
* Support: marketplace@theia.io
* Marketplace FAQ: https://marketplacehelp.epicgames.com
*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Blueprint/UserWidget.h"
 
/* Hierarchical Includes - Do Not Remove */
#include "Types/WSEnums.h"
#include "WSFunctionLibrary.h"
#include "WSSubsystem.h"
 
#include "WSBase.generated.h"
 
class UWidgetStudioBase;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FWSBaseHoverStateDelegate, UWidgetStudioBase*, CallingWidget, bool, bIsHovering);
 
UCLASS(Blueprintable, HideCategories="Developer")
class WIDGETSTUDIORUNTIME_API UWidgetStudioBase : public UUserWidget
{
    GENERATED_BODY()
 
protected:
    
    /*
     * Initializes and sets up the initial Widget Styling.
     * - This function should be overriden in a child widget.
     * - This function should be placed at the end of the RebuildWidget() function
     */
    virtual void InitializeStyling();
 
    /*
     * Updates the Widget styling. This is primarily to make sure that any styling updates are kept dynamic.
     * - This function should be overriden in a child widget.
     * - This function should be placed and used when deemed necessary, for example, within the SynchronizeProperties() function.
     * - Make sure that static (non-updating) styling is not placed here and is instead placed in the InitializeStyling() function
     * - Do NOT call on tick or OnPaint.
     */
    virtual void UpdateStyling();
 
    /* Used for event passthroughs */
    virtual void NativeOnMouseEnter(const FGeometry& InGeometry, const FPointerEvent& InMouseEvent) override;
    virtual void NativeOnMouseLeave(const FPointerEvent& InMouseEvent) override;
    virtual void NativeOnMouseCaptureLost(const FCaptureLostEvent& CaptureLostEvent) override;
 
public:
 
    // Bindings
    
    UPROPERTY(BlueprintAssignable, Category = "Widget Studio|Event")
    FWSBaseHoverStateDelegate OnHoverStateChanged;
 
    // Properties
 
    UPROPERTY(EditDefaultsOnly, Category = "Developer")
    bool bCanOverrideDimensions = true;
 
    UPROPERTY(EditDefaultsOnly, Category = "Developer")
    bool bCanOverrideBorderRadius = true;
 
    UPROPERTY(EditAnywhere, Category = "Developer", Meta = (ClampMin = "0", UIMin = "0"))
    FVector2D MinimumDimensions = FVector2D(50, 7);
    
    UPROPERTY(EditAnywhere, Category = "Developer")
    bool bDisablePainting = false;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio", AdvancedDisplay)
    float AnimationTime = 7;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio", AdvancedDisplay)
    ESizeModifier SizeModifier = ESizeModifier::Regular;
    
    UPROPERTY(EditAnywhere, Category = "Widget Studio", AdvancedDisplay, Meta = (ClampMin = "0", UIMin = "0", AxisName="Width", YAxisName="Height", EditCondition="bCanOverrideDimensions", EditConditionHides))
    FVector2D OverrideDimensions = FVector2D(0, 0);
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio", AdvancedDisplay, Meta = (ClampMin = "-1", UIMin = "-1", EditCondition="bCanOverrideBorderRadius", EditConditionHides))
    int32 OverrideBorderRadius = -1;
 
    
    // Helper Functions
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio")
    FVector2D GetDimensions() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio")
    int32 GetBorderRadius() const;
 
 
    // Modifier Functions
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Advanced")
    void ForceStyleUpdate();
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Advanced")
    void SetSizeModifier(ESizeModifier InSizeModifier);
};