Class DeviceBasedContinuousTurnProvider

Locomotion provider that allows the user to smoothly rotate their rig continuously over time using a specified 2D axis input.

Inheritance
Object
LocomotionProvider
ContinuousTurnProviderBase
DeviceBasedContinuousTurnProvider
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
public class DeviceBasedContinuousTurnProvider : ContinuousTurnProviderBase

Properties

controllers

The XRControllers that allow Turn. An XRController must be enabled in order to Turn.

Declaration
public List<XRBaseController> controllers { get; set; }
Property Value
Type Description
List<XRBaseController>

deadzoneMax

Value above which input values will be clamped. After clamping, values will be renormalized to [0, 1] between min and max.

Declaration
public float deadzoneMax { get; set; }
Property Value
Type Description
Single

deadzoneMin

Value below which input values will be clamped. After clamping, values will be renormalized to [0, 1] between min and max.

Declaration
public float deadzoneMin { get; set; }
Property Value
Type Description
Single

inputBinding

The 2D Input Axis on the controller devices that will be used to trigger a turn.

Declaration
public DeviceBasedContinuousTurnProvider.InputAxes inputBinding { get; set; }
Property Value
Type Description
DeviceBasedContinuousTurnProvider.InputAxes

Methods

GetDeadzoneAdjustedValue(Single)

Get value adjusted based on deadzone thresholds.

Declaration
protected float GetDeadzoneAdjustedValue(float value)
Parameters
Type Name Description
Single value

The value to be adjusted.
Returns
Type Description
Single

Returns adjusted value.

GetDeadzoneAdjustedValue(Vector2)

Get value adjusted based on deadzone thresholds.

Declaration
protected Vector2 GetDeadzoneAdjustedValue(Vector2 value)
Parameters
Type Name Description
Vector2 value

The value to be adjusted.
Returns
Type Description
Vector2

Returns adjusted 2D vector.

ReadInput()

Reads the current value of the turn input.

Declaration
protected override Vector2 ReadInput()
Returns
Type Description
Vector2

Returns the input vector, such as from a thumbstick.
Overrides

See Also