GenericPlatformInputDeviceMapper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Logging/LogMacros.h"
 
DECLARE_LOG_CATEGORY_EXTERN(LogInputDeviceMapper, Log, All);
 
enum class EInputDeviceMappingPolicy : int32;
 
class IPlatformInputDeviceMapper
{
public:
    
    static APPLICATIONCORE_API IPlatformInputDeviceMapper& Get();
    
    APPLICATIONCORE_API IPlatformInputDeviceMapper();
    
    APPLICATIONCORE_API virtual ~IPlatformInputDeviceMapper();
    
    APPLICATIONCORE_API virtual int32 GetAllInputDevicesForUser(const FPlatformUserId UserId, TArray<FInputDeviceId>& OutInputDevices) const;
 
    APPLICATIONCORE_API virtual int32 GetAllInputDevices(TArray<FInputDeviceId>& OutInputDevices) const;
    
    APPLICATIONCORE_API virtual int32 GetAllConnectedInputDevices(TArray<FInputDeviceId>& OutInputDevices) const;
 
    APPLICATIONCORE_API virtual int32 GetAllConnectedInputDevicesForUser(const FPlatformUserId UserId, TArray<FInputDeviceId>& OutInputDevices) const;
 
    APPLICATIONCORE_API virtual int32 GetAllActiveUsers(TArray<FPlatformUserId>& OutUsers) const;
 
    APPLICATIONCORE_API virtual FPlatformUserId GetFirstPlatformUserWithNoInputDevice() const;
 
    virtual FPlatformUserId GetUserForUnpairedInputDevices() const = 0;
 
    APPLICATIONCORE_API virtual bool IsUnpairedUserId(const FPlatformUserId PlatformId) const;
 
    APPLICATIONCORE_API virtual bool IsInputDeviceMappedToUnpairedUser(const FInputDeviceId InputDevice) const;
 
    virtual FPlatformUserId GetPrimaryPlatformUser() const = 0;
    
    virtual FInputDeviceId GetDefaultInputDevice() const = 0;
 
    APPLICATIONCORE_API virtual FPlatformUserId GetPlatformUserForNewlyConnectedDevice(const int32 InUserId = -1); 
 
    APPLICATIONCORE_API virtual FPlatformUserId GetUserForInputDevice(FInputDeviceId DeviceId) const;
 
    APPLICATIONCORE_API virtual FInputDeviceId GetPrimaryInputDeviceForUser(FPlatformUserId UserId) const;
 
    APPLICATIONCORE_API virtual bool Internal_SetInputDeviceConnectionState(FInputDeviceId DeviceId, EInputDeviceConnectionState NewState);
    
    APPLICATIONCORE_API virtual EInputDeviceConnectionState GetInputDeviceConnectionState(const FInputDeviceId DeviceId) const;
 
    APPLICATIONCORE_API virtual bool Internal_MapInputDeviceToUser(FInputDeviceId DeviceId, FPlatformUserId UserId, EInputDeviceConnectionState ConnectionState);
 
    APPLICATIONCORE_API virtual bool Internal_ChangeInputDeviceUserMapping(FInputDeviceId DeviceId, FPlatformUserId NewUserId, FPlatformUserId OldUserId);
 
    APPLICATIONCORE_API virtual int32 GetMaxPlatformUserCount() const;
 
    // Delegates for listening to input device changes
    
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnUserInputDeviceConnectionChange, EInputDeviceConnectionState /* NewConnectionState */, FPlatformUserId /* PlatformUserId */, FInputDeviceId /* InputDeviceId */);
 
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnUserInputDevicePairingChange, FInputDeviceId /* InputDeviceId */, FPlatformUserId /* NewUserPlatformId */, FPlatformUserId /* OldUserPlatformId */);
 
    FOnUserInputDeviceConnectionChange& GetOnInputDeviceConnectionChange() const { return OnInputDeviceConnectionChange; }
    FOnUserInputDevicePairingChange& GetOnInputDevicePairingChange() const { return OnInputDevicePairingChange; }
 
#if WITH_EDITOR
    APPLICATIONCORE_API void HandleInputDevicePolicyChanged(const EInputDeviceMappingPolicy NewPolicy);
#endif  // #if WITH_EDITOR
    
    // Functions to provide compatibility between the old "int32 ControllerId"
    // and the new FPlatformUserId and FInputDeviceId structs.
    
    virtual bool RemapUserAndDeviceToControllerId(FPlatformUserId UserId, int32& OutControllerId, FInputDeviceId OptionalDeviceId = INPUTDEVICEID_NONE) = 0;
    
    /*
     * Remap a FPlatformUserId to the legacy platform LocalUserIndex (often the same as ControllerId).
     * This is useful in cases where the input device id is not needed.
     *
     * @param UserId            The platform user that should be converted
     * @returns                 A valid platform user index, or INDEX_NONE
     */
    virtual int32 GetUserIndexForPlatformUser(FPlatformUserId UserId) = 0;
 
    virtual bool RemapControllerIdToPlatformUserAndDevice(int32 ControllerId, FPlatformUserId& InOutUserId, FInputDeviceId& OutInputDeviceId) = 0;
 
    /*
     * Remap the legacy platform LocalUserIndex (often the same as ControllerId) to a FPlatformUserId.
     * This is useful in cases where the input device id is not needed.
     *
     * @param LocalUserIndex    A platform user index where 0 should always be a valid user
     * @returns                 A platform-allocated user id, or PLATFORMUSERID_NONE
     */
    virtual FPlatformUserId GetPlatformUserForUserIndex(int32 LocalUserIndex) = 0;
 
    virtual FPlatformUserId AllocateNewUserId() = 0;
 
    virtual FInputDeviceId AllocateNewInputDeviceId() = 0;
    
    APPLICATIONCORE_API virtual const EInputDeviceMappingPolicy GetCurrentDeviceMappingPolicy() const;
protected:
 
    APPLICATIONCORE_API virtual void BindCoreDelegates();
    
    APPLICATIONCORE_API virtual void UnbindCoreDelegates();
 
    virtual void OnUserLoginChangedEvent(bool bLoggedIn, int32 UserId, int32 UserIndex) = 0;
    
    virtual bool IsUsingControllerIdAsUserId() const = 0;
 
    APPLICATIONCORE_API virtual bool ShouldCreateUniqueUserForEachDevice() const;
 
    virtual bool ShouldBroadcastLegacyDelegates() const = 0;
 
    static APPLICATIONCORE_API FOnUserInputDeviceConnectionChange OnInputDeviceConnectionChange;
 
    static APPLICATIONCORE_API FOnUserInputDevicePairingChange OnInputDevicePairingChange;
    
    TMap<FInputDeviceId, FPlatformInputDeviceState> MappedInputDevices;
 
    FPlatformUserId LastPlatformUserId = PLATFORMUSERID_NONE;
 
    FInputDeviceId LastInputDeviceId = INPUTDEVICEID_NONE;
 
    TArray<FPlatformUserId> AllocatedPlatformUserIds;
};
 
class FGenericPlatformInputDeviceMapper : public IPlatformInputDeviceMapper
{
public:
 
    APPLICATIONCORE_API FGenericPlatformInputDeviceMapper(const bool InbUsingControllerIdAsUserId, const bool InbShouldBroadcastLegacyDelegates);
    
    APPLICATIONCORE_API virtual FPlatformUserId GetUserForUnpairedInputDevices() const override;
    APPLICATIONCORE_API virtual FPlatformUserId GetPrimaryPlatformUser() const override;
    APPLICATIONCORE_API virtual FInputDeviceId GetDefaultInputDevice() const override;
 
    APPLICATIONCORE_API virtual bool RemapControllerIdToPlatformUserAndDevice(int32 ControllerId, FPlatformUserId& InOutUserId, FInputDeviceId& OutInputDeviceId) override;
    APPLICATIONCORE_API virtual FPlatformUserId GetPlatformUserForUserIndex(int32 LocalUserIndex) override;
    APPLICATIONCORE_API virtual bool RemapUserAndDeviceToControllerId(FPlatformUserId UserId, int32& OutControllerId, FInputDeviceId OptionalDeviceId = INPUTDEVICEID_NONE) override;
    APPLICATIONCORE_API virtual int32 GetUserIndexForPlatformUser(FPlatformUserId UserId) override;
    APPLICATIONCORE_API virtual bool IsUsingControllerIdAsUserId() const override;
    APPLICATIONCORE_API virtual bool ShouldBroadcastLegacyDelegates() const override;
 
    APPLICATIONCORE_API virtual FPlatformUserId AllocateNewUserId() override;
 
    APPLICATIONCORE_API virtual FInputDeviceId AllocateNewInputDeviceId() override;
    
protected:
 
    APPLICATIONCORE_API virtual void OnUserLoginChangedEvent(bool bLoggedIn, int32 RawPlatformUserId, int32 UserIndex) override;
 
    const bool bUsingControllerIdAsUserId = true;
    const bool bShouldBroadcastLegacyDelegates = true;
 
    bool bUnpairInputDevicesWhenLoggingOut = false;
};