API reference
API reference
Select your platform
No SDKs available
No versions available

TeleportInteractor Class

TeleportInteractor uses a provided ITeleportArc and an external Selector to find the best interactable and emit the event requesting a teleport to it.
Oculus::Interaction::Locomotion::TeleportInteractor extends Oculus.Interaction.Interactor< TeleportInteractor, TeleportInteractable >.
Oculus::Interaction::Locomotion::TeleportInteractor extends Oculus.Interaction.Locomotion.ILocomotionEventBroadcaster.

Overview

Properties

Hmd[Get]
When provided, the Interactor will perform an extra check to ensure nothing is blocking the line between the Hmd (head of the player) and the teleport origin (hand).
Specifies the shape of the arc used for detecting available interactables.
float
(Meters, World) The threshold below which distances to a interactable are treated as equal for the purposes of ranking.
Pose
The starting point of the teleport arc.
ArcEnd[Get]
Pose
The location to teleport to.
Action< LocomotionEvent >

Object Data

override void
Awake ( )
override void
Start ( )
override void
override int

Public Member Functions

override bool
void
Sets all required values for a dynamically instantiated GameObject.
void
Sets the selection mechanism for a dynamically instantiated GameObject.
void
Sets the HMD (Head Mounted Display) for a dynamically instantiated GameObject.
void
Sets the teleport arc for a dynamically instantiated GameObject.

Details

Detailed Description

By itself it does not define the shape of the arc or even moves the player, instead it is the core class that brings these pieces together.

Properties

IHmd Oculus.Interaction.Locomotion.TeleportInteractor.Hmd
When provided, the Interactor will perform an extra check to ensure nothing is blocking the line between the Hmd (head of the player) and the teleport origin (hand).
Making it impossible to teleport if the user is placing their hands behind a virtual wall.
IPolyline Oculus.Interaction.Locomotion.TeleportInteractor.TeleportArc
Specifies the shape of the arc used for detecting available interactables.
If none is provided TeleportArcGravity will be used.
float Oculus.Interaction.Locomotion.TeleportInteractor.EqualDistanceThreshold
(Meters, World) The threshold below which distances to a interactable are treated as equal for the purposes of ranking.
Pose Oculus.Interaction.Locomotion.TeleportInteractor.ArcOrigin
The starting point of the teleport arc.
TeleportHit Oculus.Interaction.Locomotion.TeleportInteractor.ArcEnd
No description available.
Pose Oculus.Interaction.Locomotion.TeleportInteractor.TeleportTarget
The location to teleport to.
If the interactor has an interactable, then that's the teleport location. Otherwise it just projects the end of the arc onto the ground and uses that as the target.
Action<LocomotionEvent> Oculus.Interaction.Locomotion.TeleportInteractor.WhenLocomotionPerformed
No description available.

Object Data

override void Oculus.Interaction.Locomotion.TeleportInteractor.Awake ( )
No description available.
override void Oculus.Interaction.Locomotion.TeleportInteractor.Start ( )
No description available.
override void Oculus.Interaction.Locomotion.TeleportInteractor.InteractableSelected
( TeleportInteractable interactable )
No description available.
override TeleportInteractable Oculus.Interaction.Locomotion.TeleportInteractor.ComputeCandidate ( )
No description available.
override int Oculus.Interaction.Locomotion.TeleportInteractor.ComputeCandidateTiebreaker
No description available.

Member Functions

override bool Oculus.Interaction.Locomotion.TeleportInteractor.CanSelect
( TeleportInteractable interactable )
No description available.
void Oculus.Interaction.Locomotion.TeleportInteractor.InjectAllTeleportInteractor
( ISelector selector )
Sets all required values for a dynamically instantiated GameObject.
void Oculus.Interaction.Locomotion.TeleportInteractor.InjectSelector
( ISelector selector )
Sets the selection mechanism for a dynamically instantiated GameObject.
void Oculus.Interaction.Locomotion.TeleportInteractor.InjectOptionalHmd
( IHmd hmd )
Sets the HMD (Head Mounted Display) for a dynamically instantiated GameObject.
void Oculus.Interaction.Locomotion.TeleportInteractor.InjectOptionalTeleportArc
( IPolyline teleportArc )
Sets the teleport arc for a dynamically instantiated GameObject.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon