UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FIOSInputInterface Class Reference

#include <IOSInputInterface.h>

+ Inheritance diagram for FIOSInputInterface:

Public Member Functions

virtual ~FIOSInputInterface ()
 
void SendControllerEvents ()
 
virtual void SetForceFeedbackChannelValue (int32 ControllerId, FForceFeedbackChannelType ChannelType, float Value) override
 
virtual void SetForceFeedbackChannelValues (int32 ControllerId, const FForceFeedbackValues &values) override
 
void SetGamepadsAllowed (bool bAllowed)
 
void SetGamepadsBlockDeviceFeedback (bool bBlock)
 
void EnableMotionData (bool bEnable)
 
bool IsMotionDataEnabled () const
 
NSDataGetGamepadGlyphRawData (const FGamepadKeyNames::Type &ButtonKey, uint32 ControllerIndex)
 
- Public Member Functions inherited from FAppleControllerInterface
virtual ~FAppleControllerInterface ()
 
void SetMessageHandler (const TSharedRef< FGenericApplicationMessageHandler > &InMessageHandler)
 
void Tick (float DeltaTime)
 
void SendControllerEvents ()
 
virtual void SetLightColor (int32 ControllerId, FColor Color) override
 
virtual void ResetLightColor (int32 ControllerId) override
 
bool IsControllerAssignedToGamepad (int32 ControllerId) const
 
bool IsGamepadAttached () const
 
const ControllerType GetControllerType (uint32 ControllerIndex)
 
void SetControllerType (uint32 ControllerIndex)
 
FName GetControllerTypeName (const ControllerType InControllerType)
 
GCControllerButtonInputGetGCControllerButton (const FGamepadKeyNames::Type &ButtonKey, uint32 ControllerIndex)
 
void HandleInputInternal (const FGamepadKeyNames::Type &UEButton, uint32 ControllerIndex, bool bIsPressed, bool bWasPressed)
 
void HandleButtonGamepad (const FGamepadKeyNames::Type &UEButton, uint32 ControllerIndex)
 
void HandleAnalogGamepad (const FGamepadKeyNames::Type &UEAxis, uint32 ControllerIndex)
 
void HandleVirtualButtonGamepad (const FGamepadKeyNames::Type &UEButtonNegative, const FGamepadKeyNames::Type &UEButtonPositive, uint32 ControllerIndex)
 
- Public Member Functions inherited from IInputInterface
virtual ~IInputInterface ()
 
virtual void SetHapticFeedbackValues (int32 ControllerId, int32 Hand, const FHapticFeedbackValues &Values)
 
virtual void SetDeviceProperty (int32 ControllerId, const FInputDeviceProperty *Property)
 

Static Public Member Functions

static TSharedRef< FIOSInputInterfaceCreate (const TSharedRef< FGenericApplicationMessageHandler > &InMessageHandler)
 
static TSharedPtr< FIOSInputInterfaceGet ()
 
static APPLICATIONCORE_API void QueueTouchInput (const TArray< TouchInput > &InTouchEvents)
 
static void QueueKeyInput (int32 Key, int32 Char)
 
static void SetKeyboardInhibited (bool bInhibited)
 
static bool IsKeyboardInhibited ()
 
- Static Public Member Functions inherited from FAppleControllerInterface
static TSharedRef< FAppleControllerInterfaceCreate (const TSharedRef< FGenericApplicationMessageHandler > &InMessageHandler)
 
static TSharedPtr< FAppleControllerInterfaceGet ()
 

Protected Member Functions

virtual bool Exec_Runtime (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar) override
 
- Protected Member Functions inherited from FAppleControllerInterface
 FAppleControllerInterface (const TSharedRef< FGenericApplicationMessageHandler > &InMessageHandler)
 
void SignalEvent (EAppleControllerEventType InEventType, GCController *InController)
 

Additional Inherited Members

- Protected Attributes inherited from FAppleControllerInterface
TSharedRef< FGenericApplicationMessageHandlerMessageHandler
 
FCriticalSection DeferredEventCS
 
TArray< FDeferredAppleControllerEventDeferredEvents
 
FUserController Controllers [4]
 
TMap< FName, doubleNextKeyRepeatTime
 
bool bAllowControllers
 
- Static Protected Attributes inherited from FAppleControllerInterface
static FString HardwareDeviceIdentifier_DefaultGamepad
 

Detailed Description

Interface class for IOS input devices

Constructor & Destructor Documentation

◆ ~FIOSInputInterface()

virtual FIOSInputInterface::~FIOSInputInterface ( )
inlinevirtual

Member Function Documentation

◆ Create()

TSharedRef< FIOSInputInterface > FIOSInputInterface::Create ( const TSharedRef< FGenericApplicationMessageHandler > &  InMessageHandler)
static

◆ EnableMotionData()

void FIOSInputInterface::EnableMotionData ( bool  bEnable)

◆ Exec_Runtime()

bool FIOSInputInterface::Exec_Runtime ( UWorld InWorld,
const TCHAR Cmd,
FOutputDevice Ar 
)
overrideprotectedvirtual

Implementation of Exec that is called on all targets where UE_ALLOW_EXEC_COMMANDS is true

Reimplemented from FExec.

◆ Get()

static TSharedPtr< FIOSInputInterface > FIOSInputInterface::Get ( )
static

◆ GetGamepadGlyphRawData()

NSData * FIOSInputInterface::GetGamepadGlyphRawData ( const FGamepadKeyNames::Type ButtonKey,
uint32  ControllerIndex 
)

◆ IsKeyboardInhibited()

static bool FIOSInputInterface::IsKeyboardInhibited ( )
inlinestatic

◆ IsMotionDataEnabled()

bool FIOSInputInterface::IsMotionDataEnabled ( ) const

◆ QueueKeyInput()

void FIOSInputInterface::QueueKeyInput ( int32  Key,
int32  Char 
)
static

◆ QueueTouchInput()

void FIOSInputInterface::QueueTouchInput ( const TArray< TouchInput > &  InTouchEvents)
static

◆ SendControllerEvents()

void FIOSInputInterface::SendControllerEvents ( )

Poll for controller state and send events if needed

◆ SetForceFeedbackChannelValue()

void FIOSInputInterface::SetForceFeedbackChannelValue ( int32  ControllerId,
FForceFeedbackChannelType  ChannelType,
float  Value 
)
overridevirtual

IInputInterface implementation

Reimplemented from FAppleControllerInterface.

◆ SetForceFeedbackChannelValues()

void FIOSInputInterface::SetForceFeedbackChannelValues ( int32  ControllerId,
const FForceFeedbackValues Values 
)
overridevirtual

Sets the strength/speed of all the channels for the given controller id. NOTE: Unsupported channels are silently ignored

Parameters
ControllerIdthe id of the controller whose value is to be set
FForceFeedbackChannelValuesstrength or speed of feedback for all channels

Reimplemented from FAppleControllerInterface.

◆ SetGamepadsAllowed()

void FIOSInputInterface::SetGamepadsAllowed ( bool  bAllowed)
inline

◆ SetGamepadsBlockDeviceFeedback()

void FIOSInputInterface::SetGamepadsBlockDeviceFeedback ( bool  bBlock)
inline

◆ SetKeyboardInhibited()

static void FIOSInputInterface::SetKeyboardInhibited ( bool  bInhibited)
inlinestatic

The documentation for this class was generated from the following files: