Class XRSimpleInteractable

The simplest Interactable object which provides events for interaction states like hover and select.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

XRBaseInteractable

XRSimpleInteractable

Implements

IXRActivateInteractable

IXRHoverInteractable

IXRSelectInteractable

IXRFocusInteractable

IXRInteractionStrengthInteractable

IXRInteractable

IXROverridesGazeAutoSelect

Inherited Members

XRBaseInteractable.registered

XRBaseInteractable.unregistered

XRBaseInteractable.getDistanceOverride

XRBaseInteractable.interactionManager

XRBaseInteractable.colliders

XRBaseInteractable.interactionLayers

XRBaseInteractable.distanceCalculationMode

XRBaseInteractable.selectMode

XRBaseInteractable.focusMode

XRBaseInteractable.customReticle

XRBaseInteractable.allowGazeInteraction

XRBaseInteractable.allowGazeSelect

XRBaseInteractable.overrideGazeTimeToSelect

XRBaseInteractable.gazeTimeToSelect

XRBaseInteractable.overrideTimeToAutoDeselectGaze

XRBaseInteractable.timeToAutoDeselectGaze

XRBaseInteractable.allowGazeAssistance

XRBaseInteractable.firstHoverEntered

XRBaseInteractable.lastHoverExited

XRBaseInteractable.hoverEntered

XRBaseInteractable.hoverExited

XRBaseInteractable.firstSelectEntered

XRBaseInteractable.lastSelectExited

XRBaseInteractable.selectEntered

XRBaseInteractable.selectExited

XRBaseInteractable.firstFocusEntered

XRBaseInteractable.lastFocusExited

XRBaseInteractable.focusEntered

XRBaseInteractable.focusExited

XRBaseInteractable.activated

XRBaseInteractable.deactivated

XRBaseInteractable.interactorsHovering

XRBaseInteractable.isHovered

XRBaseInteractable.interactorsSelecting

XRBaseInteractable.firstInteractorSelecting

XRBaseInteractable.isSelected

XRBaseInteractable.interactionGroupsFocusing

XRBaseInteractable.firstInteractionGroupFocusing

XRBaseInteractable.isFocused

XRBaseInteractable.canFocus

XRBaseInteractable.startingHoverFilters

XRBaseInteractable.hoverFilters

XRBaseInteractable.startingSelectFilters

XRBaseInteractable.selectFilters

XRBaseInteractable.startingInteractionStrengthFilters

XRBaseInteractable.interactionStrengthFilters

XRBaseInteractable.largestInteractionStrength

XRBaseInteractable.Reset()

XRBaseInteractable.Awake()

XRBaseInteractable.OnEnable()

XRBaseInteractable.OnDisable()

XRBaseInteractable.OnDestroy()

XRBaseInteractable.GetAttachTransform(IXRInteractor)

XRBaseInteractable.GetAttachPoseOnSelect(IXRSelectInteractor)

XRBaseInteractable.GetLocalAttachPoseOnSelect(IXRSelectInteractor)

XRBaseInteractable.GetDistanceSqrToInteractor(IXRInteractor)

XRBaseInteractable.GetDistance(Vector3)

XRBaseInteractable.GetInteractionStrength(IXRInteractor)

XRBaseInteractable.IsHoverableBy(IXRHoverInteractor)

XRBaseInteractable.IsSelectableBy(IXRSelectInteractor)

XRBaseInteractable.IsHovered(IXRHoverInteractor)

XRBaseInteractable.IsSelected(IXRSelectInteractor)

XRBaseInteractable.IsHovered(IXRInteractor)

XRBaseInteractable.IsSelected(IXRInteractor)

XRBaseInteractable.GetCustomReticle(IXRInteractor)

XRBaseInteractable.AttachCustomReticle(IXRInteractor)

XRBaseInteractable.RemoveCustomReticle(IXRInteractor)

XRBaseInteractable.CaptureAttachPose(IXRSelectInteractor)

XRBaseInteractable.ProcessInteractable(XRInteractionUpdateOrder.UpdatePhase)

XRBaseInteractable.OnRegistered(InteractableRegisteredEventArgs)

XRBaseInteractable.OnUnregistered(InteractableUnregisteredEventArgs)

XRBaseInteractable.OnHoverEntering(HoverEnterEventArgs)

XRBaseInteractable.OnHoverEntered(HoverEnterEventArgs)

XRBaseInteractable.OnHoverExiting(HoverExitEventArgs)

XRBaseInteractable.OnHoverExited(HoverExitEventArgs)

XRBaseInteractable.OnSelectEntering(SelectEnterEventArgs)

XRBaseInteractable.OnSelectEntered(SelectEnterEventArgs)

XRBaseInteractable.OnSelectExiting(SelectExitEventArgs)

XRBaseInteractable.OnSelectExited(SelectExitEventArgs)

XRBaseInteractable.OnFocusEntering(FocusEnterEventArgs)

XRBaseInteractable.OnFocusEntered(FocusEnterEventArgs)

XRBaseInteractable.OnFocusExiting(FocusExitEventArgs)

XRBaseInteractable.OnFocusExited(FocusExitEventArgs)

XRBaseInteractable.OnActivated(ActivateEventArgs)

XRBaseInteractable.OnDeactivated(DeactivateEventArgs)

XRBaseInteractable.ProcessInteractionStrength(XRInteractionUpdateOrder.UpdatePhase)

XRBaseInteractable.ProcessHoverFilters(IXRHoverInteractor)

XRBaseInteractable.ProcessSelectFilters(IXRSelectInteractor)

XRBaseInteractable.ProcessInteractionStrengthFilters(IXRInteractor, float)

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Interaction.Toolkit.Interactables

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
[SelectionBase]
[DisallowMultipleComponent]
[AddComponentMenu("XR/XR Simple Interactable", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.1/api/UnityEngine.XR.Interaction.Toolkit.Interactables.XRSimpleInteractable.html")]
public class XRSimpleInteractable : XRBaseInteractable, IXRActivateInteractable, IXRHoverInteractable, IXRSelectInteractable, IXRFocusInteractable, IXRInteractionStrengthInteractable, IXRInteractable, IXROverridesGazeAutoSelect

Remarks

XRSimpleInteractable provides a concrete implementation of the XRBaseInteractable. A GameObject with this component responds to hoverEntered/hoverExited and selectEntered/selectExited events, but provides no default interaction behavior.

For more information refer to:

• XR Simple Interactable component
• Create a grab interactable
• UI interaction setup
• Interaction States

Implements

IXRActivateInteractable

IXRHoverInteractable

IXRSelectInteractable

IXRFocusInteractable

IXRInteractionStrengthInteractable

IXRInteractable

IXROverridesGazeAutoSelect

Extension Methods

XRFocusInteractableExtensions.GetOldestInteractorFocusing(IXRFocusInteractable)

XRHoverInteractableExtensions.GetOldestInteractorHovering(IXRHoverInteractable)

XRHoverInteractableExtensions.IsHoveredByLeft(IXRHoverInteractable)

XRHoverInteractableExtensions.IsHoveredByRight(IXRHoverInteractable)

XRSelectInteractableExtensions.GetOldestInteractorSelecting(IXRSelectInteractable)

XRSelectInteractableExtensions.IsSelectedByLeft(IXRSelectInteractable)

XRSelectInteractableExtensions.IsSelectedByRight(IXRSelectInteractable)