Class TeleportationMultiAnchorVolume

An interactable that teleports the user to a specific position and/or rotation defined by one of several anchors. The volume designates a destination anchor upon first hover based on an ITeleportationVolumeAnchorFilter.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

XRBaseInteractable

BaseTeleportationInteractable

TeleportationMultiAnchorVolume

Implements

IXRActivateInteractable

IXRHoverInteractable

IXRSelectInteractable

IXRFocusInteractable

IXRInteractionStrengthInteractable

IXRInteractable

IXROverridesGazeAutoSelect

IXRReticleDirectionProvider

Inherited Members

BaseTeleportationInteractable.teleportationProvider

BaseTeleportationInteractable.matchOrientation

BaseTeleportationInteractable.matchDirectionalInput

BaseTeleportationInteractable.teleportTrigger

BaseTeleportationInteractable.filterSelectionByHitNormal

BaseTeleportationInteractable.upNormalToleranceDegrees

BaseTeleportationInteractable.teleporting

BaseTeleportationInteractable.Reset()

BaseTeleportationInteractable.SendTeleportRequest(IXRInteractor)

BaseTeleportationInteractable.OnSelectEntered(SelectEnterEventArgs)

BaseTeleportationInteractable.OnSelectExited(SelectExitEventArgs)

BaseTeleportationInteractable.OnActivated(ActivateEventArgs)

BaseTeleportationInteractable.OnDeactivated(DeactivateEventArgs)

BaseTeleportationInteractable.IsSelectableBy(IXRSelectInteractor)

BaseTeleportationInteractable.GetReticleDirection(IXRInteractor, Vector3, out Vector3, out Vector3?)

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

XRBaseInteractable.OnDisable()

XRBaseInteractable.GetAttachPoseOnSelect(IXRSelectInteractor)

XRBaseInteractable.GetLocalAttachPoseOnSelect(IXRSelectInteractor)

XRBaseInteractable.GetDistanceSqrToInteractor(IXRInteractor)

XRBaseInteractable.GetDistance(Vector3)

XRBaseInteractable.GetInteractionStrength(IXRInteractor)

XRBaseInteractable.IsHoverableBy(IXRHoverInteractor)

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.OnRegistered(InteractableRegisteredEventArgs)

XRBaseInteractable.OnUnregistered(InteractableUnregisteredEventArgs)

XRBaseInteractable.OnHoverEntering(HoverEnterEventArgs)

XRBaseInteractable.OnHoverExiting(HoverExitEventArgs)

XRBaseInteractable.OnSelectEntering(SelectEnterEventArgs)

XRBaseInteractable.OnSelectExiting(SelectExitEventArgs)

XRBaseInteractable.OnFocusEntering(FocusEnterEventArgs)

XRBaseInteractable.OnFocusEntered(FocusEnterEventArgs)

XRBaseInteractable.OnFocusExiting(FocusExitEventArgs)

XRBaseInteractable.OnFocusExited(FocusExitEventArgs)

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.Locomotion.Teleportation

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[AddComponentMenu("XR/Teleportation Multi-Anchor Volume", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.1/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation.TeleportationMultiAnchorVolume.html")]
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public class TeleportationMultiAnchorVolume : BaseTeleportationInteractable, IXRActivateInteractable, IXRHoverInteractable, IXRSelectInteractable, IXRFocusInteractable, IXRInteractionStrengthInteractable, IXRInteractable, IXROverridesGazeAutoSelect, IXRReticleDirectionProvider

Properties

anchorTransforms

The transforms that represent the possible teleportation destinations.

Declaration

public List<Transform> anchorTransforms { get; }

Property Value

Type	Description
List<Transform>

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor

destinationAnchor

The transform representing the current teleportation destination. When destinationEvaluationProgress is 1, this will be one of the transforms in anchorTransforms. Otherwise, this will be null.

Declaration

public Transform destinationAnchor { get; }

Property Value

Type	Description
Transform

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor

destinationEvaluationFilter

The filter used to evaluate a teleportation destination from the list of anchors. This is the same as the destinationEvaluationFilter in destinationEvaluationSettings unless that value is null, in which case this will return an instance of FurthestTeleportationAnchorFilter.

Declaration

public ITeleportationVolumeAnchorFilter destinationEvaluationFilter { get; }

Property Value

Type	Description
ITeleportationVolumeAnchorFilter

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor

destinationEvaluationProgress

A normalized representation of the current progress towards evaluating a destination anchor, depending on destinationEvaluationSettings. This value is 0 while not hovered. If enableDestinationEvaluationDelay is true, this value will start at 0 when initiating destination evaluation (either upon first hover or when re-evaluation occurs due to pollForDestinationChange) and will increase to 1 over the course of destinationEvaluationDelayTime seconds while hovered. Otherwise, this value will be 1 while hovered. This resets to 0 after the volume creates a teleport request.

Declaration

public float destinationEvaluationProgress { get; }

Property Value

Type	Description
float

See Also

enableDestinationEvaluationDelay

destinationEvaluationDelayTime

destinationEvaluationSettings

Settings for how this volume evaluates a destination anchor.

Declaration

public TeleportVolumeDestinationSettingsDatumProperty destinationEvaluationSettings { get; set; }

Property Value

Type	Description
TeleportVolumeDestinationSettingsDatumProperty

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor

Methods

Awake()

See MonoBehaviour.

Declaration

protected override void Awake()

Overrides

BaseTeleportationInteractable.Awake()

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor

GenerateTeleportRequest(IXRInteractor, RaycastHit, ref TeleportRequest)

Automatically called upon the teleport trigger event occurring to generate the teleport request. The teleportation destination pose should be filled out.

Declaration

protected override bool GenerateTeleportRequest(IXRInteractor interactor, RaycastHit raycastHit, ref TeleportRequest teleportRequest)

Parameters

Type	Name	Description
IXRInteractor	interactor	The interactor that initiated the teleport trigger.
RaycastHit	raycastHit	The ray cast hit information from the interactor.
TeleportRequest	teleportRequest	The teleport request that should be filled out during this method call.

Returns

Type	Description
bool	Returns true if the teleport request was successfully updated and should be queued. Otherwise, returns false.

Overrides

BaseTeleportationInteractable.GenerateTeleportRequest(IXRInteractor, RaycastHit, ref TeleportRequest)

See Also

QueueTeleportRequest(TeleportRequest)

GetAttachTransform(IXRInteractor)

Gets the Transform that serves as the attachment point for a given Interactor.

Declaration

public override Transform GetAttachTransform(IXRInteractor interactor)

Parameters

Type	Name	Description
IXRInteractor	interactor	The specific Interactor as context to get the attachment point for.

Returns

Type	Description
Transform	Returns the attachment point Transform.

Overrides

XRBaseInteractable.GetAttachTransform(IXRInteractor)

Remarks

This should typically return the Transform of a child GameObject or the transform itself.

See Also

GetAttachTransform(IXRInteractable)

OnDestroy()

See MonoBehaviour.

Declaration

protected override void OnDestroy()

Overrides

XRBaseInteractable.OnDestroy()

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor

OnDrawGizmosSelected()

See MonoBehaviour.

Declaration

protected void OnDrawGizmosSelected()

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor

OnHoverEntered(HoverEnterEventArgs)

The XRInteractionManager calls this method when the Interactor first initiates hovering over an Interactable in a second pass.

Declaration

protected override void OnHoverEntered(HoverEnterEventArgs args)

Parameters

Type	Name	Description
HoverEnterEventArgs	args	Event data containing the Interactor that is initiating the hover.

Overrides

XRBaseInteractable.OnHoverEntered(HoverEnterEventArgs)

Remarks

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

See Also

OnHoverExited(HoverExitEventArgs)

OnHoverExited(HoverExitEventArgs)

The XRInteractionManager calls this method when the Interactor ends hovering over an Interactable in a second pass.

Declaration

protected override void OnHoverExited(HoverExitEventArgs args)

Parameters

Type	Name	Description
HoverExitEventArgs	args	Event data containing the Interactor that is ending the hover.

Overrides

XRBaseInteractable.OnHoverExited(HoverExitEventArgs)

Remarks

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

See Also

OnHoverEntered(HoverEnterEventArgs)

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

BaseTeleportationInteractable.ProcessInteractable(XRInteractionUpdateOrder.UpdatePhase)

Remarks

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

See Also

XRInteractionUpdateOrder.UpdatePhase

ProcessInteractor(UpdatePhase)

Events

destinationAnchorChanged

Calls the methods in its invocation list when the destinationAnchor changes.

Declaration

public event Action<TeleportationMultiAnchorVolume> destinationAnchorChanged

Event Type

Type	Description
Action<TeleportationMultiAnchorVolume>

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor

Implements

IXRActivateInteractable

IXRHoverInteractable

IXRSelectInteractable

IXRFocusInteractable

IXRInteractionStrengthInteractable

IXRInteractable

IXROverridesGazeAutoSelect

IXRReticleDirectionProvider

Extension Methods

XRFocusInteractableExtensions.GetOldestInteractorFocusing(IXRFocusInteractable)

XRHoverInteractableExtensions.GetOldestInteractorHovering(IXRHoverInteractable)

XRHoverInteractableExtensions.IsHoveredByLeft(IXRHoverInteractable)

XRHoverInteractableExtensions.IsHoveredByRight(IXRHoverInteractable)

XRSelectInteractableExtensions.GetOldestInteractorSelecting(IXRSelectInteractable)

XRSelectInteractableExtensions.IsSelectedByLeft(IXRSelectInteractable)

XRSelectInteractableExtensions.IsSelectedByRight(IXRSelectInteractable)

See Also

ITeleportationVolumeAnchorFilter

TeleportationAnchor