TeleportOrientationHandlerHMD Class Reference
This orientation handler will aim the player at the point they aim the HMD at after they choose the teleport location. More...
Inheritance diagram for TeleportOrientationHandlerHMD:

Public Attributes | |
OrientationModes | OrientationMode |
HeadRelative=Character will orient to match the arrow. ForwardFacing=When user orients to match the arrow, they will be facing the sensors. More... | |
bool | UpdateOrientationDuringAim |
Should the destination orientation be updated during the aim state in addition to the PreTeleport state? More... | |
float | AimDistanceThreshold |
How far from the destination must the HMD be pointing before using it for orientation More... | |
float | AimDistanceMaxRange |
How far from the destination must the HMD be pointing before rejecting the teleport More... | |
Protected Member Functions | |
override void | InitializeTeleportDestination () |
override void | UpdateTeleportDestination () |
![]() | |
TeleportOrientationHandler () | |
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... | |
Quaternion | GetLandingOrientation (OrientationModes mode, Quaternion rotation) |
![]() | |
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 () |
Additional Inherited Members | |
![]() | |
enum | OrientationModes { OrientationModes.HeadRelative, OrientationModes.ForwardFacing } |
The OrientationModes are used to specify how the character should be oriented when they land after a teleport. More... | |
![]() | |
LocomotionTeleport.AimData | AimData |
![]() | |
LocomotionTeleport | LocomotionTeleport [get] |
Detailed Description
This orientation handler will aim the player at the point they aim the HMD at after they choose the teleport location.
Member Function Documentation
◆ InitializeTeleportDestination()
|
protectedvirtual |
Implements TeleportOrientationHandler.
◆ UpdateTeleportDestination()
|
protectedvirtual |
Implements TeleportOrientationHandler.
Member Data Documentation
◆ AimDistanceMaxRange
float TeleportOrientationHandlerHMD.AimDistanceMaxRange |
How far from the destination must the HMD be pointing before rejecting the teleport
◆ AimDistanceThreshold
float TeleportOrientationHandlerHMD.AimDistanceThreshold |
How far from the destination must the HMD be pointing before using it for orientation
◆ OrientationMode
OrientationModes TeleportOrientationHandlerHMD.OrientationMode |
HeadRelative=Character will orient to match the arrow. ForwardFacing=When user orients to match the arrow, they will be facing the sensors.
◆ UpdateOrientationDuringAim
bool TeleportOrientationHandlerHMD.UpdateOrientationDuringAim |
Should the destination orientation be updated during the aim state in addition to the PreTeleport state?
The documentation for this class was generated from the following file:
- Oculus/SampleFramework/Core/Locomotion/Scripts/TeleportOrientationHandlerHMD.cs