InputDeviceSubsystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "InputSettings.h"
#include "GameFramework/InputDevicePropertyHandle.h"
#include "Subsystems/EngineSubsystem.h"
#include "Tickable.h"
#include "Templates/SubclassOf.h"
#include "InputDeviceSubsystem.generated.h"
 
ENGINE_API DECLARE_LOG_CATEGORY_EXTERN(LogInputDeviceProperties, Log, All);
 
class UInputDeviceProperty;
 
USTRUCT(BlueprintType)
struct FActivateDevicePropertyParams
{
    GENERATED_BODY()
 
    ENGINE_API FActivateDevicePropertyParams();
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Activation Options")
    FPlatformUserId UserId;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Activation Options")
    FInputDeviceId DeviceId;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Activation Options")
    uint8 bLooping : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Activation Options")
    uint8 bIgnoreTimeDilation : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Activation Options")
    uint8 bPlayWhilePaused : 1;
};
 
USTRUCT()
struct FActiveDeviceProperty
{
    GENERATED_BODY()
 
    ENGINE_API FActiveDeviceProperty();
    
    ENGINE_API friend uint32 GetTypeHash(const FActiveDeviceProperty& InProp);
    ENGINE_API friend bool operator==(const FActiveDeviceProperty& ActiveProp, const FInputDevicePropertyHandle& Handle);
    ENGINE_API friend bool operator!=(const FActiveDeviceProperty& ActiveProp, const FInputDevicePropertyHandle& Handle);
 
    ENGINE_API bool operator==(const FActiveDeviceProperty& Other) const;
    ENGINE_API bool operator!=(const FActiveDeviceProperty& Other) const;
 
    UPROPERTY()
    TWeakObjectPtr<UInputDeviceProperty> Property;
 
    double EvaluatedDuration;
 
    FPlatformUserId PlatformUser;
 
    FInputDeviceId DeviceId;
 
    FInputDevicePropertyHandle PropertyHandle;
 
    uint8 bLooping : 1;
 
    uint8 bIgnoreTimeDilation : 1;
 
    uint8 bPlayWhilePaused : 1;
 
    uint8 bHasBeenAppliedAtLeastOnce : 1;
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FHardwareInputDeviceChanged, const FPlatformUserId, UserId, const FInputDeviceId, DeviceId);
 
UCLASS(BlueprintType, MinimalAPI)
class UInputDeviceSubsystem : public UEngineSubsystem, public FTickableGameObject
{
    friend class FInputDeviceSubsystemProcessor;
    friend class FInputDeviceDebugTools;
    
    GENERATED_BODY()
public:
 
    static ENGINE_API UInputDeviceSubsystem* Get();
 
    //~ Begin UEngineSubsystem interface
    ENGINE_API virtual void Initialize(FSubsystemCollectionBase& Collection) override;
    ENGINE_API virtual void Deinitialize() override;
    ENGINE_API virtual bool ShouldCreateSubsystem(UObject* Outer) const override;
    //~ End UEngineSubsystem interface
    
    //~ Begin FTickableGameObject interface 
    ENGINE_API virtual UWorld* GetTickableGameObjectWorld() const override;
    ENGINE_API virtual ETickableTickType GetTickableTickType() const override;
    ENGINE_API virtual bool IsTickable() const override;
    ENGINE_API virtual bool IsTickableInEditor() const override;
    ENGINE_API virtual TStatId GetStatId() const override;
    ENGINE_API virtual void Tick(float InDeltaTime) override;
    //~ End FTickableGameObject interface
    
    ENGINE_API FInputDevicePropertyHandle ActivateDeviceProperty(UInputDeviceProperty* Property, const FActivateDevicePropertyParams& Params);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices", meta = (AutoCreateRefTerm = "Params", ReturnDisplayName = "Device Property Handle"))
    ENGINE_API FInputDevicePropertyHandle ActivateDevicePropertyOfClass(TSubclassOf<UInputDeviceProperty> PropertyClass, const FActivateDevicePropertyParams& Params);
    
    UFUNCTION(BlueprintCallable, Category = "Input Devices", meta=(ReturnDisplayName="Device Property"))
    ENGINE_API UInputDeviceProperty* GetActiveDeviceProperty(const FInputDevicePropertyHandle Handle) const;
    
    UFUNCTION(BlueprintCallable, Category = "Input Devices", meta = (ReturnDisplayName = "Is Active"))
    ENGINE_API bool IsPropertyActive(const FInputDevicePropertyHandle Handle) const;    
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    ENGINE_API void RemoveDevicePropertyByHandle(const FInputDevicePropertyHandle HandleToRemove);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    ENGINE_API void RemoveDevicePropertyHandles(const TSet<FInputDevicePropertyHandle>& HandlesToRemove);
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    ENGINE_API void RemoveAllDeviceProperties();
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    ENGINE_API FHardwareDeviceIdentifier GetMostRecentlyUsedHardwareDevice(const FPlatformUserId InUserId) const;
 
    UFUNCTION(BlueprintCallable, Category = "Input Devices", meta = (ReturnDisplayName = "Latest Device Id"))
    ENGINE_API FInputDeviceId GetMostRecentlyUsedInputDeviceId(const FPlatformUserId InUserId, const EHardwareDevicePrimaryType OfType = EHardwareDevicePrimaryType::Unspecified) const;
    
    UFUNCTION(BlueprintCallable, Category = "Input Devices")
    ENGINE_API FHardwareDeviceIdentifier GetInputDeviceHardwareIdentifier(const FInputDeviceId InputDevice) const;
 
    ENGINE_API FInputDeviceId GetLatestDeviceOfType(const FPlatformUserId InUserId, const EHardwareDevicePrimaryType OfType) const;
 
    UPROPERTY(BlueprintAssignable, Category = "Input Devices")
    FHardwareInputDeviceChanged OnInputHardwareDeviceChanged;
    
protected:
 
    ENGINE_API void SetMostRecentlyUsedHardwareDevice(const FInputDeviceId InDeviceId, const FHardwareDeviceIdentifier& InHardwareId);
 
    // Callbacks for when PIE is started/stopped. We will likely want to pause/resume input device properties
    // when this happens, or just remove all active properties when PIE stops. This will make designer iteration a little easier
#if WITH_EDITOR
    ENGINE_API void OnPrePIEStarted(bool bSimulating);
    ENGINE_API void OnPIEPaused(bool bSimulating);
    ENGINE_API void OnPIEResumed(bool bSimulating);
    ENGINE_API void OnPIEStopped(bool bSimulating);
 
    bool bIsPIEPlaying = false;
 
#endif  // WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
 
    struct FResetPIEData
    {
        TObjectPtr<UClass> ClassToReset;
        FInputDeviceId DeviceId;
        FPlatformUserId UserId;
    };
    
    TArray<FResetPIEData> PropertyClassesRequiringReset;
 
#endif  // WITH_EDITORONLY_DATA
    
    UPROPERTY(Transient)
    TSet<FActiveDeviceProperty> ActiveProperties;
 
    UPROPERTY(Transient)
    TSet<FInputDevicePropertyHandle> PropertiesPendingRemoval;
    
    TMap<FInputDeviceId, FHardwareDeviceIdentifier> LatestInputDeviceIdentifiers;
 
    struct FLatestInputDeviceData
    {
        FInputDeviceId LatestDeviceId = INPUTDEVICEID_NONE;
        
        TMap<EHardwareDevicePrimaryType, FInputDeviceId> LatestDevices;
    };
    
    TMap<FPlatformUserId, FLatestInputDeviceData> LatestUserDeviceIdentifiers;
 
    TSharedPtr<class FInputDeviceSubsystemProcessor> InputPreprocessor;
};