The TeleportInputHandler provides interfaces used to control aim related to teleports and related behaviors. There are derived implementations of this for Touch controllers, gamepad and HMD based aiming mechanics. Supporting any of these, or other future controllers, is possible by implementing and enabling a different derived type of TeleportInputHandler. More...

Inheritance diagram for TeleportInputHandler:

Public Member Functions
abstract LocomotionTeleport.TeleportIntentions	GetIntention ()
	One of the core functions of the TeleportInputHandler is to notify the LocomotionTeleport of the current intentions of the user with respect to aiming, teleporting, and abandoning a pending teleport. Derivations of this class will check buttons or whatever inputs they require to return values indicating what the user is trying to do. More...

abstract 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...

Protected Member Functions
	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 ()

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

Detailed Description

The TeleportInputHandler provides interfaces used to control aim related to teleports and related behaviors. There are derived implementations of this for Touch controllers, gamepad and HMD based aiming mechanics. Supporting any of these, or other future controllers, is possible by implementing and enabling a different derived type of TeleportInputHandler.

Constructor & Destructor Documentation

◆ TeleportInputHandler()

TeleportInputHandler.TeleportInputHandler ( )

protected

Member Function Documentation

◆ AddEventHandlers()

override void TeleportInputHandler.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.

◆ GetAimData()

abstract void TeleportInputHandler.GetAimData ( out Ray aimRay )

pure virtual

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

Implemented in TeleportInputHandlerTouch, and TeleportInputHandlerHMD.

◆ GetIntention()

abstract LocomotionTeleport.TeleportIntentions TeleportInputHandler.GetIntention ( )

pure virtual

One of the core functions of the TeleportInputHandler is to notify the LocomotionTeleport of the current intentions of the user with respect to aiming, teleporting, and abandoning a pending teleport. Derivations of this class will check buttons or whatever inputs they require to return values indicating what the user is trying to do.

Returns

Implemented in TeleportInputHandlerTouch, and TeleportInputHandlerHMD.

◆ RemoveEventHandlers()

override void TeleportInputHandler.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.

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

Oculus/SampleFramework/Core/Locomotion/Scripts/TeleportInputHandler.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members