Class ARGestureInteractor

The ARGestureInteractor allows the user to manipulate virtual objects (select, translate, rotate, scale, and elevate) through gestures (tap, drag, twist, and pinch).

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

XRBaseInteractor

ARGestureInteractor

Implements

IXRHoverInteractor

IXRSelectInteractor

IXRTargetPriorityInteractor

IXRGroupMember

IXRInteractionStrengthInteractor

IXRInteractor

Inherited Members

XRBaseInteractor.registered

XRBaseInteractor.unregistered

XRBaseInteractor.interactionManager

XRBaseInteractor.containingGroup

XRBaseInteractor.interactionLayers

XRBaseInteractor.attachTransform

XRBaseInteractor.keepSelectedTargetValid

XRBaseInteractor.disableVisualsWhenBlockedInGroup

XRBaseInteractor.startingSelectedInteractable

XRBaseInteractor.startingTargetFilter

XRBaseInteractor.hoverEntered

XRBaseInteractor.hoverExited

XRBaseInteractor.selectEntered

XRBaseInteractor.selectExited

XRBaseInteractor.targetFilter

XRBaseInteractor.allowHover

XRBaseInteractor.allowSelect

XRBaseInteractor.isPerformingManualInteraction

XRBaseInteractor.interactablesHovered

XRBaseInteractor.hasHover

XRBaseInteractor.interactablesSelected

XRBaseInteractor.firstInteractableSelected

XRBaseInteractor.hasSelection

XRBaseInteractor.startingHoverFilters

XRBaseInteractor.hoverFilters

XRBaseInteractor.startingSelectFilters

XRBaseInteractor.selectFilters

XRBaseInteractor.largestInteractionStrength

XRBaseInteractor.Reset()

XRBaseInteractor.Start()

XRBaseInteractor.OnDestroy()

XRBaseInteractor.GetAttachTransform(IXRInteractable)

XRBaseInteractor.GetAttachPoseOnSelect(IXRSelectInteractable)

XRBaseInteractor.GetLocalAttachPoseOnSelect(IXRSelectInteractable)

XRBaseInteractor.isHoverActive

XRBaseInteractor.isSelectActive

XRBaseInteractor.targetPriorityMode

XRBaseInteractor.targetsForSelection

XRBaseInteractor.CanHover(IXRHoverInteractable)

XRBaseInteractor.CanSelect(IXRSelectInteractable)

XRBaseInteractor.IsHovering(IXRHoverInteractable)

XRBaseInteractor.IsSelecting(IXRSelectInteractable)

XRBaseInteractor.IsHovering(IXRInteractable)

XRBaseInteractor.IsSelecting(IXRInteractable)

XRBaseInteractor.selectedInteractableMovementTypeOverride

XRBaseInteractor.CaptureAttachPose(IXRSelectInteractable)

XRBaseInteractor.CreateAttachTransform()

XRBaseInteractor.PreprocessInteractor(XRInteractionUpdateOrder.UpdatePhase)

XRBaseInteractor.GetInteractionStrength(IXRInteractable)

XRBaseInteractor.OnHoverEntering(HoverEnterEventArgs)

XRBaseInteractor.OnHoverEntered(HoverEnterEventArgs)

XRBaseInteractor.OnHoverExiting(HoverExitEventArgs)

XRBaseInteractor.OnHoverExited(HoverExitEventArgs)

XRBaseInteractor.OnSelectEntering(SelectEnterEventArgs)

XRBaseInteractor.OnSelectEntered(SelectEnterEventArgs)

XRBaseInteractor.OnSelectExiting(SelectExitEventArgs)

XRBaseInteractor.OnSelectExited(SelectExitEventArgs)

XRBaseInteractor.ProcessInteractionStrength(XRInteractionUpdateOrder.UpdatePhase)

XRBaseInteractor.StartManualInteraction(IXRSelectInteractable)

XRBaseInteractor.EndManualInteraction()

XRBaseInteractor.ProcessHoverFilters(IXRHoverInteractable)

XRBaseInteractor.ProcessSelectFilters(IXRSelectInteractable)

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.AR

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[AddComponentMenu("XR/AR Gesture Interactor", 22)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.6/api/UnityEngine.XR.Interaction.Toolkit.AR.ARGestureInteractor.html")]
public class ARGestureInteractor : XRBaseInteractor, IXRHoverInteractor, IXRSelectInteractor, IXRTargetPriorityInteractor, IXRGroupMember, IXRInteractionStrengthInteractor, IXRInteractor

Remarks

To make use of this, add an ARGestureInteractor to your scene and an ARBaseGestureInteractable to any of your virtual objects.

Properties

dragGestureRecognizer

(Read Only) The Drag gesture recognizer.

Declaration

public DragGestureRecognizer dragGestureRecognizer { get; }

Property Value

Type	Description
DragGestureRecognizer

pinchGestureRecognizer

(Read Only) The Pinch gesture recognizer.

Declaration

public PinchGestureRecognizer pinchGestureRecognizer { get; }

Property Value

Type	Description
PinchGestureRecognizer

raycastMask

Gets or sets layer mask used for limiting ray cast targets.

Declaration

public LayerMask raycastMask { get; set; }

Property Value

Type	Description
LayerMask

raycastTriggerInteraction

Gets or sets type of interaction with trigger colliders via ray cast.

Declaration

public QueryTriggerInteraction raycastTriggerInteraction { get; set; }

Property Value

Type	Description
QueryTriggerInteraction

tapGestureRecognizer

(Read Only) The Tap gesture recognizer.

Declaration

public TapGestureRecognizer tapGestureRecognizer { get; }

Property Value

Type	Description
TapGestureRecognizer

twistGestureRecognizer

(Read Only) The Twist gesture recognizer.

Declaration

public TwistGestureRecognizer twistGestureRecognizer { get; }

Property Value

Type	Description
TwistGestureRecognizer

twoFingerDragGestureRecognizer

(Read Only) The two-finger Drag gesture recognizer.

Declaration

public TwoFingerDragGestureRecognizer twoFingerDragGestureRecognizer { get; }

Property Value

Type	Description
TwoFingerDragGestureRecognizer

xrOrigin

The XROrigin that this Interactor will use (such as to get the Camera or to transform from Session space). Will find one if null.

Declaration

public XROrigin xrOrigin { get; set; }

Property Value

Type	Description
XROrigin

Methods

Awake()

See MonoBehaviour.

Declaration

protected override void Awake()

Overrides

XRBaseInteractor.Awake()

GetValidTargets(List<IXRInteractable>)

Retrieve the list of Interactables that this Interactor could possibly interact with this frame. This list is sorted by priority (with highest priority first).

Declaration

public override void GetValidTargets(List<IXRInteractable> validTargets)

Parameters

Type	Name	Description
List<IXRInteractable>	validTargets

Overrides

XRBaseInteractor.GetValidTargets(List<IXRInteractable>)

Remarks

When implementing this method, Unity expects you to clear targets before adding to it.

OnDisable()

See MonoBehaviour.

Declaration

protected override void OnDisable()

Overrides

XRBaseInteractor.OnDisable()

OnEnable()

See MonoBehaviour.

Declaration

protected override void OnEnable()

Overrides

XRBaseInteractor.OnEnable()

OnRegistered(InteractorRegisteredEventArgs)

The XRInteractionManager calls this method when this Interactor is registered with it.

Declaration

protected override void OnRegistered(InteractorRegisteredEventArgs args)

Parameters

Type	Name	Description
InteractorRegisteredEventArgs	args	Event data containing the Interaction Manager that registered this Interactor.

Overrides

XRBaseInteractor.OnRegistered(InteractorRegisteredEventArgs)

Remarks

args is only valid during this method call, do not hold a reference to it.

See Also

RegisterInteractor(IXRInteractor)

OnUnregistered(InteractorUnregisteredEventArgs)

The XRInteractionManager calls this method when this Interactor is unregistered from it.

Declaration

protected override void OnUnregistered(InteractorUnregisteredEventArgs args)

Parameters

Type	Name	Description
InteractorUnregisteredEventArgs	args	Event data containing the Interaction Manager that unregistered this Interactor.

Overrides

XRBaseInteractor.OnUnregistered(InteractorUnregisteredEventArgs)

Remarks

args is only valid during this method call, do not hold a reference to it.

See Also

UnregisterInteractor(IXRInteractor)

ProcessInteractor(UpdatePhase)

The XRInteractionManager or containing IXRInteractionGroup calls this method to update the Interactor after interaction events occur.

Declaration

public override void ProcessInteractor(XRInteractionUpdateOrder.UpdatePhase updatePhase)

Parameters

Type	Name	Description
XRInteractionUpdateOrder.UpdatePhase	updatePhase	The update phase this is called during.

Overrides

XRBaseInteractor.ProcessInteractor(XRInteractionUpdateOrder.UpdatePhase)

Remarks

Please see the XRInteractionManager and XRInteractionUpdateOrder.UpdatePhase documentation for more details on update order.

See Also

XRInteractionUpdateOrder.UpdatePhase

ProcessInteractable(UpdatePhase)

PushRaycastLayerMask()

Passes raycast layer mask properties to the Gesture Recognizers.

Declaration

protected virtual void PushRaycastLayerMask()

See Also

raycastMask

PushRaycastTriggerInteraction()

Passes raycast trigger interaction properties to the Gesture Recognizers.

Declaration

protected virtual void PushRaycastTriggerInteraction()

See Also

raycastTriggerInteraction

PushXROrigin()

Passes the xrOrigin to the Gesture Recognizers.

Declaration

protected virtual void PushXROrigin()

See Also

xrOrigin

UpdateGestureRecognizers()

Update all Gesture Recognizers.

Declaration

protected virtual void UpdateGestureRecognizers()

See Also

Update()

Implements

IXRHoverInteractor

IXRSelectInteractor

IXRTargetPriorityInteractor

IXRGroupMember

IXRInteractionStrengthInteractor

IXRInteractor

Extension Methods

XRGroupMemberExtensions.GetTopLevelContainingGroup(IXRGroupMember)

XRHoverInteractorExtensions.GetOldestInteractableHovered(IXRHoverInteractor)

XRInteractorExtensions.IsBlockedByInteractionWithinGroup(IXRInteractor)

XRSelectInteractorExtensions.GetOldestInteractableSelected(IXRSelectInteractor)