FInputDeviceState Struct Reference

#include <InputState.h>

Public Member Functions
	FInputDeviceState ()
void	SetModifierKeyStates (bool bShiftDown, bool bAltDown, bool bCtrlDown, bool bCmdDown)
bool	IsFromDevice (EInputDevices DeviceType) const

Static Public Member Functions
static bool	IsShiftKeyDown (const FInputDeviceState &InputState)
static bool	IsCtrlKeyDown (const FInputDeviceState &InputState)
static bool	IsAltKeyDown (const FInputDeviceState &InputState)
static bool	IsCmdKeyDown (const FInputDeviceState &InputState)

Public Attributes
EInputDevices	InputDevice
bool	bShiftKeyDown
bool	bAltKeyDown
bool	bCtrlKeyDown
bool	bCmdKeyDown
FKeyboardInputDeviceState	Keyboard
FMouseInputDeviceState	Mouse

Detailed Description

Current state of physical input devices at a point in time. Assumption is that the state refers to a single physical input device, ie InputDevice field is a single value of EInputDevices and not a combination.

Constructor & Destructor Documentation

FInputDeviceState()

FInputDeviceState::FInputDeviceState ( )

inline

Member Function Documentation

IsAltKeyDown()

static bool FInputDeviceState::IsAltKeyDown ( const FInputDeviceState &  InputState )

inlinestatic

Returns

true if alt key is down in input state

IsCmdKeyDown()

static bool FInputDeviceState::IsCmdKeyDown ( const FInputDeviceState &  InputState )

inlinestatic

Returns

true if Apple Command key is down in input state

IsCtrlKeyDown()

static bool FInputDeviceState::IsCtrlKeyDown ( const FInputDeviceState &  InputState )

inlinestatic

Returns

true if ctrl key is down in input state

IsFromDevice()

bool FInputDeviceState::IsFromDevice ( EInputDevices  DeviceType ) const

inline

Parameters

DeviceType

Combination of device-type flags

Returns

true if this input state is for an input device that matches the query flags

IsShiftKeyDown()

static bool FInputDeviceState::IsShiftKeyDown ( const FInputDeviceState &  InputState )

inlinestatic

Returns

true if shift key is down in input state

SetModifierKeyStates()

void FInputDeviceState::SetModifierKeyStates ( bool  bShiftDown, bool  bAltDown, bool  bCtrlDown, bool  bCmdDown  )

inline

Update keyboard modifier key states

Member Data Documentation

bAltKeyDown

bool FInputDeviceState::bAltKeyDown

Is they keyboard ALT modifier key currently pressed down

bCmdKeyDown

bool FInputDeviceState::bCmdKeyDown

Is they keyboard CMD modifier key currently pressed down (only on Apple devices)

bCtrlKeyDown

bool FInputDeviceState::bCtrlKeyDown

Is they keyboard CTRL modifier key currently pressed down

bShiftKeyDown

bool FInputDeviceState::bShiftKeyDown

Is they keyboard SHIFT modifier key currently pressed down

InputDevice

EInputDevices FInputDeviceState::InputDevice

Which InputDevice member is valid in this state

Keyboard

FKeyboardInputDeviceState FInputDeviceState::Keyboard

Current state of Keyboard device, if InputDevice == EInputDevices::Keyboard

Mouse

FMouseInputDeviceState FInputDeviceState::Mouse

Current state of Mouse device, if InputDevice == EInputDevices::Mouse

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/InteractiveToolsFramework/Public/InputState.h