TeleportOrientationHandler Class Reference

The orientation handler is what determines the final rotation of the player after the teleport. More...

Inheritance diagram for TeleportOrientationHandler:

Public Types
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...

Protected Member Functions
	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...
abstract void	InitializeTeleportDestination ()
abstract void	UpdateTeleportDestination ()
Quaternion	GetLandingOrientation (OrientationModes mode, Quaternion rotation)
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 ()

Protected Attributes
LocomotionTeleport.AimData	AimData

Additional Inherited Members
Properties inherited from TeleportSupport
LocomotionTeleport	LocomotionTeleport [get]

Detailed Description

The orientation handler is what determines the final rotation of the player after the teleport.

Member Enumeration Documentation

OrientationModes

enum TeleportOrientationHandler.OrientationModes

strong

The OrientationModes are used to specify how the character should be oriented when they land after a teleport.

Enumerator
HeadRelative	When the player teleports, they will match the orientation of the destination indicator without adjusting their HMD's orientation.
ForwardFacing	When the player teleports, the player will be oriented so that when they turn the HMD to match the destination indicator, they will be facing forward with respect to the Oculus sensor setup. They will not immediately face the direction of the indicator, and will need to rotated the HMD view to match the indicated direction. Once rotated, the player will be facing forward to the Oculus sensors.

Constructor & Destructor Documentation

TeleportOrientationHandler()

TeleportOrientationHandler.TeleportOrientationHandler ( )

protected

Member Function Documentation

AddEventHandlers()

override void TeleportOrientationHandler.AddEventHandlers ( )

protectedvirtual

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.

Reimplemented from TeleportSupport.

GetLandingOrientation()

Quaternion TeleportOrientationHandler.GetLandingOrientation ( OrientationModes  mode, Quaternion  rotation  )

protected

InitializeTeleportDestination()

abstract void TeleportOrientationHandler.InitializeTeleportDestination ( )

protectedpure virtual

Implemented in TeleportOrientationHandlerHMD, TeleportOrientationHandlerThumbstick, and TeleportOrientationHandler360.

RemoveEventHandlers()

override void TeleportOrientationHandler.RemoveEventHandlers ( )

protectedvirtual

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.

Reimplemented from TeleportSupport.

UpdateTeleportDestination()

abstract void TeleportOrientationHandler.UpdateTeleportDestination ( )

protectedpure virtual

Implemented in TeleportOrientationHandlerHMD, TeleportOrientationHandlerThumbstick, and TeleportOrientationHandler360.

Member Data Documentation

AimData

LocomotionTeleport.AimData TeleportOrientationHandler.AimData

protected

---

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

• Oculus/SampleFramework/Core/Locomotion/Scripts/TeleportOrientationHandler.cs