Modifier

Partager via


DwellHandler Class

Definition

Use this component to add a Dwell modality (https://docs.microsoft.com/windows/mixed-reality/gaze-and-dwell) to the UI target.

public ref class DwellHandler : UnityEngine::MonoBehaviour, Microsoft::MixedReality::Toolkit::Input::IMixedRealityFocusHandler, UnityEngine::EventSystems::IEventSystemHandler
public ref class DwellHandler : UnityEngine::MonoBehaviour, Microsoft::MixedReality::Toolkit::Input::IMixedRealityFocusChangedHandler, UnityEngine::EventSystems::IEventSystemHandler
[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/DwellHandler")]
public class DwellHandler : UnityEngine.MonoBehaviour, Microsoft.MixedReality.Toolkit.Input.IMixedRealityFocusHandler, UnityEngine.EventSystems.IEventSystemHandler
[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/DwellHandler")]
public class DwellHandler : UnityEngine.MonoBehaviour, Microsoft.MixedReality.Toolkit.Input.IMixedRealityFocusChangedHandler, UnityEngine.EventSystems.IEventSystemHandler
[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/DwellHandler")>]
type DwellHandler = class
    inherit MonoBehaviour
    interface IMixedRealityFocusHandler
    interface IEventSystemHandler
[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/DwellHandler")>]
type DwellHandler = class
    inherit MonoBehaviour
    interface IMixedRealityFocusChangedHandler
    interface IEventSystemHandler
Public Class DwellHandler
Inherits MonoBehaviour
Implements IEventSystemHandler, IMixedRealityFocusHandler
Public Class DwellHandler
Inherits MonoBehaviour
Implements IEventSystemHandler, IMixedRealityFocusChangedHandler
Inheritance
UnityEngine.MonoBehaviour
DwellHandler
Derived
Attributes
UnityEngine.AddComponentMenuAttribute
Implements
IMixedRealityFocusHandler UnityEngine.EventSystems.IEventSystemHandler IMixedRealityFocusChangedHandler

Constructors

DwellHandler()

Fields

CurrentDwellState

Captures the dwell status

dwellProfile
FillTimer

Abstracted value for the how long the dwelled object still needs to be focused to complete the dwell action Value ranges from 0 to "TimeToCompleteDwell" setting in the dwellprofile. This picks up the same unit as TimeToCompleteDwell

Properties

DwellProgress

Property exposing the computation for what percentage of dwell has progressed.

HasFocus

Exposes whether the target has focus from the pointer type defined in dwell profile settings

Methods

CancelDwell()

Method that can be invoked if external factors (e.g. alternate input modality preemptively invoked the target) force the dwell action to prematurely end

OnBeforeFocusChange(FocusEventData)
OnFocusChanged(FocusEventData)
OnFocusEnter(FocusEventData)
OnFocusExit(FocusEventData)
UpdateFillTimer()

Default FillTimer computation based on profile settings

Applies to