InputBindingManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UICommandList.h"
#include "Framework/Commands/InputChord.h"
#include "Framework/Commands/UICommandInfo.h"
 
class FUserDefinedChords;
 
typedef TMap<FName, TSharedPtr<FUICommandInfo>> FCommandInfoMap;
typedef TMap<FInputChord, FName> FChordMap;
 
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnUserDefinedChordChanged, const FUICommandInfo& );
 
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRegisterCommandList, const FName, TSharedRef<FUICommandList>);
 
class FInputBindingManager
{
public:
 
    static SLATE_API FInputBindingManager& Get();
 
    virtual ~FInputBindingManager() { }
 
    SLATE_API void GetKnownInputContexts( TArray< TSharedPtr<FBindingContext> >& OutInputContexts ) const;
 
    SLATE_API TSharedPtr<FBindingContext> GetContextByName( const FName& InContextName );
 
    SLATE_API void RemoveContextByName( const FName& InContextName );
 
    SLATE_API void CreateInputCommand( const TSharedRef<FBindingContext>& InBindingContext, TSharedRef<FUICommandInfo> InUICommandInfo );
 
    SLATE_API void RemoveInputCommand( const TSharedRef<FBindingContext>& InBindingContext, TSharedRef<FUICommandInfo> InUICommandInfo );
 
    SLATE_API const TSharedPtr<FUICommandInfo> GetCommandInfoFromInputChord( const FName InBindingContext, const FInputChord& InChord, bool bCheckDefault ) const;
 
    SLATE_API const TSharedPtr<FUICommandInfo> FindCommandInContext( const FName InBindingContext, const FInputChord& InChord, bool bCheckDefault ) const;
 
    SLATE_API const TSharedPtr<FUICommandInfo> FindCommandInContext( const FName InBindingContext, const FName CommandName ) const;
 
    SLATE_API virtual void NotifyActiveChordChanged( const FUICommandInfo& CommandInfo, const EMultipleKeyBindingIndex InChordIndex);
    
    SLATE_API void SaveInputBindings();
 
    SLATE_API void RemoveUserDefinedChords();
 
    SLATE_API void GetCommandInfosFromContext( const FName InBindingContext, TArray< TSharedPtr<FUICommandInfo> >& OutCommandInfos ) const;
 
    FDelegateHandle RegisterUserDefinedChordChanged(const FOnUserDefinedChordChanged::FDelegate& Delegate)
    {
        return OnUserDefinedChordChanged.Add(Delegate);
    }
 
    void UnregisterUserDefinedChordChanged(FDelegateHandle DelegateHandle)
    {
        OnUserDefinedChordChanged.Remove(DelegateHandle);
    }
 
    SLATE_API bool GetUserDefinedChord(const FName InBindingContext, const FName InCommandName, const EMultipleKeyBindingIndex InChordIndex, FInputChord& OutUserDefinedChord);
 
    SLATE_API bool GetProjectDefinedChord(const FName InBindingContext, const FName InCommandName, const EMultipleKeyBindingIndex InChordIndex, FInputChord& OutUserDefinedChord);
 
    // Type of filter
    enum class ECommandFilterType
    {
        None,
 
        DenyList,
        AllowList
    };
 
    SLATE_API void AddCommandFilter(const FName InOwnerName, const FName InBindingContext, const FName InCommandName, const ECommandFilterType FilterType);
 
    SLATE_API void UnregisterCommandFilterOwner(const FName InOwnerName);
 
    SLATE_API bool CommandPassesFilter(const FName InBindingContext, const FName InCommandName) const;
 
    SLATE_API bool RegisterCommandList(const ::FName InBindingContext, TSharedRef<FUICommandList> CommandList) const;
 
    SLATE_API TSharedPtr<FUICommandList> RegisterNewCommandList(const FName InBindingContext) const;
 
    SLATE_API bool UnregisterCommandList(const ::FName InBindingContext, TSharedRef<FUICommandList> CommandList) const;
 
    FOnRegisterCommandList OnRegisterCommandList;
 
    FOnRegisterCommandList OnUnregisterCommandList;
 
private:
 
    SLATE_API FInputBindingManager();
 
    SLATE_API void CheckForDuplicateDefaultChords( const FBindingContext& InBindingContext, TSharedPtr<FUICommandInfo> InCommandInfo ) const;
 
    SLATE_API void GetAllChildContexts( const FName InBindingContext, TArray<FName>& AllChildren ) const;
 
    SLATE_API void PrintAllInputCommands(bool bBoundOnly);
 
private:
 
    struct FContextEntry
    {
        FContextEntry()
        {
            ChordToCommandInfoMaps.Init(FChordMap(), static_cast<uint8>(EMultipleKeyBindingIndex::NumChords));
        }
        FCommandInfoMap CommandInfoMap;
 
        TArray<FChordMap> ChordToCommandInfoMaps;
 
        TSharedPtr< FBindingContext > BindingContext;
    };
 
    struct FCommandFilterOwners
    {
        TArray<FName> OwnerNames;
    };
 
    struct FCommandFilterForContext
    {
        TMap<FName, FCommandFilterOwners> CommandDenyList;
        TMap<FName, FCommandFilterOwners> CommandAllowList;
    };
 
    TMap<FName, FCommandFilterForContext> CommandFiltersByContext;
 
    TMap< FName, FContextEntry > ContextMap;
    
    TMultiMap< FName, FName > ParentToChildMap;
 
    TSharedPtr< class FUserDefinedChords > UserDefinedChords;
 
    TSharedPtr< class FUserDefinedChords > ProjectDefinedChords;
 
    FOnUserDefinedChordChanged OnUserDefinedChordChanged;
};