TextStudio3DNavigationGroup
[ExecuteAlways][AddComponentMenu("Text Studio/Spatial UI/3D Navigation Group")][DisallowMultipleComponent]public sealed class TextStudio3DNavigationGroup : MonoBehaviourOwns focus navigation across spatial controls using explicit links, order, or position-based scoring.
Methods
Section titled “Methods”
RefreshControls()
Section titled “RefreshControls()”public void RefreshControls()Rebuilds the navigation order from descendants when enabled and repairs or initializes focus.
SetControls(TextStudio3DControl[])
Section titled “SetControls(TextStudio3DControl[])”public void SetControls(TextStudio3DControl[] controls)Switches to an explicit defensive copy of controls and repairs the selected focus target.
Parameters
| Name | Type |
|---|---|
controls |
TextStudio.ThreeD.TextStudio3DControl[] |
Select(TextStudio3DControl)
Section titled “Select(TextStudio3DControl)”public bool Select(TextStudio3DControl control)Selects a configured, active, interactable control by reference.
Parameters
| Name | Type |
|---|---|
control |
TextStudio.ThreeD.TextStudio3DControl |
Returns
System.Boolean: True when the requested control now owns navigation focus.
Select(int)
Section titled “Select(int)”public bool Select(int index)Selects a configured, active, interactable control by zero-based navigation index.
Parameters
| Name | Type |
|---|---|
index |
System.Int32 |
Returns
System.Boolean: True when the requested index now owns navigation focus.
SelectFirst()
Section titled “SelectFirst()”public bool SelectFirst()Selects the first active interactable control in navigation order.
Returns
System.Boolean
Move(TextStudio3DNavigationDirection)
Section titled “Move(TextStudio3DNavigationDirection)”public bool Move(TextStudio3DNavigationDirection direction)Moves focus through an explicit link, spatial scoring, or ordered next/previous navigation.
Parameters
| Name | Type |
|---|---|
direction |
TextStudio.ThreeD.TextStudio3DNavigationDirection |
Returns
System.Boolean: True when a destination accepted focus.
MoveNext()
Section titled “MoveNext()”public bool MoveNext()Moves focus to the next interactable control, optionally wrapping at the end.
Returns
System.Boolean
MovePrevious()
Section titled “MovePrevious()”public bool MovePrevious()Moves focus to the preceding interactable control, optionally wrapping at the beginning.
Returns
System.Boolean
Submit()
Section titled “Submit()”public bool Submit()Programmatically activates the selected interactable control with navigation interaction identity.
Returns
System.Boolean: True when a selected control was activated.
Cancel()
Section titled “Cancel()”public void Cancel()Raises the navigation cancel event without changing the selected control.
ClearSelection(bool)
Section titled “ClearSelection(bool)”public void ClearSelection(bool notify)Clears navigation focus and optionally publishes a null selection.
Parameters
| Name | Type |
|---|---|
notify |
System.Boolean |
Constructors
Section titled “Constructors”
TextStudio3DNavigationGroup()
Section titled “TextStudio3DNavigationGroup()”public TextStudio3DNavigationGroup()Properties
Section titled “Properties”
SelectedIndex
Section titled “SelectedIndex”public int SelectedIndex { get; }Returns
System.Int32
SelectedControl
Section titled “SelectedControl”public TextStudio3DControl SelectedControl { get; }Returns
TextStudio.ThreeD.TextStudio3DControl
UseChildControls
Section titled “UseChildControls”public bool UseChildControls { get; set; }Returns
System.Boolean
SpatialNavigation
Section titled “SpatialNavigation”public bool SpatialNavigation { get; set; }Returns
System.Boolean
public bool Wrap { get; set; }Returns
System.Boolean
UseLegacyKeyboard
Section titled “UseLegacyKeyboard”public bool UseLegacyKeyboard { get; set; }Returns
System.Boolean
OnSelectionChanged
Section titled “OnSelectionChanged”public UnityEvent<TextStudio3DControl> OnSelectionChanged { get; }Returns
UnityEngine.Events.UnityEvent{TextStudio.ThreeD.TextStudio3DControl}
OnSubmitted
Section titled “OnSubmitted”public UnityEvent<TextStudio3DControl> OnSubmitted { get; }Returns
UnityEngine.Events.UnityEvent{TextStudio.ThreeD.TextStudio3DControl}
OnCancelled
Section titled “OnCancelled”public UnityEvent OnCancelled { get; }Returns
UnityEngine.Events.UnityEvent