TeleportInputHandlerHMD Class Reference

When this component is enabled, the player will be able to aim and trigger teleport behavior using HMD aiming. More...

Inheritance diagram for TeleportInputHandlerHMD:
TeleportInputHandler TeleportSupport TeleportInputHandlerTouch

Public Member Functions

override LocomotionTeleport.TeleportIntentions GetIntention ()
 Based on the input mode, controller state, and current intention of the teleport controller, return the apparent intention of the user. More...
 
override void GetAimData (out Ray aimRay)
 Returns the aim ray for pointing at targets, which is generally based on a touch controller or HMD pose. More...
 

Public Attributes

OVRInput.RawButton AimButton
 The button used to begin aiming for a teleport. More...
 
OVRInput.RawButton TeleportButton
 The button used to trigger the teleport after aiming. It can be the same button as the AimButton, however you cannot abort a teleport if it is. More...
 
bool FastTeleport
 When true, the system will not use the PreTeleport intention which will allow a teleport to occur on a button downpress. When false, the button downpress will trigger the PreTeleport intention and the Teleport intention when the button is released. More...
 

Properties

Transform Pointer [get]
 
- Properties inherited from TeleportSupport
LocomotionTeleport LocomotionTeleport [get]
 

Additional Inherited Members

- Protected Member Functions inherited from TeleportInputHandler
 TeleportInputHandler ()
 
override void AddEventHandlers ()
 Derived classes that need to use event handlers need to override this method and call the base class to ensure all event handlers are added as intended. More...
 
override void RemoveEventHandlers ()
 Derived classes that need to use event handlers need to override this method and call the base class to ensure all event handlers are removed as intended. More...
 
- Protected Member Functions inherited from TeleportSupport
virtual void OnEnable ()
 OnEnable is virtual so that derived classes can set up references to objects before AddEventHandlers is called, as is required by TeleportSupport derivations. More...
 
virtual void OnDisable ()
 

Detailed Description

When this component is enabled, the player will be able to aim and trigger teleport behavior using HMD aiming.

Member Function Documentation

◆ GetAimData()

override void TeleportInputHandlerHMD.GetAimData ( out Ray  aimRay)
virtual

Returns the aim ray for pointing at targets, which is generally based on a touch controller or HMD pose.

Implements TeleportInputHandler.

Reimplemented in TeleportInputHandlerTouch.

◆ GetIntention()

override LocomotionTeleport.TeleportIntentions TeleportInputHandlerHMD.GetIntention ( )
virtual

Based on the input mode, controller state, and current intention of the teleport controller, return the apparent intention of the user.

Returns

Implements TeleportInputHandler.

Reimplemented in TeleportInputHandlerTouch.

Member Data Documentation

◆ AimButton

OVRInput.RawButton TeleportInputHandlerHMD.AimButton

The button used to begin aiming for a teleport.

◆ FastTeleport

bool TeleportInputHandlerHMD.FastTeleport

When true, the system will not use the PreTeleport intention which will allow a teleport to occur on a button downpress. When false, the button downpress will trigger the PreTeleport intention and the Teleport intention when the button is released.

◆ TeleportButton

OVRInput.RawButton TeleportInputHandlerHMD.TeleportButton

The button used to trigger the teleport after aiming. It can be the same button as the AimButton, however you cannot abort a teleport if it is.

Property Documentation

◆ Pointer

Transform TeleportInputHandlerHMD.Pointer
get

The documentation for this class was generated from the following file: