Class DeviceBasedContinuousMoveProvider
Locomotion provider that allows the user to smoothly move their rig continuously over time using a specified 2D axis input.
Inheritance
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[AddComponentMenu("XR/Locomotion/Continuous Move Provider (Device-based)", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@2.1/api/UnityEngine.XR.Interaction.Toolkit.DeviceBasedContinuousMoveProvider.html")]
public class DeviceBasedContinuousMoveProvider : ContinuousMoveProviderBaseProperties
controllers
The XRControllers that allow movement. An XRController must be enabled in order to move.
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 move.
Declaration
public DeviceBasedContinuousMoveProvider.InputAxes inputBinding { get; set; }Property Value
| Type | Description |
|---|---|
| DeviceBasedContinuousMoveProvider.InputAxes |
Methods
GetDeadzoneAdjustedValue(Single)
Gets value adjusted based on deadzone thresholds defined in deadzoneMin and deadzoneMax.
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)
Gets value adjusted based on deadzone thresholds defined in deadzoneMin and deadzoneMax.
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 move input.
Declaration
protected override Vector2 ReadInput()Returns
| Type | Description |
|---|---|
| Vector2 | Returns the input vector, such as from a thumbstick. |