mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class InteractableToggleCollection

    A way to control a list of radial type buttons or tabs

    Inheritance
    Object
    InteractableToggleCollection
    Implements
    MonoBehaviour
    Namespace: Microsoft.MixedReality.Toolkit.UI
    Assembly: cs.temp.dll.dll
    Syntax
    public class InteractableToggleCollection : MonoBehaviour, MonoBehaviour

    Fields

    OnSelectionEvents

    Declaration
    public UnityEvent OnSelectionEvents
    Field Value
    Type Description
    UnityEvent

    OnSelectionEvents

    Declaration
    public UnityEvent OnSelectionEvents
    Field Value
    Type Description
    UnityEvent

    Properties

    CurrentIndex

    The current index in the array of interactable toggles

    Declaration
    public int CurrentIndex { get; set; }
    Property Value
    Type Description
    Int32

    CurrentIndex

    The current index in the array of interactable toggles

    Declaration
    public int CurrentIndex { get; set; }
    Property Value
    Type Description
    Int32

    ToggleList

    Array of Interactables that will be managed by this controller

    Declaration
    public Interactable[] ToggleList { get; set; }
    Property Value
    Type Description
    Interactable[]

    ToggleList

    Array of Interactables that will be managed by this controller

    Declaration
    public Interactable[] ToggleList { get; set; }
    Property Value
    Type Description
    Interactable[]

    Methods

    OnSelection(Int32, Boolean)

    Declaration
    protected virtual void OnSelection(int index, bool force = false)
    Parameters
    Type Name Description
    Int32 index
    Boolean force

    OnSelection(Int32, Boolean)

    Declaration
    protected virtual void OnSelection(int index, bool force = false)
    Parameters
    Type Name Description
    Int32 index
    Boolean force

    SetSelection(Int32, Boolean, Boolean)

    Set the selection of a an element in the toggle collection based on index.

    Index of an element in ToggleList Force selection set The manual trigger of the OnClick event. OnClick event is manually triggered when the CurrentIndex is updated via script or inspector
    Declaration
    public void SetSelection(int index, bool force = false, bool fireOnClick = false)
    Parameters
    Type Name Description
    Int32 index
    Boolean force
    Boolean fireOnClick

    SetSelection(Int32, Boolean, Boolean)

    Set the selection of a an element in the toggle collection based on index.

    Index of an element in ToggleList Force selection set The manual trigger of the OnClick event. OnClick event is manually triggered when the CurrentIndex is updated via script or inspector
    Declaration
    public void SetSelection(int index, bool force = false, bool fireOnClick = false)
    Parameters
    Type Name Description
    Int32 index
    Boolean force
    Boolean fireOnClick

    Implements

    MonoBehaviour
    In This Article
    • Fields
      • OnSelectionEvents
      • OnSelectionEvents
    • Properties
      • CurrentIndex
      • CurrentIndex
      • ToggleList
      • ToggleList
    • Methods
      • OnSelection(Int32, Boolean)
      • OnSelection(Int32, Boolean)
      • SetSelection(Int32, Boolean, Boolean)
      • SetSelection(Int32, Boolean, Boolean)
    • Implements
    Back to top Generated by DocFX