FNavigationConfig | Unreal Engine 5.7 Documentation

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


Name	FNavigationConfig
Type	class
Header File	/Engine/Source/Runtime/Slate/Public/Framework/Application/NavigationConfig.h
Include Path	#include "Framework/Application/NavigationConfig.h"

Syntax

class FNavigationConfig : public TSharedFromThis< FNavigationConfig >

Inheritance Hierarchy

FSharedFromThisBase → TSharedFromThis → FNavigationConfig

Derived Classes

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FNavigationConfig()	Ctor	Framework/Application/NavigationConfig.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FNavigationConfig()	Dtor	Framework/Application/NavigationConfig.h

Variables

Public

Name	Type	Remarks	Include Path
AnalogHorizontalKey	FKey	Which Axis Key controls horizontal navigation	Framework/Application/NavigationConfig.h
AnalogNavigationHorizontalThreshold	float		Framework/Application/NavigationConfig.h
AnalogNavigationVerticalThreshold	float		Framework/Application/NavigationConfig.h
AnalogVerticalKey	FKey	Which Axis Key controls vertical navigation	Framework/Application/NavigationConfig.h
bAnalogNavigation	bool	Should we respect the analog stick for navigation.	Framework/Application/NavigationConfig.h
bIgnoreModifiersForNavigationActions	bool	Should we ignore modifier keys when checking for navigation actions.	Framework/Application/NavigationConfig.h
bKeyNavigation	bool	Should we respect keys for navigation.	Framework/Application/NavigationConfig.h
bTabNavigation	bool	Should the Tab key perform next and previous style navigation.	Framework/Application/NavigationConfig.h
KeyActionRules	TMap< FKey, EUINavigationAction >	Digital key action rules.	Framework/Application/NavigationConfig.h
KeyEventRules	TMap< FKey, EUINavigation >	Digital key navigation rules.	Framework/Application/NavigationConfig.h

Functions

Public

Name	Remarks	Include Path
virtual EUINavigationAction GetNavigationActionForKey ( const FKey& InKey ) const		Framework/Application/NavigationConfig.h
virtual EUINavigationAction GetNavigationActionFromKey ( const FKeyEvent& InKeyEvent ) const	Returns the navigation action corresponding to a key event.	Framework/Application/NavigationConfig.h
virtual EUINavigation GetNavigationDirectionFromAnalog ( const FAnalogInputEvent& InAnalogEvent )	Gets the navigation direction from a given analog event.	Framework/Application/NavigationConfig.h
virtual EUINavigation GetNavigationDirectionFromKey ( const FKeyEvent& InKeyEvent ) const	Gets the navigation direction from a given key event.	Framework/Application/NavigationConfig.h
bool IsAnalogEventBeyondNavigationThreshold ( const FAnalogInputEvent& InAnalogEvent ) const	Returns whether the analog event is beyond the navigation thresholds set in this config.	Framework/Application/NavigationConfig.h
virtual void OnNavigationChangedFocus ( TSharedPtr< SWidget > OldWidget, TSharedPtr< SWidget > NewWidget, FFocusEvent FocusEvent )	Notified when navigation has caused a widget change to occur	Framework/Application/NavigationConfig.h
virtual void OnRegister()	Called when the navigation config is registered with Slate Application	Framework/Application/NavigationConfig.h
virtual void OnUnregister()	Called when the navigation config is registered with Slate Application	Framework/Application/NavigationConfig.h
virtual void OnUserRemoved ( int32 UserIndex )	Notified when users are removed from the system, good chance to clean up any user specific state.	Framework/Application/NavigationConfig.h
virtual FString ToString()	Simplification of config as string	Framework/Application/NavigationConfig.h

Protected

Name	Remarks	Include Path
virtual EUINavigation GetNavigationDirectionFromAnalogInternal ( const FAnalogInputEvent& InAnalogEvent )	Gets the navigation direction from the analog internally.	Framework/Application/NavigationConfig.h
virtual float GetRepeatRateForPressure ( float InPressure, int32 InRepeats ) const	Gets the repeat rate of the navigation based on the current pressure being applied.	Framework/Application/NavigationConfig.h
virtual bool IsAnalogHorizontalKey ( const FKey& InKey ) const		Framework/Application/NavigationConfig.h
virtual bool IsAnalogVerticalKey ( const FKey& InKey ) const		Framework/Application/NavigationConfig.h