docs.unity3d.com
    Show / Hide Table of Contents

    Class ARSelectionInteractable

    Controls the selection of an object through a Tap gesture.

    Inheritance
    Object
    XRBaseInteractable
    ARBaseGestureInteractable
    ARSelectionInteractable
    Inherited Members
    ARBaseGestureInteractable.arSessionOrigin
    ARBaseGestureInteractable.gestureInteractor
    ARBaseGestureInteractable.Reset()
    ARBaseGestureInteractable.Awake()
    ARBaseGestureInteractable.OnEnable()
    ARBaseGestureInteractable.IsHoverableBy(XRBaseInteractor)
    ARBaseGestureInteractable.CanStartManipulationForGesture(DragGesture)
    ARBaseGestureInteractable.CanStartManipulationForGesture(PinchGesture)
    ARBaseGestureInteractable.CanStartManipulationForGesture(TwistGesture)
    ARBaseGestureInteractable.CanStartManipulationForGesture(TwoFingerDragGesture)
    ARBaseGestureInteractable.OnStartManipulation(DragGesture)
    ARBaseGestureInteractable.OnStartManipulation(PinchGesture)
    ARBaseGestureInteractable.OnStartManipulation(TapGesture)
    ARBaseGestureInteractable.OnStartManipulation(TwistGesture)
    ARBaseGestureInteractable.OnStartManipulation(TwoFingerDragGesture)
    ARBaseGestureInteractable.OnContinueManipulation(DragGesture)
    ARBaseGestureInteractable.OnContinueManipulation(PinchGesture)
    ARBaseGestureInteractable.OnContinueManipulation(TapGesture)
    ARBaseGestureInteractable.OnContinueManipulation(TwistGesture)
    ARBaseGestureInteractable.OnContinueManipulation(TwoFingerDragGesture)
    ARBaseGestureInteractable.OnEndManipulation(DragGesture)
    ARBaseGestureInteractable.OnEndManipulation(PinchGesture)
    ARBaseGestureInteractable.OnEndManipulation(TwistGesture)
    ARBaseGestureInteractable.OnEndManipulation(TwoFingerDragGesture)
    ARBaseGestureInteractable.IsGameObjectSelected()
    ARBaseGestureInteractable.ConnectGestureInteractor()
    ARBaseGestureInteractable.DisconnectGestureInteractor()
    ARBaseGestureInteractable.OnRegistered(InteractableRegisteredEventArgs)
    ARBaseGestureInteractable.OnUnregistered(InteractableUnregisteredEventArgs)
    XRBaseInteractable.registered
    XRBaseInteractable.unregistered
    XRBaseInteractable.interactionManager
    XRBaseInteractable.colliders
    XRBaseInteractable.interactionLayerMask
    XRBaseInteractable.customReticle
    XRBaseInteractable.firstHoverEntered
    XRBaseInteractable.lastHoverExited
    XRBaseInteractable.hoverEntered
    XRBaseInteractable.hoverExited
    XRBaseInteractable.selectEntered
    XRBaseInteractable.selectExited
    XRBaseInteractable.activated
    XRBaseInteractable.deactivated
    XRBaseInteractable.hoveringInteractors
    XRBaseInteractable.selectingInteractor
    XRBaseInteractable.isHovered
    XRBaseInteractable.isSelected
    XRBaseInteractable.OnDisable()
    XRBaseInteractable.OnDestroy()
    XRBaseInteractable.GetDistanceSqrToInteractor(XRBaseInteractor)
    XRBaseInteractable.AttachCustomReticle(XRBaseInteractor)
    XRBaseInteractable.RemoveCustomReticle(XRBaseInteractor)
    XRBaseInteractable.ProcessInteractable(XRInteractionUpdateOrder.UpdatePhase)
    XRBaseInteractable.OnHoverEntering(HoverEnterEventArgs)
    XRBaseInteractable.OnHoverEntered(HoverEnterEventArgs)
    XRBaseInteractable.OnHoverExiting(HoverExitEventArgs)
    XRBaseInteractable.OnHoverExited(HoverExitEventArgs)
    XRBaseInteractable.OnSelectEntered(SelectEnterEventArgs)
    XRBaseInteractable.OnSelectExited(SelectExitEventArgs)
    XRBaseInteractable.OnActivated(ActivateEventArgs)
    XRBaseInteractable.OnDeactivated(DeactivateEventArgs)
    XRBaseInteractable.onFirstHoverEntered
    XRBaseInteractable.onLastHoverExited
    XRBaseInteractable.onHoverEntered
    XRBaseInteractable.onHoverExited
    XRBaseInteractable.onSelectEntered
    XRBaseInteractable.onSelectExited
    XRBaseInteractable.onSelectCanceled
    XRBaseInteractable.onActivate
    XRBaseInteractable.onDeactivate
    XRBaseInteractable.onFirstHoverEnter
    XRBaseInteractable.onHoverEnter
    XRBaseInteractable.onHoverExit
    XRBaseInteractable.onLastHoverExit
    XRBaseInteractable.onSelectEnter
    XRBaseInteractable.onSelectExit
    XRBaseInteractable.onSelectCancel
    XRBaseInteractable.OnHoverEntering(XRBaseInteractor)
    XRBaseInteractable.OnHoverEntered(XRBaseInteractor)
    XRBaseInteractable.OnHoverExiting(XRBaseInteractor)
    XRBaseInteractable.OnHoverExited(XRBaseInteractor)
    XRBaseInteractable.OnSelectEntering(XRBaseInteractor)
    XRBaseInteractable.OnSelectEntered(XRBaseInteractor)
    XRBaseInteractable.OnSelectExiting(XRBaseInteractor)
    XRBaseInteractable.OnSelectExited(XRBaseInteractor)
    XRBaseInteractable.OnSelectCanceling(XRBaseInteractor)
    XRBaseInteractable.OnSelectCanceled(XRBaseInteractor)
    XRBaseInteractable.OnActivate(XRBaseInteractor)
    XRBaseInteractable.OnDeactivate(XRBaseInteractor)
    Namespace: UnityEngine.XR.Interaction.Toolkit.AR
    Syntax
    public class ARSelectionInteractable : ARBaseGestureInteractable

    Properties

    selectionVisualization

    The visualization that will become active when the object is selected.

    Declaration
    public GameObject selectionVisualization { get; set; }
    Property Value
    Type Description
    GameObject

    Methods

    CanStartManipulationForGesture(TapGesture)

    Determines if the manipulation can be started for the given gesture.

    Declaration
    protected override bool CanStartManipulationForGesture(TapGesture gesture)
    Parameters
    Type Name Description
    TapGesture gesture

    The current gesture.

    Returns
    Type Description
    Boolean

    Returns true if the manipulation can be started. Otherwise, returns false.

    Overrides
    ARBaseGestureInteractable.CanStartManipulationForGesture(TapGesture)

    IsSelectableBy(XRBaseInteractor)

    Determines if this interactable can be selected by a given interactor.

    Declaration
    public override bool IsSelectableBy(XRBaseInteractor interactor)
    Parameters
    Type Name Description
    XRBaseInteractor interactor

    Interactor to check for a valid selection with.

    Returns
    Type Description
    Boolean

    Returns true if selection is valid this frame. Returns false if not.

    Overrides
    ARBaseGestureInteractable.IsSelectableBy(XRBaseInteractor)
    See Also
    CanSelect(XRBaseInteractable)

    OnEndManipulation(TapGesture)

    Unity calls this method automatically when the manipulation is ended.

    Declaration
    protected override void OnEndManipulation(TapGesture gesture)
    Parameters
    Type Name Description
    TapGesture gesture

    The current gesture.

    Overrides
    ARBaseGestureInteractable.OnEndManipulation(TapGesture)
    See Also
    onFinished

    OnSelectEntering(SelectEnterEventArgs)

    This method is called by the Interaction Manager right before the Interactor first initiates selection of an Interactable in a first pass.

    Declaration
    protected override void OnSelectEntering(SelectEnterEventArgs args)
    Parameters
    Type Name Description
    SelectEnterEventArgs args

    Event data containing the Interactor that is initiating the selection.

    Overrides
    XRBaseInteractable.OnSelectEntering(SelectEnterEventArgs)
    Remarks

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

    See Also
    OnSelectEntered(SelectEnterEventArgs)

    OnSelectExiting(SelectExitEventArgs)

    This method is called by the Interaction Manager right before the Interactor ends selection of an Interactable in a first pass.

    Declaration
    protected override void OnSelectExiting(SelectExitEventArgs args)
    Parameters
    Type Name Description
    SelectExitEventArgs args

    Event data containing the Interactor that is ending the selection.

    Overrides
    XRBaseInteractable.OnSelectExiting(SelectExitEventArgs)
    Remarks

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

    See Also
    OnSelectExited(SelectExitEventArgs)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023