InputBehaviorSet.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "InputBehavior.h"
#include "InputState.h"
#include "Templates/Function.h"
#include "UObject/Interface.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "UObject/UObjectGlobals.h"
 
#include "InputBehaviorSet.generated.h"
 
 
 
USTRUCT()
struct FBehaviorInfo
{
    GENERATED_BODY()
    
    
    UPROPERTY()
    TObjectPtr<UInputBehavior> Behavior = nullptr;
 
    void* Source = nullptr;
 
    FString Group;
 
    friend bool operator<(const FBehaviorInfo& l, const FBehaviorInfo& r)
    {
        return l.Behavior->GetPriority() < r.Behavior->GetPriority();
    }
};
 
 
 
 
UCLASS(Transient, MinimalAPI)
class UInputBehaviorSet : public UObject
{
    GENERATED_BODY()
 
public:
    INTERACTIVETOOLSFRAMEWORK_API UInputBehaviorSet();
    INTERACTIVETOOLSFRAMEWORK_API virtual ~UInputBehaviorSet();
 
    //
    // Set Management
    //
 
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool IsEmpty() const;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Add(UInputBehavior* Behavior, void* Source = nullptr, const FString& GroupName = "");
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Add(const UInputBehaviorSet* OtherSet, void* NewSource = nullptr, const FString& NewGroupName = "");
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool Remove(UInputBehavior* Behavior);
    INTERACTIVETOOLSFRAMEWORK_API virtual bool RemoveByGroup(const FString& GroupName);
    INTERACTIVETOOLSFRAMEWORK_API virtual bool RemoveBySource(void* Source);
    INTERACTIVETOOLSFRAMEWORK_API virtual void RemoveAll();
 
 
    //
    // Queries and Event Forwarding
    //
 
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void CollectWantsCapture(const FInputDeviceState& InputState, TArray<FInputCaptureRequest>& ResultOut);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void CollectWantsHoverCapture(const FInputDeviceState& InputState, TArray<FInputCaptureRequest>& ResultOut);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void CollectWantsForceEndCapture(TArray<UInputBehavior*>& ResultOut);
 
 
protected:
 
    UPROPERTY()
    TArray<FBehaviorInfo> Behaviors;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void BehaviorsModified();
 
 
    bool SupportsInputType(UInputBehavior* Behavior, const FInputDeviceState& InputState)
    {
        return (Behavior->GetSupportedDevices() & InputState.InputDevice) != EInputDevices::None;
    }
 
};
 
 
 
 
 
// UInterface for IInputBehavior
UINTERFACE(MinimalAPI)
class UInputBehaviorSource : public UInterface
{
    GENERATED_BODY()
};
 
 
class IInputBehaviorSource
{
    GENERATED_BODY()
 
public:
    virtual const UInputBehaviorSet* GetInputBehaviors() const = 0;
};
 
 
UCLASS(Transient, MinimalAPI)
class ULocalInputBehaviorSource : public UObject, public IInputBehaviorSource
{
    GENERATED_BODY()
 
public:
 
    TUniqueFunction<const UInputBehaviorSet* ()> GetInputBehaviorsFunc = []() { return nullptr; };
 
    // IInputBehaviorSource
    virtual const UInputBehaviorSet* GetInputBehaviors() const override { return GetInputBehaviorsFunc(); };
};