Namespace Microsoft.MixedReality.Toolkit.Experimental.Dwell

Classes

BaseDwellSample

Example script to demonstrate dwell visuals in sample scene

CustomDwellHandler

Example to demonstrate DwellHandler override

DwellHandler

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

DwellProfile

DwellProfileWithDecay

Custom profile for the extended dwell profile sample

DwellUnityEvent

Unity event for a dwell event. Contains the pointer reference.

InstantDwellSample

Dwell sample with no DwellIntended delay

ListItemDwell

Dwell sample to work on a list of dwell targets

ToggleDwellSample

Example script to demonstrate a toggle button using dwell

Enums

DwellHandler.DwellStateType

None = 0 - Default state FocusGained - State reached when Focus enters target DwellIntended - State reached when Focus stays on target for dwellIntentDelay seconds. Signifies user's intent to interact with the target. DwellStarted - State reached when Focus stays on target for dwellIntentDelay + dwellStartDelay seconds. Typically tied to invoke feedback for dwell. DwellCompleted - State reached when Focus stays on target for dwellIntentDelay + dwellStartDelay + timeToCompleteDwell seconds. Typically invokes the button clicked event. DwellCanceled - State reached when DwellStarted state is reached but focus exits the target before timeToCompleteDwell.

DwellHandler.DwellStateType

None = 0 - Default state FocusGained - State reached when Focus enters target DwellIntended - State reached when Focus stays on target for dwellIntentDelay seconds. Signifies user's intent to interact with the target. DwellStarted - State reached when Focus stays on target for dwellIntentDelay + dwellStartDelay seconds. Typically tied to invoke feedback for dwell. DwellCompleted - State reached when Focus stays on target for dwellIntentDelay + dwellStartDelay + timeToCompleteDwell seconds. Typically invokes the button clicked event. DwellCanceled - State reached when DwellStarted state is reached but focus exits the target before timeToCompleteDwell.