1. Epic GamesDeveloper
  3. FCommonAnalogCursor

FCommonAnalogCursor

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

API > API/Plugins > API/Plugins/CommonUI > API/Plugins/CommonUI/Input

Inheritance Hierarchy

References

   
Module CommonUI
Header /Engine/Plugins/Runtime/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)

Variables

  Type Name Description
Protected variable const UCommonUIActionRouterBase & ActionRouter Knowingly unorthodox member reference to a UObject - ok because we are a subobject of the owning router and will never outlive it.
Protected variable ECommonInputType ActiveInputMethod  
Protected variable bool bIsAnalogMovementEnabled  
Protected variable bool bShouldHandleRightAnalog  

Constructors

  Type Name Description
Protected function    

Functions

  Type Name Description
Public function Virtual Const bool  
Protected function Const FVector2D

ClampPositionToViewport ( const FVector2D& InPosition
)

  
Public function Static TSharedRef< AnalogCursorT >

CreateAnalogCursor ( const UCommonUIActionRouterBase& InActionRouter
)

  
Protected function Virtual Const EOrientation  
Protected function Const UGameViewportClient *  
Protected function Virtual void  
Protected function void  
Protected function Virtual void  
Public function Virtual Const bool  
Protected function Const bool A ridiculous function name, but we have this exact question in a few places.
Protected function Const bool

IsInViewport ( const FVector2D& Position
)

  
Protected function Const bool  
Protected function Virtual void  
Protected function Virtual void  
Public function void

SetCursorMovementStick ( EAnalogStick InCursorMovementStick
)

  
Protected function void

SetNormalizedCursorPosition ( const FVector2D& RelativeNewPosition
)

  
Public function Virtual void

ShouldHandleRightAnalog ( bool bInShouldHandleRightAnalog
)

  
Protected function Const bool  

Overridden from FAnalogCursor

  Type Name Description
Public function Virtual Const int32  
Protected function Virtual Const bool

IsRelevantInput ( const FKeyEvent& KeyEvent
)

  
Protected function Virtual Const bool

IsRelevantInput ( const FAnalogInputEvent& AnalogInputEvent
)

  

Overridden from IInputProcessor

  Type Name Description
Public function Virtual bool

HandleAnalogInputEvent ( FSlateApplication& SlateApp,
const FAnalogInputEvent& InAnalogInputEvent
)

 Analog axis input
Public function Virtual bool

HandleKeyDownEvent ( FSlateApplication& SlateApp,
const FKeyEvent& InKeyEvent
)

 Key down input
Public function Virtual bool

HandleKeyUpEvent ( FSlateApplication& SlateApp,
const FKeyEvent& InKeyEvent
)

 Key up input
Public function Virtual bool Mouse button press
Public function Virtual bool

HandleMouseButtonUpEvent ( FSlateApplication& SlateApp,
const FPointerEvent& MouseEvent
)

 Mouse button release
Public function Virtual bool

HandleMouseMoveEvent ( FSlateApplication& SlateApp,
const FPointerEvent& MouseEvent
)

 Mouse movement input
Public function Virtual void

Tick ( const float DeltaTime,
FSlateApplication& SlateApp,
TSharedRef< ICursor > Cursor
)

  

Enums

  Type Name Description
Private enum EShoulderButtonFlags    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page