Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FNavigationConfig

FNavigationConfig

This class is used to control which FKeys and analog axis should move focus.

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/NavigationConfig.h
Include #include "Framework/Application/NavigationConfig.h"

Syntax

class FNavigationConfig : public TSharedFromThis< FNavigationConfig >

Remarks

This class is used to control which FKeys and analog axis should move focus.

Variables

  Type Name Description
Public variable FKey AnalogHorizontalKey Which Axis Key controls horizontal navigation
Public variable float AnalogNavigationHorizontalThreshold  
Public variable float AnalogNavigationVerticalThreshold  
Public variable FKey AnalogVerticalKey Which Axis Key controls vertical navigation
Public variable bool bAnalogNavigation Should we respect the analog stick for navigation.
Public variable bool bIgnoreModifiersForNavigationActions Should we ignore modifier keys when checking for navigation actions.
Public variable bool bKeyNavigation Should we respect keys for navigation.
Public variable bool bTabNavigation Should the Tab key perform next and previous style navigation.
Public variable TMap< FKey, EUINavigationAction > KeyActionRules Digital key action rules.
Public variable TMap< FKey, EUINavigation > KeyEventRules Digital key navigation rules.
Protected variable TMap< int, FUserNavigationState > UserNavigationState Navigation state that we store per user.

Constructors

  Type Name Description
Public function   Ctor

Destructors

  Type Name Description
Public function Virtual   Dtor

Functions

  Type Name Description
Public function Virtual Const EUINavigationAction

GetNavigationActionForKey ( const FKey& InKey
)

  
Public function Virtual Const EUINavigationAction

GetNavigationActionFromKey ( const FKeyEvent& InKeyEvent
)

 Returns the navigation action corresponding to a key event.
Public function Virtual EUINavigation Gets the navigation direction from a given analog event.
Protected function Virtual EUINavigation Gets the navigation direction from the analog internally.
Public function Virtual Const EUINavigation Gets the navigation direction from a given key event.
Protected function Virtual Const float

GetRepeatRateForPressure ( float InPressure,
int32 InRepeats
)

 Gets the repeat rate of the navigation based on the current pressure being applied.
Public function Const bool Returns whether the analog event is beyond the navigation thresholds set in this config.
Protected function Virtual Const bool

IsAnalogHorizontalKey ( const FKey& InKey
)

  
Protected function Virtual Const bool

IsAnalogVerticalKey ( const FKey& InKey
)

  
Public function Virtual void

OnNavigationChangedFocus ( TSharedPtr< SWidget > OldWidget,
TSharedPtr< SWidget > NewWidget,
FFocusEvent FocusEvent
)

 Notified when navigation has caused a widget change to occur
Public function Virtual void Called when the navigation config is registered with Slate Application
Public function Virtual void Called when the navigation config is registered with Slate Application
Public function Virtual void

OnUserRemoved ( int32 UserIndex
)

 Notified when users are removed from the system, good chance to clean up any user specific state.
Public function Virtual Const FString Simplification of config as string

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page