Class BaseTeleportationInteractable

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

Inheritance
Object
XRBaseInteractable
BaseTeleportationInteractable
TeleportationAnchor
TeleportationArea
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
public abstract class BaseTeleportationInteractable : XRBaseInteractable

Fields

m_MatchOrientation

Declaration
protected MatchOrientation m_MatchOrientation
Field Value
Type Description
MatchOrientation

m_TeleportationProvider

Declaration
protected TeleportationProvider m_TeleportationProvider
Field Value
Type Description
TeleportationProvider

m_TeleportTrigger

Declaration
protected BaseTeleportationInteractable.TeleportTrigger m_TeleportTrigger
Field Value
Type Description
BaseTeleportationInteractable.TeleportTrigger

Properties

matchOrientation

Specify which object's orientation in the rig will be matched with this Teleportation Interactable after teleporting. Set to Camera if you wish to have the camera look at something in the forward direction of this Interactable or its specified anchor.

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

teleportationProvider

The teleportation provider that this Teleport interactable will communicate Teleportation Requests to. If no teleportation provider is configured, then on awake the base teleportation interactable will attempt to find a teleportation provider to work with.

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

teleportTrigger

Specify when the teleportation will be triggered.

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

Methods

Awake()

Declaration
protected override void Awake()
Overrides

GenerateTeleportRequest(XRBaseInteractor, RaycastHit, ref TeleportRequest)

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

OnActivate(XRBaseInteractor)

Declaration
protected override void OnActivate(XRBaseInteractor interactor)
Parameters
Type Name Description
XRBaseInteractor interactor
Overrides

OnDeactivate(XRBaseInteractor)

Declaration
protected override void OnDeactivate(XRBaseInteractor interactor)
Parameters
Type Name Description
XRBaseInteractor interactor
Overrides

OnSelectEnter(XRBaseInteractor)

Declaration
protected override void OnSelectEnter(XRBaseInteractor interactor)
Parameters
Type Name Description
XRBaseInteractor interactor
Overrides

OnSelectExit(XRBaseInteractor)

Declaration
protected override void OnSelectExit(XRBaseInteractor interactor)
Parameters
Type Name Description
XRBaseInteractor interactor
Overrides