MouseHoverBehavior.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "BaseBehaviors/BehaviorTargetInterfaces.h"
#include "BaseBehaviors/InputBehaviorModifierStates.h"
#include "CoreMinimal.h"
#include "InputBehavior.h"
#include "InputState.h"
#include "InteractiveTool.h"
#include "Templates/Function.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "MouseHoverBehavior.generated.h"
 
class UObject;
 
 
 
UCLASS(MinimalAPI)
class UMouseHoverBehavior : public UInputBehavior
{
    GENERATED_BODY()
 
public:
    INTERACTIVETOOLSFRAMEWORK_API UMouseHoverBehavior();
 
    FInputBehaviorModifierStates Modifiers;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Initialize(IHoverBehaviorTarget* Target);
 
    TFunction<bool(const FInputDeviceState&)> HoverModifierCheckFunc = nullptr;
 
    // UInputBehavior hover implementation
 
    INTERACTIVETOOLSFRAMEWORK_API virtual EInputDevices GetSupportedDevices() override;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool WantsHoverEvents() override;
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputCaptureRequest WantsHoverCapture(const FInputDeviceState& InputState) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputCaptureUpdate BeginHoverCapture(const FInputDeviceState& InputState, EInputCaptureSide eSide) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputCaptureUpdate UpdateHoverCapture(const FInputDeviceState& InputState) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void EndHoverCapture() override;
 
protected:
    IHoverBehaviorTarget* Target;
};
 
 
UCLASS(MinimalAPI)
class ULocalMouseHoverBehavior : public UMouseHoverBehavior, public IHoverBehaviorTarget
{
    GENERATED_BODY()
protected:
    using UMouseHoverBehavior::Initialize;
 
public:
    virtual void Initialize()
    {
        this->Initialize(this);
    }
 
    TUniqueFunction<FInputRayHit(const FInputDeviceRay& PressPos)> BeginHitTestFunc = [](const FInputDeviceRay&) { return FInputRayHit(); };
 
    TUniqueFunction<void(const FInputDeviceRay& PressPos)> OnBeginHoverFunc = [](const FInputDeviceRay&) {};
 
    TUniqueFunction<bool(const FInputDeviceRay& PressPos)> OnUpdateHoverFunc = [](const FInputDeviceRay&) { return false; };
 
    TUniqueFunction<void()> OnEndHoverFunc = []() {};
 
    TUniqueFunction< void(int, bool) > OnUpdateModifierStateFunc = [](int ModifierID, bool bIsOn) {};
 
public:
    // IHoverBehaviorTarget implementation
    virtual FInputRayHit BeginHoverSequenceHitTest(const FInputDeviceRay& PressPos) override
    {
        return BeginHitTestFunc(PressPos);
    }
 
    virtual void OnBeginHover(const FInputDeviceRay& DevicePos) override
    {
        OnBeginHoverFunc(DevicePos);
    }
 
    virtual bool OnUpdateHover(const FInputDeviceRay& DevicePos) override
    {
        return OnUpdateHoverFunc(DevicePos);
    }
 
    virtual void OnEndHover() override
    {
        OnEndHoverFunc();
    }
 
    // IModifierToggleBehaviorTarget implementation
    virtual void OnUpdateModifierState(int ModifierID, bool bIsOn)
    {
        return OnUpdateModifierStateFunc(ModifierID, bIsOn);
    }
};