IInputDeviceModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GenericPlatform/GenericApplicationMessageHandler.h"
#include "Features/IModularFeatures.h"
#include "Features/IModularFeature.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
#include "IInputDevice.h"
 
struct FInputDeviceCreationParameters
{
    bool bInitAsPrimaryDevice = true;
};
 
class IInputDeviceModule : public IModuleInterface, public IModularFeature
{
public:
    static FName GetModularFeatureName()
    {
        static FName FeatureName = FName(TEXT("InputDevice"));
        return FeatureName;
    }
 
    virtual void StartupModule() override
    {
        IModularFeatures::Get().RegisterModularFeature( GetModularFeatureName(), this );
    }
 
    static inline IInputDeviceModule& Get()
    {
        return FModuleManager::LoadModuleChecked< IInputDeviceModule >( "InputDevice" );
    }
 
    static inline bool IsAvailable()
    {
        return FModuleManager::Get().IsModuleLoaded( "InputDevice" );
    }
 
    virtual TSharedPtr<class IInputDevice> CreateInputDevice(const TSharedRef<FGenericApplicationMessageHandler>& InMessageHandler) = 0;
 
    virtual TSharedPtr<class IInputDevice> CreateInputDevice(const TSharedRef<FGenericApplicationMessageHandler>& InMessageHandler, FInputDeviceCreationParameters InParams)
    {
        // If this is a primary device and it should be constructed for the input system then call the default implementation.
        if (InParams.bInitAsPrimaryDevice)
        {
            return CreateInputDevice(InMessageHandler);
        }
 
        return nullptr;
    }
};