docs.unity3d.com
    Show / Hide Table of Contents

    Class BaseTeleportationInteractable

    This is intended to be the base class for all Teleportation Interactables. This abstracts the teleport request process for specializations of this class.

    Inheritance
    Object
    XRBaseInteractable
    BaseTeleportationInteractable
    TeleportationAnchor
    TeleportationArea
    Inherited Members
    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.Reset()
    XRBaseInteractable.OnEnable()
    XRBaseInteractable.OnDisable()
    XRBaseInteractable.OnDestroy()
    XRBaseInteractable.GetDistanceSqrToInteractor(XRBaseInteractor)
    XRBaseInteractable.IsHoverableBy(XRBaseInteractor)
    XRBaseInteractable.IsSelectableBy(XRBaseInteractor)
    XRBaseInteractable.AttachCustomReticle(XRBaseInteractor)
    XRBaseInteractable.RemoveCustomReticle(XRBaseInteractor)
    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.OnSelectExiting(SelectExitEventArgs)
    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
    Syntax
    public abstract class BaseTeleportationInteractable : XRBaseInteractable

    Properties

    matchOrientation

    How to orient the rig after teleportation.

    Declaration
    public MatchOrientation matchOrientation { get; set; }
    Property Value
    Type Description
    MatchOrientation
    Remarks

    Set to:

    teleportationProvider

    The teleportation provider that this teleportation interactable will communicate teleport requests to. If no teleportation provider is configured, will attempt to find a teleportation provider during Awake.

    Declaration
    public TeleportationProvider teleportationProvider { get; set; }
    Property Value
    Type Description
    TeleportationProvider

    teleportTrigger

    Specifies when the teleportation will be triggered.

    Declaration
    public BaseTeleportationInteractable.TeleportTrigger teleportTrigger { get; set; }
    Property Value
    Type Description
    BaseTeleportationInteractable.TeleportTrigger

    Methods

    Awake()

    See .

    Declaration
    protected override void Awake()
    Overrides
    XRBaseInteractable.Awake()

    GenerateTeleportRequest(XRBaseInteractor, RaycastHit, ref TeleportRequest)

    Generates a teleport request.

    Declaration
    protected virtual bool GenerateTeleportRequest(XRBaseInteractor interactor, RaycastHit raycastHit, ref TeleportRequest teleportRequest)
    Parameters
    Type Name Description
    XRBaseInteractor interactor

    The interactor generating the teleport request.

    RaycastHit raycastHit

    The raycast hit where user will be teleported to.

    TeleportRequest teleportRequest

    The teleport request.

    Returns
    Type Description
    Boolean

    Returns true if button teleportation was successful. Otherwise, returns false.

    OnActivated(ActivateEventArgs)

    This method is called by the XRBaseControllerInteractor when the Interactor begins an activation event on this selected Interactable.

    Declaration
    protected override void OnActivated(ActivateEventArgs args)
    Parameters
    Type Name Description
    ActivateEventArgs args

    Event data containing the Interactor that is sending the activate event.

    Overrides
    XRBaseInteractable.OnActivated(ActivateEventArgs)
    Remarks

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

    See Also
    OnDeactivated(DeactivateEventArgs)

    OnDeactivated(DeactivateEventArgs)

    This method is called by the XRBaseControllerInteractor when the Interactor ends an activation event on this selected Interactable.

    Declaration
    protected override void OnDeactivated(DeactivateEventArgs args)
    Parameters
    Type Name Description
    DeactivateEventArgs args

    Event data containing the Interactor that is sending the deactivate event.

    Overrides
    XRBaseInteractable.OnDeactivated(DeactivateEventArgs)
    Remarks

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

    See Also
    OnActivated(ActivateEventArgs)

    OnSelectEntered(SelectEnterEventArgs)

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

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

    Event data containing the Interactor that is initiating the selection.

    Overrides
    XRBaseInteractable.OnSelectEntered(SelectEnterEventArgs)
    Remarks

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

    See Also
    OnSelectExited(SelectExitEventArgs)

    OnSelectExited(SelectExitEventArgs)

    This method is called by the Interaction Manager when the Interactor ends selection of an Interactable in a second pass.

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

    Event data containing the Interactor that is ending the selection.

    Overrides
    XRBaseInteractable.OnSelectExited(SelectExitEventArgs)
    Remarks

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

    See Also
    OnSelectEntered(SelectEnterEventArgs)
    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