1. Epic GamesDeveloper
  3. FAnalogCursor

FAnalogCursor

A class that simulates a cursor driven by an analog stick.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Application

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/Application/AnalogCursor.h
Include #include "Framework/Application/AnalogCursor.h"

Syntax

class FAnalogCursor :  
    public IInputProcessor,  
    public TSharedFromThis< FAnalogCursor >

Remarks

A class that simulates a cursor driven by an analog stick.

Variables

  Type Name Description
Protected variable float Acceleration Current settings
Protected variable FVector2D CurrentOffset Current sub-pixel offset
Protected variable FVector2D CurrentSpeed Current speed of the cursor
Protected variable float DeadZone  
Protected variable float MaxSpeed  
Protected variable AnalogCursorMode::Type Mode  
Protected variable float StickySlowdown  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual   Dtor

Functions

  Type Name Description
Protected function Virtual FVector2D

CalculateTickedCursorPosition ( const float DeltaTime,
FSlateApplication& SlateApp,
TSharedPtr< FSlateUser > SlateUser
)

  
Protected function void Set the cached analog stick declinations to 0
Protected function Const const FVector2D &

GetAnalogValues ( EAnalogStick Stick
)

 Getter
Public function Virtual Const int32  
Protected function Virtual Const bool

IsRelevantInput ( const FPointerEvent& MouseEvent
)

  
Protected function Virtual Const bool

IsRelevantInput ( const FAnalogInputEvent& AnalogInputEvent
)

  
Protected function Virtual Const bool

IsRelevantInput ( const FKeyEvent& KeyEvent
)

  
Protected function Virtual Const bool

IsRelevantInput ( const FInputEvent& InputEvent
)

  
Public function void

SetAcceleration ( float NewAcceleration
)

  
Public function void

SetDeadZone ( float NewDeadZone
)

  
Public function void

SetMaxSpeed ( float NewMaxSpeed
)

  
Public function void  
Public function void

SetStickySlowdown ( float NewStickySlowdown
)

  
Protected function Virtual void

UpdateCursorPosition ( FSlateApplication& SlateApp,
TSharedRef< FSlateUser > SlateUser,
const FVector2D& NewPosition,
bool bForce
)

  

Overridden from IInputProcessor

  Type Name Description
Public function Virtual Const const TCHAR * Debug name for logging purposes
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

HandleMouseMoveEvent ( FSlateApplication& SlateApp,
const FPointerEvent& MouseEvent
)

 Mouse movement input
Public function Virtual void

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

  

Deprecated Functions

  Type Name Description
Protected function Virtual void

UpdateCursorPosition ( FSlateApplication& SlateApp,
TSharedRef< ICursor > Cursor,
const FVector2D& NewPosition,
bool bForce
)

 FAnalogCursor now updates cursor position based on user, not the hardware cursor specifically.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page