mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class InteractableReceiverList

    An example of building an Interactable receiver that uses built-in receivers that extend ReceiverBase

    Inheritance
    Object
    ReceiverBaseMonoBehavior
    InteractableReceiverList
    Implements
    IInteractableHandler
    MonoBehaviour
    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, MonoBehaviour

    Fields

    Events

    List of events added to this interactable

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

    Events

    List of events added to this interactable

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

    Methods

    Awake()

    Declaration
    protected virtual void Awake()

    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)

    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)

    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)

    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()

    SetupEvents()

    starts the event system

    Declaration
    protected virtual void SetupEvents()

    Implements

    IInteractableHandler
    MonoBehaviour
    In This Article
    • Fields
      • Events
      • Events
    • Methods
      • Awake()
      • Awake()
      • OnClick(InteractableStates, Interactable, IMixedRealityPointer)
      • OnClick(InteractableStates, Interactable, IMixedRealityPointer)
      • OnStateChange(InteractableStates, Interactable)
      • OnStateChange(InteractableStates, Interactable)
      • OnVoiceCommand(InteractableStates, Interactable, String, Int32, Int32)
      • OnVoiceCommand(InteractableStates, Interactable, String, Int32, Int32)
      • SetupEvents()
      • SetupEvents()
    • Implements
    Back to top Generated by DocFX