1. Epic GamesDeveloper
  3. FCommonInputPreprocessor

FCommonInputPreprocessor

Helper class that is designed to fire before any UI has a chance to process input so that we can properly set the current input type of the application.

API > API/Plugins > API/Plugins/CommonInput

Inheritance Hierarchy

References

   
Module CommonInput
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonInput/Public/CommonInputPreprocessor.h
Include #include "CommonInputPreprocessor.h"

Syntax

class FCommonInputPreprocessor : public IInputProcessor

Remarks

Helper class that is designed to fire before any UI has a chance to process input so that we can properly set the current input type of the application.

Variables

  Type Name Description
Protected variable bool bIgnoreNextMove  
Protected variable TMap< FName, bool >[(uint8) ECommonInputType::Count] FilterInputTypeWithReasons The reasons we might be filtering input right now.
Protected variable bool[(uint8) ECommonInputType::Count] InputMethodPermissions  
Protected variable UCommonInputSubsystem & InputSubsystem  
Protected variable FString LastSeenGamepadHardwareDeviceIdentifier  
Protected variable FName LastSeenGamepadInputDeviceName  
Public variable FGamepadChangeDetectedEvent OnGamepadChangeDetected  

Constructors

  Type Name Description
Public function  

FCommonInputPreprocessor ( UCommonInputSubsystem& InCommonInputSubsystem
)

  

Functions

  Type Name Description
Protected function ECommonInputType

GetInputType ( const FKey& Key
)

  
Protected function ECommonInputType

GetInputType ( const FPointerEvent& PointerEvent
)

  
Public function Const bool  
Protected function bool

IsRelevantInput ( FSlateApplication& SlateApp,
const FInputEvent& InputEvent,
const ECommonInputType DesiredInputType
)

  
Protected function void  
Public function void

SetInputTypeFilter ( ECommonInputType InputType,
FName InReason,
bool InFilter
)

  

Overridden from IInputProcessor

  Type Name Description
Public function Virtual Const const TCHAR * Debug name for logging purposes
Public function Virtual bool

HandleAnalogInputEvent ( FSlateApplication& SlateApp,
const FAnalogInputEvent& InAnalogInputEvent
)

 Analog axis input
Public function Virtual bool

HandleKeyDownEvent ( FSlateApplication& SlateApp,
const FKeyEvent& InKeyEvent
)

 Key down input
Public function Virtual bool Mouse button double clicked.
Public function Virtual bool Mouse button press
Public function Virtual bool

HandleMouseMoveEvent ( FSlateApplication& SlateApp,
const FPointerEvent& MouseEvent
)

 Mouse movement input
Public function Virtual void

Tick ( const float DeltaTime,
FSlateApplication& SlateApp,
TSharedRef< ICursor > Cursor
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page