Navigation
API > API/Runtime > API/Runtime/Slate
A class that simulates a cursor driven by an analog stick.
| Name | FAnalogCursor |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Application/AnalogCursor.h |
| Include Path | #include "Framework/Application/AnalogCursor.h" |
Syntax
class FAnalogCursor :
public IInputProcessor ,
public TSharedFromThis< FAnalogCursor >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FAnalogCursor
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAnalogCursor
(
const FAnalogCursor& |
Framework/Application/AnalogCursor.h | ||
| Framework/Application/AnalogCursor.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAnalogCursor() |
Dtor | Framework/Application/AnalogCursor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AnalogValues | FVector2D | Input from the gamepad | Framework/Application/AnalogCursor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetOwnerUserIndex() |
Framework/Application/AnalogCursor.h | ||
void SetAcceleration
(
float NewAcceleration |
Framework/Application/AnalogCursor.h | ||
void SetDeadZone
(
float NewDeadZone |
Framework/Application/AnalogCursor.h | ||
void SetMaxSpeed
(
float NewMaxSpeed |
Framework/Application/AnalogCursor.h | ||
void SetMode
(
AnalogCursorMode::Type NewMode |
Framework/Application/AnalogCursor.h | ||
void SetStickySlowdown
(
float NewStickySlowdown |
Framework/Application/AnalogCursor.h |
Overridden from IInputProcessor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const TCHAR * GetDebugName() |
Debug name for logging purposes | Framework/Application/AnalogCursor.h | |
virtual bool HandleAnalogInputEvent
(
FSlateApplication& SlateApp, |
Analog axis input | Framework/Application/AnalogCursor.h | |
virtual bool HandleKeyDownEvent
(
FSlateApplication& SlateApp, |
Key down input | Framework/Application/AnalogCursor.h | |
virtual bool HandleKeyUpEvent
(
FSlateApplication& SlateApp, |
Key up input | Framework/Application/AnalogCursor.h | |
virtual bool HandleMouseMoveEvent
(
FSlateApplication& SlateApp, |
Mouse movement input | Framework/Application/AnalogCursor.h | |
virtual void Tick
(
const float DeltaTime, |
Framework/Application/AnalogCursor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D CalculateTickedCursorPosition
(
const float DeltaTime, |
Framework/Application/AnalogCursor.h | ||
void ClearAnalogValues() |
Set the cached analog stick declinations to 0 | Framework/Application/AnalogCursor.h | |
const FVector2D & GetAnalogValues
(
EAnalogStick Stick |
Getter | Framework/Application/AnalogCursor.h | |
virtual bool IsRelevantInput
(
const FPointerEvent& MouseEvent |
Framework/Application/AnalogCursor.h | ||
virtual bool IsRelevantInput
(
const FAnalogInputEvent& AnalogInputEvent |
Framework/Application/AnalogCursor.h | ||
virtual bool IsRelevantInput
(
const FKeyEvent& KeyEvent |
Framework/Application/AnalogCursor.h | ||
virtual bool IsRelevantInput
(
const FInputEvent& InputEvent |
Framework/Application/AnalogCursor.h | ||
virtual void UpdateCursorPosition
(
FSlateApplication& SlateApp, |
Handles updating the cursor position and processing a Mouse Move Event | Framework/Application/AnalogCursor.h | |
virtual void UpdateCursorPosition
(
FSlateApplication& SlateApp, |
Framework/Application/AnalogCursor.h |