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

IFocusRing

interface in UnityEngine.UIElements

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

Description

Interface for classes implementing focus rings.

When the EventDispatcher processes navigation and pointer events, it automatically uses this interface to generate corresponding Focus events if applicable.

Each Panel's FocusController has a focus ring implementation automatically assigned to it. The type of that focus ring depends on the associated Panel's ContextType.

For Editor-type Panels, only NavigationMoveEvent events in the following directions are considered:

For Player-type Panels, the following directions are also considered:

See also How can I change what element is focused next for an example of a workaround solution if the assigned focus ring navigation rules don't correspond to your needs.

Additional resources: FocusController

Public Methods

GetFocusChangeDirection Get the direction of the focus change for the given event.
GetNextFocusable Get the next element in the given direction.