WidgetInteractionComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
#include "InputCoreTypes.h"
#include "Engine/HitResult.h"
#include "Components/SceneComponent.h"
#include "GenericPlatform/GenericApplication.h"
#include "Layout/WidgetPath.h"
#include "WidgetInteractionComponent.generated.h"
 
class FSlateVirtualUserHandle;
class UPrimitiveComponent;
class UWidgetComponent;
 
UENUM(BlueprintType)
enum class EWidgetInteractionSource : uint8
{
    World,
    Mouse,
    CenterScreen,
    Custom
};
 
// TODO CenterScreen needs to be able to work with multiple player controllers, perhaps finding
// the PC via the outer/owner chain?  Maybe you need to set the PC that owns this?  Maybe we should
// key off the Virtual User Index?
 
// TODO Expose modifier key state.
 
// TODO Come up with a better way to let people forward a lot of keyboard input without a bunch of glue
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnHoveredWidgetChanged, UWidgetComponent*, WidgetComponent, UWidgetComponent*, PreviousWidgetComponent);
 
UCLASS(ClassGroup="UserInterface", meta=(BlueprintSpawnableComponent) , MinimalAPI)
class UWidgetInteractionComponent : public USceneComponent
{
    GENERATED_BODY()
 
public:
    UPROPERTY(BlueprintAssignable, Category="Interaction|Event")
    FOnHoveredWidgetChanged OnHoveredWidgetChanged;
 
public:
    UMG_API UWidgetInteractionComponent(const FObjectInitializer& ObjectInitializer = FObjectInitializer::Get());
 
    // Begin ActorComponent interface
    UMG_API virtual void OnComponentCreated() override;
    UMG_API virtual void Activate(bool bReset = false) override;
    UMG_API virtual void Deactivate() override;
    UMG_API virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
    // End UActorComponent
    
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API virtual void PressPointerKey(FKey Key);
    
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API virtual void ReleasePointerKey(FKey Key);
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API virtual bool PressKey(FKey Key, bool bRepeat = false);
    
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API virtual bool ReleaseKey(FKey Key);
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API virtual bool PressAndReleaseKey(FKey Key);
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API virtual bool SendKeyChar(FString Characters, bool bRepeat = false);
    
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API virtual void ScrollWheel(float ScrollDelta);
    
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API UWidgetComponent* GetHoveredWidgetComponent() const;
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API bool IsOverInteractableWidget() const;
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API bool IsOverFocusableWidget() const;
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API bool IsOverHitTestVisibleWidget() const;
 
    UMG_API const FWeakWidgetPath& GetHoveredWidgetPath() const;
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API const FHitResult& GetLastHitResult() const;
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API FVector2D Get2DHitLocation() const;
 
    UFUNCTION(BlueprintCallable, Category="Interaction")
    UMG_API void SetCustomHitResult(const FHitResult& HitResult);
 
    UFUNCTION(BlueprintCallable, Category = "Interaction")
    UMG_API void SetFocus(UWidget* FocusWidget);
 
protected:
    TSharedPtr<FSlateVirtualUserHandle> VirtualUser;
 
public:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Interaction", meta=( ClampMin = "0", ExposeOnSpawn = true ))
    int32 VirtualUserIndex;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Interaction", meta=( ClampMin = "0", UIMin = "0", UIMax = "9", ExposeOnSpawn = true ))
    int32 PointerIndex;
 
public:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Interaction")
    TEnumAsByte<ECollisionChannel> TraceChannel;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Interaction")
    float InteractionDistance;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Interaction")
    EWidgetInteractionSource InteractionSource;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Interaction")
    bool bEnableHitTesting;
 
public:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Debugging")
    bool bShowDebug;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Debugging", AdvancedDisplay, meta=( ClampMin = "0.001" ))
    float DebugSphereLineThickness;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Debugging", AdvancedDisplay, meta=( ClampMin = "0.001", ClampMax = "50"))
    float DebugLineThickness;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Debugging", AdvancedDisplay)
    FLinearColor DebugColor;
 
protected:
 
    // Gets the key and char codes for sending keys for the platform.
    UMG_API void GetKeyAndCharCodes(const FKey& Key, bool& bHasKeyCode, uint32& KeyCode, bool& bHasCharCode, uint32& CharCode);
 
    UMG_API bool CanSendInput();
 
    UMG_API void SimulatePointerMovement();
 
    struct FWidgetTraceResult
    {
        FWidgetTraceResult()
            : HitResult()
            , LocalHitLocation(FVector2D::ZeroVector)
            , HitWidgetComponent(nullptr)
            , HitWidgetPath()
            , bWasHit(false)
            , LineStartLocation(FVector::ZeroVector)
            , LineEndLocation(FVector::ZeroVector)
        {
        }
 
        FHitResult HitResult;
        FVector2D LocalHitLocation;
        UWidgetComponent* HitWidgetComponent;
        FWidgetPath HitWidgetPath;
        bool bWasHit;
        FVector LineStartLocation;
        FVector LineEndLocation;
    };
 
    UMG_API virtual FWidgetPath FindHoveredWidgetPath(const FWidgetTraceResult& TraceResult)  const;
 
    UMG_API virtual FWidgetTraceResult PerformTrace() const;
 
    UMG_API void GetRelatedComponentsToIgnoreInAutomaticHitTesting(TArray<UPrimitiveComponent*>& IgnorePrimitives) const;
 
    UMG_API bool CanInteractWithComponent(UWidgetComponent* Component) const;
 
protected:
 
    FWeakWidgetPath LastWidgetPath;
 
    FModifierKeysState ModifierKeys;
    
    TSet<FKey> PressedKeys;
 
    UPROPERTY(Transient)
    FHitResult CustomHitResult;
    
    UPROPERTY(Transient)
    FVector2D LocalHitLocation;
    
    UPROPERTY(Transient)
    FVector2D LastLocalHitLocation;
 
    UE_DEPRECATED(5.6, "Property deprecated, please use WeakHoveredWidgetComponent instead.")
    UPROPERTY(Transient)
    TObjectPtr<UWidgetComponent> HoveredWidgetComponent = nullptr;
 
    UPROPERTY(Transient)
    TWeakObjectPtr<UWidgetComponent> WeakHoveredWidgetComponent;
 
    UPROPERTY(Transient)
    FHitResult LastHitResult;
 
    UPROPERTY(Transient)
    bool bIsHoveredWidgetInteractable;
 
    UPROPERTY(Transient)
    bool bIsHoveredWidgetFocusable;
 
    UPROPERTY(Transient)
    bool bIsHoveredWidgetHitTestVisible;
 
private:
 
#if WITH_EDITOR
    void OnPIEEnded(class UGameInstance*);
#endif
    
    FWidgetPath DetermineWidgetUnderPointer();
 
private:
#if WITH_EDITORONLY_DATA
 
    UPROPERTY()
    TObjectPtr<class UArrowComponent> ArrowComponent;
 
#endif
 
};