LayoutModifier.h

Go to the documentation of this file.

// Copyright 2025 Lost in Game Studio. All Rights Reserved
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/Widget.h"
#include "LayoutModifier.generated.h"
 
class STouchInterfaceLayoutPreviewer;
struct FLayoutSaveData;
class UTouchInterfaceLayout;
class SLayoutModifier;
class ULayoutComponent;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnComponentEditedEvent, FName, Name, FVector2D, Location);

UCLASS()
class TOUCHINTERFACE_API ULayoutModifier : public UWidget
{
    GENERATED_BODY()
 
public:
    ULayoutModifier();
 
    //Begin UWidget
    virtual void SynchronizeProperties() override;
 
protected:
    virtual TSharedRef<SWidget> RebuildWidget() override;
 
public:
#if WITH_EDITOR
    virtual const FText GetPaletteCategory() override;
    virtual void OnBeginEditByDesigner() override;
    virtual void OnEndEditByDesigner() override;
    virtual void OnDesignerChanged(const FDesignerChangedEventArgs& EventArgs) override;
#endif
    //End UWidget
 
    //Begin UVisual
    virtual void ReleaseSlateResources(bool bReleaseChildren) override;
    //End UVisual

    UFUNCTION(Category="Layout Modifier", BlueprintCallable)
    void SetPreviewEnabled(const bool bEnabled);
 
    // Returns true if a preview of the layout is displayed by the layout modifier.
    UFUNCTION(Category="Layout Modifier", BlueprintCallable)
    bool IsPreviewEnabled() const;
 
    // Activates or deactivates the function for changing the position of a component with the finger.
    UFUNCTION(Category="Layout Modifier", BlueprintCallable)
    void SetPositioningWithTouchEnabled(const bool bEnablePositioning) const;
 
    // Activates or deactivates the function for resizing a component with the finger.
    UFUNCTION(Category="Layout Modifier", BlueprintCallable)
    void SetResizingWithTouchEnabled(const bool bEnableResizing) const;
 
    //TODO: With slider or input
    //Make a function to list all virtual input and make button to navigate (or bind on virtual input selected)
    //Allow dev to adjust order by type, name or define order with name

    UFUNCTION(Category="Layout Modifier|Save", BlueprintCallable)
    bool Edit(UTouchInterfaceLayout* Layout);

    UFUNCTION(Category="Layout Modifier|Save", BlueprintCallable)
    bool EditSave(UTouchInterfaceLayout* LayoutReference, const int32 UserIndex, const int32 ConfigIndex, UTouchInterfaceLayout*& OutEditedLayout);
    
    UFUNCTION(Category="Layout Modifier|Save", BlueprintCallable)
    bool SaveLayout(const int32 UserIndex, const int32 ConfigIndex) const;
 
    //Load touch interface modifications from save file
    //UFUNCTION(Category="Layout Modifier|Save", BlueprintCallable)
    //bool LoadSavedLayout(const int32 UserIndex, const int32 ConfigIndex);
    
    //Get configuration in save file that contain touch interface modification
    UFUNCTION(Category="Layout Modifier|Load", BlueprintCallable)
    bool GetSavedLayoutData(const int32 UserIndex, const int32 ConfigIndex, FLayoutSaveData& Configuration);
    
 
    // Reset configuration to origin (layout reference)
    UFUNCTION(Category="Layout Modifier|Utility", BlueprintCallable)
    void ResetToDefault(UTouchInterfaceLayout* LayoutReference, const int32 UserIndex, const int32 ConfigIndex, const bool bSaveToDisk);
 
    // Generate component name array
    UFUNCTION(Category="Layout Modifier|Utility", BlueprintCallable, BlueprintPure)
    TArray<FName> GetListOfComponent(const int32 UserIndex, const int32 ConfigIndex) const;

    UFUNCTION(Category="Layout Modifier|Utility", BlueprintCallable, BlueprintPure)
    FName GetSelectedComponentName() const;
 
    // Clear selection
    UFUNCTION(Category="Layout Modifier|Utility", BlueprintCallable)
    void ClearSelection();
    
 
    //Get touch interface opacity value (edited by layout modifier)
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable, BlueprintPure)
    void GetTouchInterfaceOpacity(float& InactiveOpacity, float& ActiveOpacity);
 
    //Return original touch interface opacity (opacity value filled in touch interface layout editor)
    //UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable, BlueprintPure)
    //void GetTouchInterfaceDesignOpacity(float& InactiveOpacity, float& ActiveOpacity);
 
    //Set touch interface opacity value
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable)
    void SetTouchInterfaceOpacity(const float InactiveOpacity, const float ActiveOpacity);

    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable, BlueprintPure)
    FVector2D GetComponentLocation(const FName InputName);
 
    //Return original location of component (location value filled in touch interface layout editor)
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable, BlueprintPure)
    FVector2D GetComponentDesignLocation(const FName ComponentName);
 
    //Set component location
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable)
    void SetComponentLocation(const FName InputName, const FVector2D NewOffset);
 
    //Return max offset from origin
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable)
    FVector4f GetComponentMaxOffset(const FName ComponentName);

    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable, BlueprintPure)
    FVector2D GetComponentSize(const FName InputName);
 
    //Return original size of component (Size value filled in touch interface layout editor)
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable, BlueprintPure)
    FVector2D GetComponentDesignSize(const FName ComponentName);
 
    //Set component size
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable)
    void SetComponentSize(const FName InputName, FVector2D NewSize);
 
    //Return max size scale
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable)
    FVector2D GetComponentMaxSize(const FName ComponentName);
 
    //Return layout asset that correspond to modifications in save file at config index 
    UFUNCTION(Category="Layout Modifier|Property", BlueprintCallable)
    UTouchInterfaceLayout* GetLayoutAssetFromSave(int32 UserIndex, int32 ConfigIndex);
 

    UFUNCTION(Category="Layout Modifier|Preview", BlueprintCallable)
    void SetPositioningPreviewEnabled(const bool bEnable) const;
    
    UFUNCTION(Category="Layout Modifier|Preview", BlueprintCallable)
    void SetDesignLocationPreviewEnabled(const bool bEnable) const;
 
private:
    UFUNCTION()
    void HandleOnComponentSelected(FName Name, FVector2D Location);
 
    UFUNCTION()
    void HandleOnComponentLocationEdited(FName Name, FVector2D Delta);
 
    UFUNCTION()
    void HandleOnComponentSizeEdited(FName Name, FVector2D Delta);
    
public:
    UPROPERTY(Category="Settings", BlueprintReadWrite, EditAnywhere)
    uint8 bUseTouchForPositioning:1;

    UPROPERTY(Category="Settings", BlueprintReadWrite, EditAnywhere)
    uint8 bUseTouchForSizing:1;
 
    UPROPERTY(Category="Settings", BlueprintReadOnly, EditAnywhere, meta=(ClampMin=0.1f, ClampMax=1.0f))
    float ResizeSensibility;
 
    UPROPERTY(Category="Settings|Visual", BlueprintReadOnly, EditAnywhere)
    uint8 bDrawPositioningBrush:1;
    
    // Brush used to draw max offset from origin for positioning
    UPROPERTY(Category="Settings|Visual", BlueprintReadOnly, EditAnywhere, meta=(EditCondition="bDrawPositioningBrush"))
    FSlateBrush PositioningBrush;
 
    UPROPERTY(Category="Settings|Visual", BlueprintReadOnly, EditAnywhere)
    uint8 bDrawDesignCenter:1;
 
    UPROPERTY(Category="Settings|Visual", BlueprintReadOnly, EditAnywhere, meta=(EditCondition="bDrawDesignCenter"))
    FSlateBrush DesignLocationBrush;
 
    
    UPROPERTY(Category="Configurator|Event", BlueprintAssignable)
    FOnComponentEditedEvent OnComponentSelected;
 
    UPROPERTY(Category="Configurator|Event", BlueprintAssignable)
    FOnComponentEditedEvent OnComponentLocationEdited;
 
    UPROPERTY(Category="Configurator|Event", BlueprintAssignable)
    FOnComponentEditedEvent OnComponentSizeEdited;
    
protected:
    TSharedPtr<STouchInterfaceLayoutPreviewer> LayoutModifierWidget;
 
private:
    FVector2D GeometrySize;
    float CurrentDPIScale;
    
    float CurrentActiveOpacity;
    float CurrentInactiveOpacity;
 
    FName SelectedComponentName;
 
    UPROPERTY()
    ULayoutComponent* ComponentSelected;
 
    UPROPERTY()
    TObjectPtr<UTouchInterfaceLayout> EditedLayout;
};