Class EyeTrackingTarget

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

Inheritance
Object
InputSystemGlobalHandlerListener
EyeTrackingTarget
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Input
Assembly: cs.temp.dll.dll
Syntax
public class EyeTrackingTarget : InputSystemGlobalHandlerListener, 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

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

LookedAtEyeTarget

EyeTrackingTarget eye gaze is currently looking at. null if currently gazed at object has no EyeTrackingTarget, or if no object with collider is being looked at.

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

LookedAtPoint

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

LookedAtTarget

GameObject eye gaze is currently targeting, updated once per frame. null if no object with colllider is currently being looked at.

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

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

OnSelected

Event is triggered when the looked at target is selected.

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

OnTapDown

Event is triggered when the RaiseEventManually_TapDown is called.

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

OnTapUp

Event is triggered when the RaiseEventManually_TapUp is called.

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

SelectedTarget

Most recently selected target, selected either using pointer or voice.

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

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

OnEyeFocusDwell()

Declaration
protected void OnEyeFocusDwell()

OnEyeFocusStart()

Declaration
protected void OnEyeFocusStart()

OnEyeFocusStay()

Declaration
protected void OnEyeFocusStay()

OnEyeFocusStop()

Declaration
protected void OnEyeFocusStop()

RaiseSelectEventManually()

Declaration
public void RaiseSelectEventManually()

RegisterHandlers()

Overload this method to specify, which global events component wants to listen to. Use RegisterHandler API of InputSystem

Declaration
protected override void RegisterHandlers()
Overrides

Start()

Declaration
protected override void Start()
Overrides

UnregisterHandlers()

Overload this method to specify, which global events component should stop listening to. Use UnregisterHandler API of InputSystem

Declaration
protected override void UnregisterHandlers()
Overrides

Explicit Interface Implementations

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.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

IMixedRealitySpeechHandler.OnSpeechKeywordRecognized(SpeechEventData)

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

Implements

IEventSystemHandler