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
Implements
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Assembly: solution.dll
Syntax
public abstract class BaseTeleportationInteractable : XRBaseInteractable, IXRActivateInteractable, IXRHoverInteractable, IXRSelectInteractable, IXRFocusInteractable, IXRInteractionStrengthInteractable, IXRInteractable, IXROverridesGazeAutoSelect, IXRReticleDirectionProviderProperties
| Name | Description |
|---|---|
| filterSelectionByHitNormal | When set to true, this teleportation interactable will only be selectable by a ray interactor if its current hit normal is aligned with this object's up vector. |
| matchDirectionalInput | Whether or not to rotate the rig to match the forward direction of the attach transform of the selecting interactor. This only applies when matchOrientation is set to WorldSpaceUp or TargetUp. |
| matchOrientation | How to orient the rig after teleportation. |
| teleportTrigger | Specifies when the teleportation triggers. |
| teleportationProvider | The teleportation provider that this teleportation interactable communicates teleport requests to. If no teleportation provider is configured, will attempt to find a teleportation provider. |
| teleporting | Gets or sets the event that Unity calls when queuing to teleport via the TeleportationProvider. |
| upNormalToleranceDegrees | The tolerance in degrees from this object's up vector for a hit normal to be considered aligned with the up vector. |
Methods
| Name | Description |
|---|---|
| Awake() | See MonoBehaviour. |
| 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. |
| GetReticleDirection(IXRInteractor, Vector3, out Vector3, out Vector3?) | Get the reticle direction based on the given interactor's attach transform. |
| IsSelectableBy(IXRSelectInteractor) | Determines if a given Interactor can select this Interactable. |
| OnActivated(ActivateEventArgs) | XRBaseInputInteractor calls this method when the Interactor begins an activation event on this Interactable. |
| OnDeactivated(DeactivateEventArgs) | XRBaseInputInteractor calls this method when the Interactor ends an activation event on this Interactable. |
| OnSelectEntered(SelectEnterEventArgs) | The XRInteractionManager calls this method when the Interactor first initiates selection of an Interactable in a second pass. |
| OnSelectExited(SelectExitEventArgs) | The XRInteractionManager calls this method when the Interactor ends selection of an Interactable in a second pass. |
| ProcessInteractable(UpdatePhase) | The XRInteractionManager calls this method to update the Interactable. |
| Reset() | See MonoBehaviour. |