Class UIHoverEventArgs

Arguments passed to the UnityEvent that Unity invokes when an Interactor is hovering over a UI element.

Inheritance

object

UIHoverEventArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.Interaction.Toolkit.UI

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

public class UIHoverEventArgs

Properties

deviceModel

The TrackedDeviceModel corresponding to the controller or hand interacting with the UI element that is being hovered over.

Declaration

public TrackedDeviceModel deviceModel { get; set; }

Property Value

Type	Description
TrackedDeviceModel

interactorObject

The IUIInteractor that is hovering.

Declaration

public IUIInteractor interactorObject { get; set; }

Property Value

Type	Description
IUIInteractor

uiDocument

Optional reference to the UIDocument associated with the hovered VisualElement, if available. Will be null for uGUI (Unity UI) interactions or when no document can be determined.

Declaration

public UIDocument uiDocument { get; set; }

Property Value

Type	Description
UIDocument

uiObject

The object representing the hovered UI target. For uGUI (Unity UI), this is the Graphic's GameObject. For UI Toolkit, this is the panel host GameObject (e.g. the UIDocument GameObject), or null if not available.

Declaration

public GameObject uiObject { get; set; }

Property Value

Type	Description
GameObject

uiSystem

Indicates which UI system produced this hover event.

Declaration

public UIHoverEventArgs.UISystem uiSystem { get; set; }

Property Value

Type	Description
UIHoverEventArgs.UISystem

visualElement

For UI Toolkit interactions, the VisualElement being hovered. Will be null for uGUI (Unity UI) interactions.

Declaration

public VisualElement visualElement { get; set; }

Property Value

Type	Description
VisualElement