Class ARTranslationInteractable

Manipulates the position of an object via a drag gesture. If not selected, the object will be selected when the drag gesture starts.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

XRBaseInteractable

ARBaseGestureInteractable

ARTranslationInteractable

Implements

IXRActivateInteractable

IXRHoverInteractable

IXRSelectInteractable

IXRFocusInteractable

IXRInteractionStrengthInteractable

IXRInteractable

IXROverridesGazeAutoSelect

Inherited Members

ARBaseGestureInteractable.xrOrigin

ARBaseGestureInteractable.excludeUITouches

ARBaseGestureInteractable.gestureInteractor

ARBaseGestureInteractable.Awake()

ARBaseGestureInteractable.OnEnable()

ARBaseGestureInteractable.IsHoverableBy(IXRHoverInteractor)

ARBaseGestureInteractable.IsSelectableBy(IXRSelectInteractor)

ARBaseGestureInteractable.CanStartManipulationForGesture(PinchGesture)

ARBaseGestureInteractable.CanStartManipulationForGesture(TapGesture)

ARBaseGestureInteractable.CanStartManipulationForGesture(TwistGesture)

ARBaseGestureInteractable.CanStartManipulationForGesture(TwoFingerDragGesture)

ARBaseGestureInteractable.OnStartManipulation(PinchGesture)

ARBaseGestureInteractable.OnStartManipulation(TapGesture)

ARBaseGestureInteractable.OnStartManipulation(TwistGesture)

ARBaseGestureInteractable.OnStartManipulation(TwoFingerDragGesture)

ARBaseGestureInteractable.OnContinueManipulation(PinchGesture)

ARBaseGestureInteractable.OnContinueManipulation(TapGesture)

ARBaseGestureInteractable.OnContinueManipulation(TwistGesture)

ARBaseGestureInteractable.OnContinueManipulation(TwoFingerDragGesture)

ARBaseGestureInteractable.OnEndManipulation(PinchGesture)

ARBaseGestureInteractable.OnEndManipulation(TapGesture)

ARBaseGestureInteractable.OnEndManipulation(TwistGesture)

ARBaseGestureInteractable.OnEndManipulation(TwoFingerDragGesture)

ARBaseGestureInteractable.IsGameObjectSelected()

ARBaseGestureInteractable.ConnectGestureInteractor()

ARBaseGestureInteractable.DisconnectGestureInteractor()

ARBaseGestureInteractable.OnRegistered(InteractableRegisteredEventArgs)

ARBaseGestureInteractable.OnUnregistered(InteractableUnregisteredEventArgs)

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.OnDisable()

XRBaseInteractable.OnDestroy()

XRBaseInteractable.GetAttachTransform(IXRInteractor)

XRBaseInteractable.GetAttachPoseOnSelect(IXRSelectInteractor)

XRBaseInteractable.GetLocalAttachPoseOnSelect(IXRSelectInteractor)

XRBaseInteractable.GetDistanceSqrToInteractor(IXRInteractor)

XRBaseInteractable.GetDistance(Vector3)

XRBaseInteractable.GetInteractionStrength(IXRInteractor)

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

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[AddComponentMenu("XR/AR Translation Interactable", 22)]
[RequireComponent(typeof(ARSelectionInteractable))]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.5/api/UnityEngine.XR.Interaction.Toolkit.AR.ARTranslationInteractable.html")]
public class ARTranslationInteractable : ARBaseGestureInteractable, IXRActivateInteractable, IXRHoverInteractable, IXRSelectInteractable, IXRFocusInteractable, IXRInteractionStrengthInteractable, IXRInteractable, IXROverridesGazeAutoSelect

Properties

fallbackLayerMask

The LayerMask that Unity uses during an additional ray cast when a user touch does not hit any AR trackable planes.

Declaration

public LayerMask fallbackLayerMask { get; set; }

Property Value

Type	Description
LayerMask

maxTranslationDistance

The maximum translation distance of this object.

Declaration

public float maxTranslationDistance { get; set; }

Property Value

Type	Description
float

objectGestureTranslationMode

Controls whether the object will be constrained vertically, horizontally, or free to move in all axis.

Declaration

public GestureTransformationUtility.GestureTranslationMode objectGestureTranslationMode { get; set; }

Property Value

Type	Description
GestureTransformationUtility.GestureTranslationMode

Methods

CanStartManipulationForGesture(DragGesture)

Determines if the manipulation can start for the given gesture.

Declaration

protected override bool CanStartManipulationForGesture(DragGesture gesture)

Parameters

Type	Name	Description
DragGesture	gesture	The current gesture.

Returns

Type	Description
bool	Returns true if the manipulation can start. Otherwise, returns false.

Overrides

ARBaseGestureInteractable.CanStartManipulationForGesture(DragGesture)

OnContinueManipulation(DragGesture)

Unity calls this method automatically when the manipulation continues.

Declaration

protected override void OnContinueManipulation(DragGesture gesture)

Parameters

Type	Name	Description
DragGesture	gesture	The current gesture.

Overrides

ARBaseGestureInteractable.OnContinueManipulation(DragGesture)

See Also

onUpdated

OnEndManipulation(DragGesture)

Unity calls this method automatically when the manipulation ends.

Declaration

protected override void OnEndManipulation(DragGesture gesture)

Parameters

Type	Name	Description
DragGesture	gesture	The current gesture.

Overrides

ARBaseGestureInteractable.OnEndManipulation(DragGesture)

See Also

onFinished

OnStartManipulation(DragGesture)

Unity calls this method automatically when the manipulation starts.

Declaration

protected override void OnStartManipulation(DragGesture gesture)

Parameters

Type	Name	Description
DragGesture	gesture	The current gesture.

Overrides

ARBaseGestureInteractable.OnStartManipulation(DragGesture)

See Also

onGestureStarted

ProcessInteractable(UpdatePhase)

The XRInteractionManager calls this method to update the Interactable.

Declaration

public override void ProcessInteractable(XRInteractionUpdateOrder.UpdatePhase updatePhase)

Parameters

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

Overrides

XRBaseInteractable.ProcessInteractable(XRInteractionUpdateOrder.UpdatePhase)

Remarks

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

See Also

XRInteractionUpdateOrder.UpdatePhase

ProcessInteractor(UpdatePhase)

Implements

IXRActivateInteractable

IXRHoverInteractable

IXRSelectInteractable

IXRFocusInteractable

IXRInteractionStrengthInteractable

IXRInteractable

IXROverridesGazeAutoSelect

Extension Methods

XRFocusInteractableExtensions.GetOldestInteractorFocusing(IXRFocusInteractable)

XRHoverInteractableExtensions.GetOldestInteractorHovering(IXRHoverInteractable)

XRSelectInteractableExtensions.GetOldestInteractorSelecting(IXRSelectInteractable)