Class XRHoverInteractableExtensions
Extension methods for IXRHoverInteractable.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.Interactables
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public static class XRHoverInteractableExtensions
Methods
GetOldestInteractorHovering(IXRHoverInteractable)
Gets the oldest interactor currently hovering on this interactable. This is a convenience method for when the interactable does not support being hovered by multiple interactors at a time.
Declaration
public static IXRHoverInteractor GetOldestInteractorHovering(this IXRHoverInteractable interactable)
Parameters
Type | Name | Description |
---|---|---|
IXRHoverInteractable | interactable | The interactable to operate on. |
Returns
Type | Description |
---|---|
IXRHoverInteractor | Returns the oldest interactor currently hovering on this interactable. |
Remarks
Equivalent to interactorsHovering.Count > 0 ? interactorsHovering[0] : null
See Also
IsHoveredByLeft(IXRHoverInteractable)
Gets whether the interactable is currently being hovered by an interactor associated with the left hand or controller.
Declaration
public static bool IsHoveredByLeft(this IXRHoverInteractable interactable)
Parameters
Type | Name | Description |
---|---|---|
IXRHoverInteractable | interactable | The interactable to operate on. |
Returns
Type | Description |
---|---|
bool | Returns true if any interactor currently hovering this interactable has handedness of Left. |
Remarks
This method will return true even if it is not exclusively being hovered by the left hand or controller. In other words, it will still return true if the interactable is also being hovered by an interactor associated with the right hand or controller.
See Also
IsHoveredByRight(IXRHoverInteractable)
Gets whether the interactable is currently being hovered by an interactor associated with the right hand or controller.
Declaration
public static bool IsHoveredByRight(this IXRHoverInteractable interactable)
Parameters
Type | Name | Description |
---|---|---|
IXRHoverInteractable | interactable | The interactable to operate on. |
Returns
Type | Description |
---|---|
bool | Returns true if any interactor currently hovering this interactable has handedness of Right. |
Remarks
This method will return true even if it is not exclusively being hovered by the right hand or controller. In other words, it will still return true if the interactable is also being hovered by an interactor associated with the left hand or controller.