Defines an IInteractor which performs locomotion turns (i.e., rotating the user in virtual space) based on input from an IAxis2D, canonically a controller thumbstick, from which only the horizontal (x) axis will be used.

There is no real interactable for this interactor (LocomotionAxisTurnerInteractable is an empty type, as described in the comments on that class).

For the hand tracking counterpart to this type, see LocomotionTurnerInteractor.

Properties

float DeadZone[Get]

The "dead zone" of control for this interactor: the absolute value of the horizontal (x) axis of the input control IAxis2D must be exceed this value before this interactor begins to interact (i.e., enter Hover or Select states).

Fields

override bool ShouldHover[Get]

Implementation of IInteractor.ShouldHover, more documentation for which can be found in the defining interface.

Becomes true or false based on the absolute value of the horizontal (x) axis of the input IAxis2D compared with the DeadZone. The exact relationship between ShouldHover and the input axis is an implementation detail; the value is set based on the axis's value relative to the DeadZone, but exactly when that happens is not specified in the contract. Consequently, there may be times when ShouldHover does not return the value you might expect from directly comparing the input axis to the DeadZone.

override bool ShouldUnhover[Get]

Implementation of IInteractor.ShouldUnhover, more documentation for which can be found in the defining interface.

Becomes true or false based on the absolute value of the horizontal (x) axis of the input IAxis2D compared with the DeadZone. The exact relationship between ShouldUnhover and the input axis is an implementation detail; the value is set based on the axis's value relative to the DeadZone, but exactly when that happens is not specified in the contract. Consequently, there may be times when ShouldUnhover does not return the value you might expect from directly comparing the input axis to the DeadZone.

Protected Functions

virtual override bool ComputeShouldSelect ( )

virtual override bool ComputeShouldUnselect ( )

virtual override void Awake ( )

virtual override void OnDisable ( )

virtual override void Start ( )

virtual override void DoPreprocess ( )

virtual override LocomotionAxisTurnerInteractable ComputeCandidate ( )

Member Functions

float Value ( )

Returns the most recently sampled value of the horizontal (x) axis of the input IAxis2D.

Though this value is set from the input axis, exactly when and how that happens is not specified in the contract. Consequently, there may be times when Value does not return the actual current value of the input axis.

void InjectAllLocomotionAxisTurner

( IAxis2D axis2D )

Injects all required dependencies for a dynamically instantiated LocomotionAxisTurnerInteractor; effectively wraps InjectAxis2D(IAxis2D).

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

void InjectAxis2D

( IAxis2D axis2D )

Sets an IAxis2D for a dynamically instantiated LocomotionAxisTurnerInteractor.

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

Did you find this page helpful?