UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FAnalogInputEvent Struct Reference

#include <Events.h>

+ Inheritance diagram for FAnalogInputEvent:

Public Member Functions

 FAnalogInputEvent ()
 
 FAnalogInputEvent (const FKey InKey, const FModifierKeysState &InModifierKeys, const uint32 InUserIndex, const bool bInIsRepeat, const uint32 InCharacterCode, const uint32 InKeyCode, const float InAnalogValue)
 
 FAnalogInputEvent (const FKey InKey, const FModifierKeysState &InModifierKeys, const FInputDeviceId InDeviceId, const bool bInIsRepeat, const uint32 InCharacterCode, const uint32 InKeyCode, const float InAnalogValue, const TOptional< int32 > InOptionalSlateUserIndex=TOptional< int32 >())
 
virtual SLATECORE_API ~FAnalogInputEvent ()
 
float GetAnalogValue () const
 
virtual SLATECORE_API FText ToText () const override
 
- Public Member Functions inherited from FKeyEvent
SLATECORE_API FKeyEvent ()
 
SLATECORE_API FKeyEvent (const FKey InKey, const FModifierKeysState &InModifierKeys, const uint32 InUserIndex, const bool bInIsRepeat, const uint32 InCharacterCode, const uint32 InKeyCode)
 
SLATECORE_API FKeyEvent (const FKey InKey, const FModifierKeysState &InModifierKeys, const FInputDeviceId InDeviceId, const bool bInIsRepeat, const uint32 InCharacterCode, const uint32 InKeyCode, const TOptional< int32 > InOptionalSlateUserIndex=TOptional< int32 >())
 
virtual SLATECORE_API ~FKeyEvent ()
 
FKey GetKey () const
 
uint32 GetCharacter () const
 
uint32 GetKeyCode () const
 
virtual SLATECORE_API bool IsKeyEvent () const override
 
- Public Member Functions inherited from FInputEvent
 FInputEvent ()
 
 FInputEvent (const FModifierKeysState &InModifierKeys, const int32 InUserIndex, const bool bInIsRepeat)
 
 FInputEvent (const FModifierKeysState &InModifierKeys, const FInputDeviceId InDeviceId, const bool bInIsRepeat)
 
virtual SLATECORE_API ~FInputEvent ()
 
bool IsRepeat () const
 
bool IsShiftDown () const
 
bool IsLeftShiftDown () const
 
bool IsRightShiftDown () const
 
bool IsControlDown () const
 
bool IsLeftControlDown () const
 
bool IsRightControlDown () const
 
bool IsAltDown () const
 
bool IsLeftAltDown () const
 
bool IsRightAltDown () const
 
bool IsCommandDown () const
 
bool IsLeftCommandDown () const
 
bool IsRightCommandDown () const
 
bool AreCapsLocked () const
 
const FModifierKeysState & GetModifierKeys () const
 
uint32 GetUserIndex () const
 
FInputDeviceId GetInputDeviceId () const
 
FPlatformUserId GetPlatformUserId () const
 
uint64 GetEventTimestamp () const
 
double GetMillisecondsSinceEvent () const
 
SLATECORE_API FGeometry FindGeometry (const TSharedRef< SWidget > &WidgetToFind) const
 
SLATECORE_API TSharedRef< SWindow > GetWindow () const
 
void SetEventPath (const FWidgetPath &InEventPath)
 
const FWidgetPath * GetEventPath () const
 
virtual SLATECORE_API bool IsPointerEvent () const
 

Additional Inherited Members

- Protected Attributes inherited from FInputEvent
FModifierKeysState ModifierKeys
 
bool bIsRepeat
 
uint32 UserIndex
 
FInputDeviceId InputDeviceId
 
const FWidgetPath * EventPath
 
uint64 EventTimestamp
 

Detailed Description

FAnalogEvent describes a analog key value. It is passed to event handlers dealing with analog keys.

Constructor & Destructor Documentation

◆ FAnalogInputEvent() [1/3]

FAnalogInputEvent::FAnalogInputEvent ( )
inline

UStruct Constructor. Not meant for normal usage.

◆ FAnalogInputEvent() [2/3]

FAnalogInputEvent::FAnalogInputEvent ( const FKey  InKey,
const FModifierKeysState &  InModifierKeys,
const uint32  InUserIndex,
const bool  bInIsRepeat,
const uint32  InCharacterCode,
const uint32  InKeyCode,
const float  InAnalogValue 
)
inline

Constructor. Events are immutable once constructed.

Parameters
InKeyNameCharacter name
InModifierKeysModifier key state for this event
bInIsRepeatTrue if this key is an auto-repeated keystroke

◆ FAnalogInputEvent() [3/3]

FAnalogInputEvent::FAnalogInputEvent ( const FKey  InKey,
const FModifierKeysState &  InModifierKeys,
const FInputDeviceId  InDeviceId,
const bool  bInIsRepeat,
const uint32  InCharacterCode,
const uint32  InKeyCode,
const float  InAnalogValue,
const TOptional< int32 >  InOptionalSlateUserIndex = TOptional<int32>() 
)
inline

◆ ~FAnalogInputEvent()

FAnalogInputEvent::~FAnalogInputEvent ( )
virtualdefault

Member Function Documentation

◆ GetAnalogValue()

float FAnalogInputEvent::GetAnalogValue ( ) const
inline

Returns the analog value between 0 and 1. 0 being not pressed at all, 1 being fully pressed. Non analog keys will only be 0 or 1.

Returns
Analog value between 0 and 1. 1 being fully pressed, 0 being not pressed at all

◆ ToText()

FText FAnalogInputEvent::ToText ( ) const
overridevirtual

Reimplemented from FKeyEvent.

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