FPointerEvent | Unreal Engine 4.27 Documentation

Unreal Engine C++ API Reference > Runtime > SlateCore > Input

Inheritance Hierarchy

FInputEvent
FPointerEvent
FDragDropEvent

References


Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Input/Events.h
Include	#include "Input/Events.h"

Syntax

struct FPointerEvent : public FInputEvent

Remarks

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

Constructors

	Type	Name	Description
		FPointerEvent ()	UStruct Constructor. Not meant for normal usage.
		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 )
		FPointerEvent ( const FPointerEvent& Other, const UE::Slate::FDeprecateVector2DParameter& InScreenSpacePosition, const UE::Slate::FDeprecateVector2DParameter& InLastScreenSpacePosition )	A constructor to alter cursor positions
		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
		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.
		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 )
		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
		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 )
		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 )
		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 )

Functions

Type	Name	Description
const UE::Slate::FDeprecateVector2DResult &	GetCursorDelta ()	Returns the distance the mouse traveled since the last event was handled.
FKey	GetEffectingButton ()	Mouse button that caused this event to be raised (possibly FKey::Invalid)
const UE::Slate::FDeprecateVector2DResult &	GetGestureDelta ()	Returns the change in gesture value since the last gesture event of the same type.
EGestureEvent	GetGestureType ()	Returns the type of touch gesture
const UE::Slate::FDeprecateVector2DResult &	GetLastScreenSpacePosition ()	Returns the position of the cursor in screen space last time we handled an input event
uint32	GetPointerIndex ()	Returns the unique identifier of the pointer (e.g., finger index)
const TSet< FKey > &	GetPressedButtons ()	Returns the full set of pressed buttons
const UE::Slate::FDeprecateVector2DResult &	GetScreenSpacePosition ()	Returns The position of the cursor in screen space
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)
uint32	GetTouchpadIndex ()	Returns the index of the touch pad that generated this event (for platforms with multiple touch pads per user)
int32	GetUserIndex ()	Returns the index of the user that caused the event
float	GetWheelDelta ()	How much did the mouse wheel turn since the last mouse event
bool	IsDirectionInvertedFromDevice ()	Is the gesture delta inverted
bool	IsMouseButtonDown ( FKey MouseButton )	Mouse buttons that are currently pressed
bool	IsTouchEvent ()	Is this event a result from a touch (as opposed to a mouse)
bool	IsTouchFirstMoveEvent ()	Is this event a special first-move touch event
bool	IsTouchForceChangedEvent ()	Is this event a special force-change touch event
PointerEventType	MakeTranslatedEvent ( const PointerEventType& InPointerEvent, const FVirtualPointerPosition& VirtualPosition )