ButtonWidget.h

Go to the documentation of this file.

// Copyright(c) Pixo Group. All Rights Reserved.
 
/*
 * Improve ButtonWidget
 * - added button highlight
 * - some properties can be editable outside (ButtonNameFontSize, ButtonBoundsWidth, ButtonBoundsColor...)
 * - integration of highlight with HintManager (HintManager->OnHintActivated)
 * - the change of properties displayed in the blueprint
 * - integration of highlight with StoryManager (StoryManager->OnNewStep, StoryManager->OnNewSubStep, StoryManager->OnStoryLoaded)
*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Blueprint/UserWidget.h"
#include "Components/Border.h"
#include "Components/Button.h"
#include "Components/TextBlock.h"
#include "ButtonWidget.generated.h"
 
UENUM()
enum class ButtonType
{
    BT_None,
    BT_CheckButton
};
 
class UButtonWidget;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FClickEventDelegate, FText, ButtonName);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FClickEventPtrDelegate, FText, ButtonName, int32, UID);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FClickEventSelfPtrDelegate, UButtonWidget*, ButtonObj);
 
UCLASS()
class PIXOCORE_API UButtonWidget : public UUserWidget
{
    GENERATED_BODY()
 
public:
#if WITH_EDITOR
    virtual void PostEditChangeChainProperty(FPropertyChangedChainEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
 
    virtual void NativeOnInitialized() override;
 
    virtual void NativePreConstruct() override;
 
    UFUNCTION(BlueprintCallable)
    void SetButtonName(const FText& Name);
 
    UFUNCTION(BlueprintCallable)
    const FText& GetButtonName();
 
    UFUNCTION(BlueprintCallable)
    virtual void ChangeButtonState(const bool bState);
 
    UFUNCTION(BlueprintCallable)
    bool GetState() const { return bCurrentState; } ;
 
    ButtonType GetType() const { return Type; };
 
    void RefreshWidgetStyle();
 
    void ActivateButtonHighlight();
    void ActivateButtonPulsationHighlight();
    void DeactivateButtonHighlight();
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable)
    void OnHintActivated(bool Activate);
 
private:
    void SwitchButtonColor(const bool bState);
 
    UFUNCTION()
    void ButtonReleased();
    UFUNCTION()
    void ButtonHovered();
    UFUNCTION()
    void OnUnHovered();
    UFUNCTION()
    void OnPressed();
    
    UFUNCTION()
    void NewStep(FStoryStep NewStep, bool IsForward);
    UFUNCTION()
    void NewSubStep(FStoryStep NewSubStep);
    UFUNCTION()
    void StoryLoaded();
 
#pragma region Variables
public:
    UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")
    FClickEventDelegate OnClickEventDelegate;
 
    UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")
    FClickEventPtrDelegate OnClickEventPtrDelegate;
 
    UPROPERTY(BlueprintAssignable, BlueprintCallable, Category = "Delegate")
    FClickEventSelfPtrDelegate OnClickEventSelfPtrDelegate;
 
    UPROPERTY(BlueprintReadWrite)
    UHintManager* HintManager;
 
    UPROPERTY(BlueprintReadWrite)
    UStoryManager* StoryManager;
 
    UPROPERTY(BlueprintReadWrite)
    FText ActiveStep;
 
    UPROPERTY(BlueprintReadWrite)
    FText ActiveSubStep;
 
    UPROPERTY(BlueprintReadWrite)
    bool bWidgetActiveOnStep;
 
protected:
    UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
    UBorder* ButtonHighlight;
 
    UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
    UBorder* ButtonBounds;
 
    UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
    UButton* Button;
 
    UPROPERTY(BlueprintReadOnly, meta = (BindWidget))
    UTextBlock* BtnName;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    float ButtonBoundsWidth = 2.f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor ButtonBoundsColor = FLinearColor::Black;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    float ButtonNameFontSize = 18.f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FText ButtonName = FText::FromString(TEXT("Text"));
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor ButtonNameColor = FLinearColor::White;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor DefaultButtonColor = FLinearColor(0.91f, 0.22f, 0.0f, 1.0f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor SelectedButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor DefaultHoveredButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor SelectedHoveredButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    FLinearColor PressedButtonColor = FLinearColor(0.25f, 0.6f, 0.0f, 1.0f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    USoundBase* SelectSound;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    USoundBase* HoverSound;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool bIsSelectable = true;
 
    ButtonType Type;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
    UWidgetAnimation* ButtonHighlightAnimation;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
    bool bIsPulsationHighlight = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
    float HighlightAnimationSpeed = 1.f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
    TArray<FText> HighlightActiveSteps;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
    TArray<FText> HighlightActiveSubSteps;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
    float ButtonHighlightWidth = 0.f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
    FLinearColor ButtonHighlightColor = FLinearColor(0.25f, 0.6f, 0.0f, 0.f);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Highlight")
    bool ActivateHighlightOnEachActiveStep = false;
 
private:
    bool bCurrentState;
 
#pragma endregion Variables
};