VirtualInputEvent.h

Go to the documentation of this file.

// Copyright 2022 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "TouchInterface/VirtualControlSetup.h"
#include "UObject/Object.h"
#include "Layout/Geometry.h"
#include "Input/Events.h"
#include "VirtualInputEvent.generated.h"
 
class UTouchInterfaceSubsystem;
class SVirtualControl;
class ULocalPlayer;
 
DEFINE_LOG_CATEGORY_STATIC(LogVirtualInputEvent, Log, All)
 
//Base class to extends the functionality of virtual input
UCLASS(Abstract, Blueprintable, BlueprintType)
class TOUCHINTERFACE_API UVirtualInputEvent : public UObject
{
    GENERATED_BODY()
 
public:
    UVirtualInputEvent();
    
    // Called when virtual input is initialized 
    UFUNCTION(Category="Virtual Input Event", BlueprintNativeEvent)
    void Initialize();
 
    UFUNCTION(Category="Virtual Input Event", BlueprintNativeEvent)
    void Deinitialize();
    
    virtual bool IsCompatible(EControlType InputType) const { return true; }
 
    bool ShouldTick() const { return bShouldTick; }
    
    void SetButtonName(const FName Name) { LinkedButtonName = Name; }
    void SetOuter(UWorld* Outer) { WorldContext = Outer; }
    void AssignLocalPlayer(ULocalPlayer* Player, TSharedPtr<SVirtualControl> Widget);
    
    // Called when user's finger begin touch virtual control
    UFUNCTION(Category="Virtual Input Event", BlueprintNativeEvent)
    void OnTouchBegin(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime);
 
    // Called when user's finger moves inside the virtual control
    UFUNCTION(Category="Virtual Input Event", BlueprintNativeEvent)
    void OnTouchMove(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime, const float PressDuration);
 
    // Called when user's finger stops touching the virtual control
    UFUNCTION(Category="Virtual Input Event", BlueprintNativeEvent)
    void OnTouchEnd(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime, const float PressDuration);
 
    // Called by Virtual Control Tick. Normally, Virtual Control tick once every frame but it's not guaranteed
    UFUNCTION(Category="Virtual Input Event", BlueprintNativeEvent)
    void OnTick(const FGeometry& Geometry, const double CurrentTime, const float DeltaTime);
 
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable, BlueprintPure)
    APawn* GetPawn();
 
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable, BlueprintPure)
    APlayerController* GetPlayerController();
    
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable, BlueprintPure)
    FName GetButtonName();

    UFUNCTION(Category="Virtual Input Event", BlueprintCallable, BlueprintPure)
    void GetVisualLayers(TArray<FVisualLayer>& VisualLayers);
 
    // Get a reference of visual layer data for the virtual control that own this virtual control event
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable, BlueprintPure)
    TArray<FVisualLayer>& GetVisualLayersRef();
 
    // Get a copy of visual layer by name
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable, BlueprintPure)
    bool GetVisualLayerByName(const FName Name, FVisualLayer& VisualLayer);
 
    // Get a reference of visual layer by name
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable, BlueprintPure)
    FVisualLayer& GetVisualLayerRefByName(const FName Name);

    UFUNCTION(Category="Virtual Input Event", BlueprintCallable)
    void SetVisualLayers(TArray<FVisualLayer> VisualLayers);

    UFUNCTION(Category="Virtual Input Event", BlueprintCallable)
    void SetVisualLayer(const FVisualLayer& VisualLayer, const FName Name = NAME_None);
    
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable)
    FName AddNewLayer(FName LayerName, FVisualLayer Visual);

    UFUNCTION(Category="Virtual Input Event", BlueprintCallable)
    FName InsertLayerAt(FName LayerName, const int32 Index, FVisualLayer Visual);
 
    //TODO: Insert new layer before layer
    //TODO: Insert new layer after layer
 
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable)
    void RemoveLayer(const FName LayerName);
 
    // Get a copy of virtual input data
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable, BlueprintPure)
    bool GetVirtualInput(FVirtualControl& VirtualInput);
 
    //TODO: Make utilities function for visual layer like SetMaterialParameter, SetBrushFromTexture, SetBrushFromMaterial, etc.
    //TODO: Set progress bar value, Set flipbook value, Set Progress Bar Speed, Set Flipbook speed, etc.
    
    virtual UWorld* GetWorld() const override;
 
    UTouchInterfaceSubsystem* GetTouchInterfaceSubsystem();
 
    ULocalPlayer* GetLocalPlayer() { return LocalPlayer; }
    TSharedPtr<SVirtualControl> GetVirtualControlWidget();
 
protected:
    virtual void Initialize_Implementation() {}
    virtual void Deinitialize_Implementation();
    virtual void OnTouchBegin_Implementation(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime) {}
    virtual void OnTouchMove_Implementation(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime, const float PressDuration) {}
    virtual void OnTouchEnd_Implementation(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime, const float PressDuration) {}
    virtual void OnTick_Implementation(const FGeometry& Geometry, const double CurrentTime, const float DeltaTime) {}
 
    UFUNCTION(Category="Virtual Input Event", BlueprintCallable)
    void SetTickEnabled(const bool bEnable) { bShouldTick = bEnable; }
    
private:
    UPROPERTY(Category="Settings", BlueprintReadOnly, EditDefaultsOnly, meta=(AllowPrivateAccess="true"))
    bool bShouldTick = false;
    
    UPROPERTY()
    UWorld* WorldContext;
 
    FName LinkedButtonName;
 
    TSharedPtr<SVirtualControl> VirtualControlWidget;
 
    UPROPERTY()
    ULocalPlayer* LocalPlayer;
};