We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Class InteractableReceiverList

    An example of building an Interactable receiver that uses built-in receivers that extend ReceiverBase This is a mono behavior, place on a gameObject and assign the Interactable

    Inheritance
    Object
    ReceiverBaseMonoBehavior
    InteractableReceiverList
    Implements
    IInteractableHandler
    Inherited Members
    ReceiverBaseMonoBehavior.Interactable
    ReceiverBaseMonoBehavior.InteractableSearchScope
    ReceiverBaseMonoBehavior.lastState
    ReceiverBaseMonoBehavior.OnEnable()
    ReceiverBaseMonoBehavior.AddInteractable(Interactable)
    ReceiverBaseMonoBehavior.OnDisable()
    ReceiverBaseMonoBehavior.Update()
    Namespace: Microsoft.MixedReality.Toolkit.UI
    Assembly: cs.temp.dll.dll
    Syntax
    public class InteractableReceiverList : ReceiverBaseMonoBehavior, IInteractableHandler

    Fields

    Events

    Declaration
    public List<InteractableEvent> Events
    Field Value
    Type Description
    List<InteractableEvent>

    Methods

    Awake()

    Declaration
    protected virtual void Awake()

    OnClick(InteractableStates, Interactable, IMixedRealityPointer)

    captures click events

    Declaration
    public override void OnClick(InteractableStates state, Interactable source, IMixedRealityPointer pointer = null)
    Parameters
    Type Name Description
    InteractableStates state
    Interactable source
    IMixedRealityPointer pointer
    Overrides
    ReceiverBaseMonoBehavior.OnClick(InteractableStates, Interactable, IMixedRealityPointer)

    OnStateChange(InteractableStates, Interactable)

    .A state has changed

    Declaration
    public override void OnStateChange(InteractableStates state, Interactable source)
    Parameters
    Type Name Description
    InteractableStates state
    Interactable source
    Overrides
    ReceiverBaseMonoBehavior.OnStateChange(InteractableStates, Interactable)

    OnVoiceCommand(InteractableStates, Interactable, String, Int32, Int32)

    captures voice commands

    Declaration
    public override void OnVoiceCommand(InteractableStates state, Interactable source, string command, int index = 0, int length = 1)
    Parameters
    Type Name Description
    InteractableStates state
    Interactable source
    String command
    Int32 index

    index of the voice command

    Int32 length

    voice command array length

    Overrides
    ReceiverBaseMonoBehavior.OnVoiceCommand(InteractableStates, Interactable, String, Int32, Int32)

    SetupEvents()

    starts the event system

    Declaration
    protected virtual void SetupEvents()

    Implements

    IInteractableHandler
    Back to top Generated by DocFX