Namespace UnityEngine.XR.Interaction.Toolkit.Locomotion.Teleportation

Classes

BaseTeleportationInteractable

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

FurthestTeleportationAnchorFilter

Filter for a TeleportationMultiAnchorVolume that designates the anchor furthest from the user as the teleportation destination. Distance calculation uses the camera position projected onto the XZ plane of the XR Origin.

GazeTeleportationAnchorFilter

Filter for a TeleportationMultiAnchorVolume that designates the anchor most aligned with the camera forward direction, optionally weighted by distance from the user, as the teleportation destination. Distance calculation uses the camera position projected onto the XZ plane of the XR Origin.

TeleportVolumeDestinationSettings

Settings for evaluating the destination anchor for a TeleportationMultiAnchorVolume.

TeleportVolumeDestinationSettingsDatum

ScriptableObject container class that holds a TeleportVolumeDestinationSettings value.

TeleportVolumeDestinationSettingsDatumProperty

Serializable container class that holds a TeleportVolumeDestinationSettings value or a container asset reference.

TeleportationAnchor

An anchor is a teleportation destination which teleports the user to a pre-determined specific position and/or rotation.

TeleportationArea

An area is a teleportation destination which teleports the user to their pointed location on a surface.

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.

TeleportationProvider

The TeleportationProvider is responsible for moving the XR Origin to the desired location on the user's request.

TeleportingEvent

UnityEvent that Unity invokes when queuing to teleport via a TeleportationProvider.

TeleportingEventArgs

Event data associated with the event that Unity invokes during a selection or activation event between an Interactable and an Interactor, according to the timing defined by BaseTeleportationInteractable.TeleportTrigger.

Structs

TeleportRequest

The Teleport Request that describes the result of the teleportation action. Each Teleportation Interactable must fill out a Teleport Request for each teleport action.

Interfaces

ITeleportationVolumeAnchorFilter

Interface for filtering a list of anchors for a TeleportationMultiAnchorVolume to designate one as the destination anchor.

Enums

BaseTeleportationInteractable.TeleportTrigger

Indicates when the teleportation action happens.

MatchOrientation

The option of which object's orientation in the rig Unity matches with the destination after teleporting.