1. Epic GamesDeveloper
  3. FPointerEvent

FPointerEvent

[FPointerEvent](API\Runtime\SlateCore\FPointerEvent) describes a mouse or touch action (e.g. Press, Release, Move, etc).

API > API/Runtime > API/Runtime/SlateCore

FPointerEvent describes a mouse or touch action (e.g. Press, Release, Move, etc). It is passed to event handlers dealing with pointer-based input.

   
Name FPointerEvent
Type struct
Header File /Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Include Path #include "Input/Events.h"

Syntax

USTRUCT (BlueprintType )  
struct FPointerEvent : public FInputEvent

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FPointerEvent ( FInputDeviceId InDeviceId,
uint32 InPointerIndex,
const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition,
const TSet< FKey >& InPressedButtons,
FKey InEffectingButton,
float InWheelDelta,
const FModifierKeysState& InModifierKeys,
const TOptional< int32 > InOptionalSlateUserIndex
)

   Input/Events.h  

FPointerEvent ( uint32 InUserIndex,
uint32 InPointerIndex,
const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition,
const TSet< FKey >& InPressedButtons,
FKey InEffectingButton,
float InWheelDelta,
const FModifierKeysState& InModifierKeys
)

   Input/Events.h  

FPointerEvent ( const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition,
const TSet< FKey >& InPressedButtons,
const FModifierKeysState& InModifierKeys,
EGestureEvent InGestureType,
const UE::Slate::FDeprecateVector2DParameter& InGestureDelta,
bool bInIsDirectionInvertedFromDevice
)

 A constructor for gesture events Input/Events.h  

FPointerEvent ( uint32 InUserIndex,
uint32 InPointerIndex,
const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InDelta,
const TSet< FKey >& InPressedButtons,
const FModifierKeysState& InModifierKeys
)

   Input/Events.h  

FPointerEvent ( uint32 InPointerIndex,
const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition,
const TSet< FKey >& InPressedButtons,
FKey InEffectingButton,
float InWheelDelta,
const FModifierKeysState& InModifierKeys
)

 Events are immutable once constructed. Input/Events.h  

FPointerEvent ( uint32 InPointerIndex,
const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InDelta,
const TSet< FKey >& InPressedButtons,
const FModifierKeysState& InModifierKeys
)

 A constructor for raw mouse events Input/Events.h  

FPointerEvent ( const FPointerEvent& Other,
const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition
)

 A constructor to alter cursor positions Input/Events.h  
UStruct Constructor. Not meant for normal usage. Input/Events.h  

FPointerEvent ( uint32 InUserIndex,
uint32 InPointerIndex,
const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition,
float InForce,
bool bPressLeftMouseButton,
bool bInIsForceChanged,
bool bInIsFirstMove,
const FModifierKeysState& InModifierKeys,
uint32 InTouchpadIndex
)

   Input/Events.h  

FPointerEvent ( FInputDeviceId InDeviceId,
uint32 InPointerIndex,
const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition,
const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition,
float InForce,
bool bPressLeftMouseButton,
bool bInIsForceChanged,
bool bInIsFirstMove,
const FModifierKeysState& InModifierKeys,
uint32 InTouchpadIndex,
const TOptional< int32 > InOptionalSlateUserIndex
)

   Input/Events.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPointerEvent()

   Input/Events.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsDirectionInvertedFromDevice bool   Input/Events.h  
bIsTouchEvent bool   Input/Events.h  
bIsTouchFirstMove bool   Input/Events.h  
bIsTouchForceChanged bool   Input/Events.h  
CursorDelta UE::Slate::FDeprecateVector2DResult   Input/Events.h  
EffectingButton FKey   Input/Events.h  
Force float   Input/Events.h  
GestureType EGestureEvent   Input/Events.h  
LastScreenSpacePosition UE::Slate::FDeprecateVector2DResult   Input/Events.h  
PointerIndex uint32   Input/Events.h  
PressedButtons const TSet< FKey > *   Input/Events.h  
ScreenSpacePosition UE::Slate::FDeprecateVector2DResult   Input/Events.h  
TouchpadIndex uint32   Input/Events.h  
WheelOrGestureDelta UE::Slate::FDeprecateVector2DResult   Input/Events.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const UE::Slate::FDeprecateVector2DResult & GetCursorDelta()

 Returns the distance the mouse traveled since the last event was handled. Input/Events.h  

FKey GetEffectingButton()

 Mouse button that caused this event to be raised (possibly FKey::Invalid) Input/Events.h  

const UE::Slate::FDeprecateVector2DResult & GetGestureDelta()

 Returns the change in gesture value since the last gesture event of the same type. Input/Events.h  

EGestureEvent GetGestureType()

 Returns the type of touch gesture Input/Events.h  

const UE::Slate::FDeprecateVector2DResult & GetLastScreenSpacePosition()

 Returns the position of the cursor in screen space last time we handled an input event Input/Events.h  

uint32 GetPointerIndex()

 Returns the unique identifier of the pointer (e.g., finger index) Input/Events.h  

const TSet< FKey > & GetPressedButtons()

 Returns the full set of pressed buttons Input/Events.h  

const UE::Slate::FDeprecateVector2DResult & GetScreenSpacePosition()

 Returns The position of the cursor in screen space Input/Events.h  

float GetTouchForce()

 Returns the force of a touch (1.0f is mapped to an general touch force, < 1 is "light", > 1 is "heavy", and 10 is the max force possible) Input/Events.h  

uint32 GetTouchpadIndex()

 Returns the index of the touch pad that generated this event (for platforms with multiple touch pads per user) Input/Events.h  

float GetWheelDelta()

 How much did the mouse wheel turn since the last mouse event Input/Events.h  

bool IsDirectionInvertedFromDevice()

 Is the gesture delta inverted Input/Events.h  

bool IsMouseButtonDown ( FKey MouseButton
) const

 Mouse buttons that are currently pressed Input/Events.h  

bool IsTouchEvent()

 Is this event a result from a touch (as opposed to a mouse) Input/Events.h  

bool IsTouchFirstMoveEvent()

 Is this event a special first-move touch event Input/Events.h  

bool IsTouchForceChangedEvent()

 Is this event a special force-change touch event Input/Events.h  

Overridden from FInputEvent

Name Remarks Include Path Unreal Specifiers

virtual bool IsPointerEvent()

 Is this event a pointer event (touch or cursor). Input/Events.h  

virtual FText ToText()

   Input/Events.h  

Static

Name Remarks Include Path Unreal Specifiers

static PointerEventType MakeTranslatedEvent ( const PointerEventType& InPointerEvent,
const FVirtualPointerPosition& VirtualPosition
)

   Input/Events.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page