TouchInterfaceLayout.h

Go to the documentation of this file.

// Copyright 2024 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Object.h"
#include "VirtualShape/VirtualShapeDrawer.h"
#include "TouchInterfaceLayout.generated.h"
 
class UComponentLogic;
class ULayoutGroupComponent;
class UTouchInterfaceListener;
class STouchInterface;
class ULayoutComponent;
class UMaterialInterface;

UCLASS(BlueprintType, Blueprintable)
class TOUCHINTERFACE_API UTouchInterfaceLayout : public UObject
{
    GENERATED_BODY()
 
    UTouchInterfaceLayout();
    ~UTouchInterfaceLayout();
 
    virtual void BeginDestroy() override;
    
public:
    TSharedPtr<STouchInterface> GetLayoutWidget() const;
    void SetLayoutWidget(TSharedRef<STouchInterface> InLayoutWidget);
 
#if WITH_EDITOR
    virtual void OnBeginEdit();
    virtual void OnDesignerSizeChanged(const FIntPoint NewSize);
    virtual void OnEndEdit();
 
    virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
    virtual void ApplyLayout(TSharedRef<STouchInterface> TouchInterface);
 
    
    //LAYOUT
 
    // Display layout
    UFUNCTION(Category="Layout|Visibility", BlueprintCallable)
    virtual void ShowLayout();
    
    // Hide layout (Inputs remain active)
    UFUNCTION(Category="Layout|Visibility", BlueprintCallable)
    virtual void HideLayout();
 
    // Return true if layout widget is visible
    UFUNCTION(Category="Layout|Visibility", BlueprintCallable)
    virtual bool IsVisible();
 
    
    UFUNCTION(Category="Layout|Opacity", BlueprintCallable, BlueprintPure)
    float GetActiveOpacity() const { return ActiveOpacity; }
 
    //TODO: Notify widget that opacity has changed
    UFUNCTION(Category="Layout|Opacity", BlueprintCallable)
    void SetActiveOpacity(const float Opacity) { ActiveOpacity = Opacity; }
 
    UFUNCTION(Category="Layout|Opacity", BlueprintCallable, BlueprintPure)
    float GetInactiveOpacity() const { return InactiveOpacity; }
 
    UFUNCTION(Category="Layout|Opacity", BlueprintCallable)
    void SetInactiveOpacity(const float Opacity) { InactiveOpacity = Opacity; }
 
    
    UFUNCTION(Category="Layout|Scale", BlueprintCallable, BlueprintPure)
    virtual float GetLayoutScale() const { return LayoutScale; }
 
    //Set the global scale of layout
    UFUNCTION(Category="Layout|Scale", BlueprintCallable)
    virtual void SetLayoutScale(const float NewScale);
 
    //Reset layout to default layout
    UFUNCTION(Category="Layout|Scale", BlueprintCallable)
    void ResetToDefault();
 
    UFUNCTION(Category="Layout|Utility", BlueprintCallable)
    void Rebuild();
    
    
    //COMPONENTS
 
    //TODO: Create component decorator automatically except if class is filled. Output component decorator.
 
    //TODO: Group support decorator and input
    UFUNCTION(Category="Component", BlueprintCallable)
    virtual ULayoutGroupComponent* AddGroup(const FName DesiredName, const FVector2D Position);
 
    //TODO: Create component decorator automatically except if class is filled. Output component decorator.

    UFUNCTION(Category="Component", BlueprintCallable)
    virtual ULayoutComponent* AddTouchInput(const FName DesiredName, const FVector2D Position, FVector2D Size, const TSubclassOf<UComponentLogic> LogicClass, UComponentLogic*& OutLogic);
 
    //TODO: Create component decorator automatically except if class is filled. Output component decorator.

    UFUNCTION(Category="Component", BlueprintCallable)
    virtual ULayoutComponent* AddTouchInputInGroup(const FName DesiredName, const FVector2D Offset, FVector2D Size, TSubclassOf<UComponentLogic> LogicClass, const FName GroupName, UComponentLogic*& OutLogic);
 
    //TODO: Create Touch Input Function, then make function to add instance in layout or group. More simpler!
    
    //Remove component from layout (Warning: Include Children)
    UFUNCTION(Category="Component", BlueprintCallable)
    virtual void RemoveComponent(class ULayoutComponent* Component);
 
    //Remove component from layout (Warning: Include Children)
    UFUNCTION(Category="Component", BlueprintCallable)
    virtual void RemoveComponentByName(const FName ComponentName);
 
    // Displays component in layout
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void ShowComponent(const FName Name);
 
    // Hide component in layout
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void HideComponent(const FName Name);
 
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void ShowComponentByNames(const TArray<FName> Names);
 
    // Hide all components in layout
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void HideComponentByNames(const TArray<FName> Names);
    
    // Displays all components in layout
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void ShowAllComponents();
 
    // Hide all components in layout
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void HideAllComponents();
 
    // Displays all components except the named one
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void ShowAllExcept(const FName Name);
 
    // Hide all components except the named one
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void HideAllExcept(const FName Name);
 
    // Displays all components except the named ones
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void ShowAllExceptNamedOnes(const TArray<FName> Names);
 
    // Hide all components except the named ones
    UFUNCTION(Category="Component|Visibility", BlueprintCallable)
    virtual void HideAllExceptNamedOnes(const TArray<FName> Names);
 
    
    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    virtual bool ContainComponent(const ULayoutComponent* Component, const bool bRecursively = false);

    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    virtual bool ContainComponentByName(const FName ComponentName, const bool bRecursively = false);

    UFUNCTION(Category="Component|Utility", BlueprintCallable)
    virtual bool GetComponentByNames(TArray<ULayoutComponent*>& Components, const TArray<FName> Names, const bool bRecursively = false);
    
    UFUNCTION(Category="Component|Utility", BlueprintCallable)
    virtual bool GetAllComponents(TArray<ULayoutComponent*>& Components, const bool bRecursively = false);

    UFUNCTION(Category="Component|Utility", BlueprintCallable)
    virtual ULayoutComponent* GetComponentByName(const FName Name, const bool bRecursively = false) const;

    UFUNCTION(Category="Component|Utility", BlueprintCallable)
    virtual bool GetComponentsByLogicClass(TSubclassOf<UComponentLogic> LogicClass, TArray<ULayoutComponent*>& Components, const bool bRecursively = false);

    //UFUNCTION(Category="Component|Utility", BlueprintCallable)
    //virtual bool GetComponentsPressed(TArray<UTouchInputComponent*>& Components, const bool bRecursively = false);
 
    // Returns index of component
    UFUNCTION(Category="Component|Utility", BlueprintCallable, BlueprintPure)
    int32 GetIndexOfComponent(ULayoutComponent* Component);

    UFUNCTION(Category="Component|Utility", BlueprintCallable)
    virtual bool GetAllComponentName(TArray<FName>& Names, const bool bRecursively = false);
 
    //TODO: Function to modify retainer settings
    
    // Touch Interface Layout tree
    UPROPERTY()
    TArray<TObjectPtr<ULayoutComponent>> Children;
 
    UPROPERTY(Category="Opacity", EditAnywhere, BlueprintReadOnly)
    uint8 bFade:1;
    
    UPROPERTY(Category="Opacity", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, ClampMax=1.0f, UIMin=0.0f, UIMax=1.0f))
    float ActiveOpacity;
 
    // Opacity (0.0 - 1.0) of all components while touch interface is inactive (no interaction)
    UPROPERTY(Category="Opacity", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="bFade==true", EditConditionHides), meta=(ClampMin=0.0f, ClampMax=1.0f, UIMin=0.0f, UIMax=1.0f))
    float InactiveOpacity;
 
    // Speed at which inactive opacity is reached
    UPROPERTY(Category="Opacity", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="bFade==true", EditConditionHides), meta=(ClampMin=0.1f, UIMin=0.1f))
    float InactiveLerpRate;
    
 
    // How long after user interaction will all components fade out to Inactive Opacity
    UPROPERTY(Category="Reset/Recenter", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float TimeUntilDeactivated;

    UPROPERTY(Category="Reset/Recenter", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float TimeUntilReset;
    

    UPROPERTY(Category="Delay", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float ActivationDelay;

    UPROPERTY(Category="Delay", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.016f, UIMin=0.016f))
    float StartupDelay;

    UPROPERTY(Category="Optimization", EditAnywhere)
    uint8 bRetainRender:1;
 
    // Should this widget redraw the contents it has every time it receives an invalidation request
    UPROPERTY(Category="Optimization", EditAnywhere, meta=(EditCondition="bRetainRender==true"))
    uint8 bRenderOnInvalidation:1;
 
    // Should this widget redraw the contents it has every time the phase occurs
    UPROPERTY(Category="Optimization", EditAnywhere, meta=(EditCondition="bRetainRender==true"))
    uint8 bRenderOnPhase:1;

    UPROPERTY(Category="Optimization", EditAnywhere, meta=(EditCondition="bRetainRender==true && bRenderOnPhase==true"))
    int32 Phase;

    UPROPERTY(Category="Optimization", EditAnywhere, meta=(EditCondition="bRetainRender==true && bRenderOnPhase==true"))
    int32 PhaseCount;

    UPROPERTY(Category="Effect", EditAnywhere, meta=(EditCondition="bRetainRender==true && bRenderOnPhase==true"))
    TObjectPtr<UMaterialInterface> EffectMaterial;
 
    //The texture sampler parameter of the EffectMaterial, that we'll set to the render target.
    UPROPERTY(Category="Effect", EditAnywhere, meta=(EditCondition="bRetainRender==true && bRenderOnPhase==true"))
    FName TextureParameter;
    
    
    UPROPERTY(Category="Advanced", EditAnywhere)
    uint8 bAllScreenGesture:1;
 
    // Whether or not shape drawing is detected on all screen surface.
    UPROPERTY(Category="Advanced", EditAnywhere)
    uint8 bAllScreenShapeDrawing:1;
 
    //Drawer class used to draw the user's drawing and shape.
    UPROPERTY(Category="Advanced", EditAnywhere)
    TSubclassOf<UVirtualShapeDrawer> ShapeDrawerClass;
    
    //Enable or disable opacity modification in the layout modifier widget.
    UPROPERTY(Category="Layout Modifier", EditAnywhere)
    uint8 bAllowOpacityModification:1;
 
    //Enable or disable modification of retainer parameters in the layout modifier widget.
    UPROPERTY(Category="Layout Modifier", EditAnywhere)
    uint8 bAllowRetainerWidgetModification:1;
 
 
private:
    TSharedPtr<STouchInterface> LayoutWidget;
 
    UPROPERTY(Transient)
    TObjectPtr<UTouchInterfaceLayout> TouchInterfaceLayout;
 
    float LayoutScale;
};