Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > CommonUI > Input > FCommonAnalogCursor

Light Theme

Dark Theme

FCommonAnalogCursor

Analog cursor preprocessor that tastefully hijacks things a bit to support controller navigation by moving a hidden cursor around based on focus.

Windows

MacOS

Linux

Inheritance Hierarchy

IInputProcessor

TSharedFromThis

FAnalogCursor

FCommonAnalogCursor

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/Input/CommonAnalogCursor.h
Include	#include "Input/CommonAnalogCursor.h"

Syntax

class FCommonAnalogCursor : public FAnalogCursor

Remarks

Analog cursor preprocessor that tastefully hijacks things a bit to support controller navigation by moving a hidden cursor around based on focus.

Introduces a separate focus-driven mode of operation, wherein the cursor is made invisible and automatically updated to be centered over whatever widget is currently focused (except the game viewport - we completely hide it then)

Constructors

	Name	Description
	FCommonAnalogCursor ( const UCommonUIActionRouterBase& I... )

Functions

	Name	Description
bool	CanReleaseMouseCapture()
FVector2D	ClampPositionToViewport ( const FVector2D& InPosition )
TSharedRef< ...	CreateAnalogCursor ( const UCommonUIActionRouterBase& I... )
EOrientation	DetermineScrollOrientation ( const UWidget& Widget )
UGameViewpor...	GetViewportClient()
void	HideCursor()
void	Initialize()
bool	IsGameViewportInFocusPathWithoutCapture()	A ridiculous function name, but we have this exact question in a few places.
bool	IsInViewport ( const FVector2D& Position )
void	SetCursorMovementStick ( EAnalogStick InCursorMovementStick )
void	SetNormalizedCursorPosition ( const FVector2D& RelativeNewPositi... )
void	ShouldHandleRightAnalog ( bool bInShouldHandleRightAnalog )

Overridden from FAnalogCursor

		Name	Description
	int32	GetOwnerUserIndex()
	bool	IsRelevantInput ( const FKeyEvent& KeyEvent )
	bool	IsRelevantInput ( const FAnalogInputEvent& AnalogInp... )

Overridden from IInputProcessor

	Name	Description
bool	HandleAnalogInputEvent ( FSlateApplication& SlateApp, const FAnalogInputEvent& InAnalogI... )	Analog axis input
bool	HandleKeyDownEvent ( FSlateApplication& SlateApp, const FKeyEvent& InKeyEvent )	Key down input
bool	HandleKeyUpEvent ( FSlateApplication& SlateApp, const FKeyEvent& InKeyEvent )	Key up input
bool	HandleMouseButtonDownEvent ( FSlateApplication& SlateApp, const FPointerEvent& MouseEvent )	Mouse button press
bool	HandleMouseButtonUpEvent ( FSlateApplication& SlateApp, const FPointerEvent& MouseEvent )	Mouse button release
void	Tick ( const float DeltaTime, FSlateApplication& SlateApp, TSharedRef< ICursor > Cursor )

Enums

	Name	Description
	EShoulderButtonFlags	We'll also need a CommonNavigationConfig that respects the stick assignment as well so it also maps to nav mode EAnalogStick CursorMovementStick = EAnalogStick::Left;

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss