Files
UnrealEngineUWP/Engine/Source/Runtime/InputDevice/Public/IInputDeviceModule.h
Ben Marsh 7598af0532 Update copyright notices to 2019.
#rb none
#lockdown Nick.Penwarden

[CL 4662404 by Ben Marsh in Main branch]
2018-12-14 13:41:00 -05:00

58 lines
1.6 KiB
C++

// Copyright 1998-2019 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"
/**
* The public interface of the InputDeviceModule
*/
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 );
}
/**
* Singleton-like access to IInputDeviceModule
*
* @return Returns IInputDeviceModule singleton instance, loading the module on demand if needed
*/
static inline IInputDeviceModule& Get()
{
return FModuleManager::LoadModuleChecked< IInputDeviceModule >( "InputDevice" );
}
/**
* Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.
*
* @return True if the module is loaded and ready to use
*/
static inline bool IsAvailable()
{
return FModuleManager::Get().IsModuleLoaded( "InputDevice" );
}
/**
* Attempts to create a new head tracking device interface
*
* @return Interface to the new head tracking device, if we were able to successfully create one
*/
virtual TSharedPtr< class IInputDevice > CreateInputDevice(const TSharedRef< FGenericApplicationMessageHandler >& InMessageHandler) = 0;
};