mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class EyeTrackingTarget

    A game object with the "EyeTrackingTarget" script attached reacts to being looked at independent of other available inputs.

    Inheritance
    Object
    InputSystemGlobalHandlerListener
    EyeTrackingTarget
    Implements
    MonoBehaviour
    IMixedRealityPointerHandler
    IMixedRealitySpeechHandler
    IMixedRealityBaseInputHandler
    IEventSystemHandler
    Inherited Members
    InputSystemGlobalHandlerListener.OnEnable()
    InputSystemGlobalHandlerListener.EnsureInputSystemValid()
    Namespace: Microsoft.MixedReality.Toolkit.Input
    Assembly: cs.temp.dll.dll
    Syntax
    public class EyeTrackingTarget : InputSystemGlobalHandlerListener, MonoBehaviour, IMixedRealityPointerHandler, IMixedRealitySpeechHandler, IMixedRealityBaseInputHandler, IEventSystemHandler

    Properties

    EyeCursorSnapToTargetCenter

    If true, the eye cursor (if enabled) will snap to the center of this object.

    Declaration
    public bool EyeCursorSnapToTargetCenter { get; set; }
    Property Value
    Type Description
    Boolean

    EyeCursorSnapToTargetCenter

    If true, the eye cursor (if enabled) will snap to the center of this object.

    Declaration
    public bool EyeCursorSnapToTargetCenter { get; set; }
    Property Value
    Type Description
    Boolean

    IsDwelledOn

    Returns true if the user has been looking at the target for a certain amount of time specified by dwellTimeInSec.

    Declaration
    public bool IsDwelledOn { get; }
    Property Value
    Type Description
    Boolean

    IsDwelledOn

    Returns true if the user has been looking at the target for a certain amount of time specified by dwellTimeInSec.

    Declaration
    public bool IsDwelledOn { get; }
    Property Value
    Type Description
    Boolean

    IsLookedAt

    Returns true if the user looks at the target or more specifically when the eye gaze ray intersects with the target's bounding box.

    Declaration
    public bool IsLookedAt { get; }
    Property Value
    Type Description
    Boolean

    IsLookedAt

    Returns true if the user looks at the target or more specifically when the eye gaze ray intersects with the target's bounding box.

    Declaration
    public bool IsLookedAt { get; }
    Property Value
    Type Description
    Boolean

    LookedAtEyeTarget

    Declaration
    public static EyeTrackingTarget LookedAtEyeTarget { get; }
    Property Value
    Type Description
    EyeTrackingTarget

    LookedAtEyeTarget

    Declaration
    public static EyeTrackingTarget LookedAtEyeTarget { get; }
    Property Value
    Type Description
    EyeTrackingTarget

    LookedAtPoint

    Declaration
    public static Vector3 LookedAtPoint { get; }
    Property Value
    Type Description
    Vector3

    LookedAtPoint

    Declaration
    public static Vector3 LookedAtPoint { get; }
    Property Value
    Type Description
    Vector3

    LookedAtTarget

    Declaration
    public static GameObject LookedAtTarget { get; }
    Property Value
    Type Description
    GameObject

    LookedAtTarget

    Declaration
    public static GameObject LookedAtTarget { get; }
    Property Value
    Type Description
    GameObject

    OnDwell

    Event is triggered when the target has been looked at for a given predefined duration (dwellTimeInSec).

    Declaration
    public UnityEvent OnDwell { get; set; }
    Property Value
    Type Description
    UnityEvent

    OnDwell

    Event is triggered when the target has been looked at for a given predefined duration (dwellTimeInSec).

    Declaration
    public UnityEvent OnDwell { get; set; }
    Property Value
    Type Description
    UnityEvent

    OnLookAtStart

    Event is triggered when the user starts to look at the target.

    Declaration
    public UnityEvent OnLookAtStart { get; set; }
    Property Value
    Type Description
    UnityEvent

    OnLookAtStart

    Event is triggered when the user starts to look at the target.

    Declaration
    public UnityEvent OnLookAtStart { get; set; }
    Property Value
    Type Description
    UnityEvent

    OnLookAway

    Event to be triggered when the user is looking away from the target.

    Declaration
    public UnityEvent OnLookAway { get; set; }
    Property Value
    Type Description
    UnityEvent

    OnLookAway

    Event to be triggered when the user is looking away from the target.

    Declaration
    public UnityEvent OnLookAway { get; set; }
    Property Value
    Type Description
    UnityEvent

    OnSelected

    Event is triggered when the looked at target is selected.

    Declaration
    public UnityEvent OnSelected { get; set; }
    Property Value
    Type Description
    UnityEvent

    OnSelected

    Event is triggered when the looked at target is selected.

    Declaration
    public UnityEvent OnSelected { get; set; }
    Property Value
    Type Description
    UnityEvent

    WhileLookingAtTarget

    Event is triggered when the user continues to look at the target.

    Declaration
    public UnityEvent WhileLookingAtTarget { get; set; }
    Property Value
    Type Description
    UnityEvent

    WhileLookingAtTarget

    Event is triggered when the user continues to look at the target.

    Declaration
    public UnityEvent WhileLookingAtTarget { get; set; }
    Property Value
    Type Description
    UnityEvent

    Methods

    OnDisable()

    Declaration
    protected override void OnDisable()
    Overrides
    InputSystemGlobalHandlerListener.OnDisable()

    OnDisable()

    Declaration
    protected override void OnDisable()
    Overrides
    InputSystemGlobalHandlerListener.OnDisable()

    OnEyeFocusDwell()

    Declaration
    protected void OnEyeFocusDwell()

    OnEyeFocusDwell()

    Declaration
    protected void OnEyeFocusDwell()

    OnEyeFocusStart()

    Declaration
    protected void OnEyeFocusStart()

    OnEyeFocusStart()

    Declaration
    protected void OnEyeFocusStart()

    OnEyeFocusStay()

    Declaration
    protected void OnEyeFocusStay()

    OnEyeFocusStay()

    Declaration
    protected void OnEyeFocusStay()

    OnEyeFocusStop()

    Declaration
    protected void OnEyeFocusStop()

    OnEyeFocusStop()

    Declaration
    protected void OnEyeFocusStop()

    RegisterHandlers()

    Declaration
    protected override void RegisterHandlers()
    Overrides
    InputSystemGlobalHandlerListener.RegisterHandlers()

    RegisterHandlers()

    Declaration
    protected override void RegisterHandlers()
    Overrides
    InputSystemGlobalHandlerListener.RegisterHandlers()

    Start()

    Declaration
    protected override void Start()
    Overrides
    InputSystemGlobalHandlerListener.Start()

    Start()

    Declaration
    protected override void Start()
    Overrides
    InputSystemGlobalHandlerListener.Start()

    UnregisterHandlers()

    Declaration
    protected override void UnregisterHandlers()
    Overrides
    InputSystemGlobalHandlerListener.UnregisterHandlers()

    UnregisterHandlers()

    Declaration
    protected override void UnregisterHandlers()
    Overrides
    InputSystemGlobalHandlerListener.UnregisterHandlers()

    Explicit Interface Implementations

    IMixedRealityPointerHandler.OnPointerClicked(MixedRealityPointerEventData)

    Declaration
    void IMixedRealityPointerHandler.OnPointerClicked(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    IMixedRealityPointerHandler.OnPointerClicked(MixedRealityPointerEventData)

    Declaration
    void IMixedRealityPointerHandler.OnPointerClicked(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData)

    Declaration
    void IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData)

    Declaration
    void IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    IMixedRealityPointerHandler.OnPointerDragged(MixedRealityPointerEventData)

    Declaration
    void IMixedRealityPointerHandler.OnPointerDragged(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    IMixedRealityPointerHandler.OnPointerDragged(MixedRealityPointerEventData)

    Declaration
    void IMixedRealityPointerHandler.OnPointerDragged(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    IMixedRealityPointerHandler.OnPointerUp(MixedRealityPointerEventData)

    Declaration
    void IMixedRealityPointerHandler.OnPointerUp(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    IMixedRealityPointerHandler.OnPointerUp(MixedRealityPointerEventData)

    Declaration
    void IMixedRealityPointerHandler.OnPointerUp(MixedRealityPointerEventData eventData)
    Parameters
    Type Name Description
    MixedRealityPointerEventData eventData

    IMixedRealitySpeechHandler.OnSpeechKeywordRecognized(SpeechEventData)

    Declaration
    void IMixedRealitySpeechHandler.OnSpeechKeywordRecognized(SpeechEventData eventData)
    Parameters
    Type Name Description
    SpeechEventData eventData

    IMixedRealitySpeechHandler.OnSpeechKeywordRecognized(SpeechEventData)

    Declaration
    void IMixedRealitySpeechHandler.OnSpeechKeywordRecognized(SpeechEventData eventData)
    Parameters
    Type Name Description
    SpeechEventData eventData

    Implements

    MonoBehaviour
    IMixedRealityPointerHandler
    IMixedRealitySpeechHandler
    IMixedRealityBaseInputHandler
    IEventSystemHandler
    In This Article
    • Properties
      • EyeCursorSnapToTargetCenter
      • EyeCursorSnapToTargetCenter
      • IsDwelledOn
      • IsDwelledOn
      • IsLookedAt
      • IsLookedAt
      • LookedAtEyeTarget
      • LookedAtEyeTarget
      • LookedAtPoint
      • LookedAtPoint
      • LookedAtTarget
      • LookedAtTarget
      • OnDwell
      • OnDwell
      • OnLookAtStart
      • OnLookAtStart
      • OnLookAway
      • OnLookAway
      • OnSelected
      • OnSelected
      • WhileLookingAtTarget
      • WhileLookingAtTarget
    • Methods
      • OnDisable()
      • OnDisable()
      • OnEyeFocusDwell()
      • OnEyeFocusDwell()
      • OnEyeFocusStart()
      • OnEyeFocusStart()
      • OnEyeFocusStay()
      • OnEyeFocusStay()
      • OnEyeFocusStop()
      • OnEyeFocusStop()
      • RegisterHandlers()
      • RegisterHandlers()
      • Start()
      • Start()
      • UnregisterHandlers()
      • UnregisterHandlers()
    • Explicit Interface Implementations
      • IMixedRealityPointerHandler.OnPointerClicked(MixedRealityPointerEventData)
      • IMixedRealityPointerHandler.OnPointerClicked(MixedRealityPointerEventData)
      • IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData)
      • IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData)
      • IMixedRealityPointerHandler.OnPointerDragged(MixedRealityPointerEventData)
      • IMixedRealityPointerHandler.OnPointerDragged(MixedRealityPointerEventData)
      • IMixedRealityPointerHandler.OnPointerUp(MixedRealityPointerEventData)
      • IMixedRealityPointerHandler.OnPointerUp(MixedRealityPointerEventData)
      • IMixedRealitySpeechHandler.OnSpeechKeywordRecognized(SpeechEventData)
      • IMixedRealitySpeechHandler.OnSpeechKeywordRecognized(SpeechEventData)
    • Implements
    Back to top Generated by DocFX