Interface IUIHoverInteractor
Matches the UI Model to the state of the Interactor with support for hover events.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.UI
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
public interface IUIHoverInteractor : IUIInteractorProperties
uiHoverEntered
The event that is called when the Interactor begins hovering over a UI element.
Declaration
UIHoverEnterEvent uiHoverEntered { get; }Property Value
| Type | Description |
|---|---|
| UIHoverEnterEvent |
Remarks
The UIHoverEventArgs passed to each listener is only valid while the event is invoked, do not hold a reference to it.
uiHoverExited
The event that is called when this Interactor ends hovering over a UI element.
Declaration
UIHoverExitEvent uiHoverExited { get; }Property Value
| Type | Description |
|---|---|
| UIHoverExitEvent |
Remarks
The UIHoverEventArgs passed to each listener is only valid while the event is invoked, do not hold a reference to it.
Methods
OnUIHoverEntered(UIHoverEventArgs)
The XRUIInputModule calls this method when the Interactor begins hovering over a UI element.
Declaration
void OnUIHoverEntered(UIHoverEventArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| UIHoverEventArgs | args | Event data containing the UI element that is being hovered over. |
Remarks
args is only valid during this method call, do not hold a reference to it.
See Also
OnUIHoverExited(UIHoverEventArgs)
The XRUIInputModule calls this method when the Interactor ends hovering over a UI element.
Declaration
void OnUIHoverExited(UIHoverEventArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| UIHoverEventArgs | args | Event data containing the UI element that is no longer hovered over. |
Remarks
args is only valid during this method call, do not hold a reference to it.