Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

IFocusRing.GetFocusChangeDirection

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public UIElements.FocusChangeDirection GetFocusChangeDirection(UIElements.Focusable currentFocusable, UIElements.EventBase e);

Description

Get the direction of the focus change for the given event.

For example, in a VisualElementFocusRing, when the Tab key is pressed, the focus change direction should be VisualElementFocusChangeDirection.right.

When the EventDispatcher processes navigation and pointer events, it automatically calls this method to generate Focus events.

The Focus event's IFocusEvent.direction matches the value returned by this method to generate it.