Class XRController
XRBaseController MonoBehaviour that interprets feature values on an input device in the XR input subsystem into XR Interaction Interactor position, rotation, and interaction states.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[AddComponentMenu("XR/XR Controller (Device-based)")]
public class XRController : XRBaseController
Properties
activateUsage
The input to use for detecting activation.
Declaration
public InputHelpers.Button activateUsage { get; set; }
Property Value
Type | Description |
---|---|
InputHelpers.Button |
axisToPressThreshold
The amount an axis needs to be pressed to trigger an interaction event.
Declaration
public float axisToPressThreshold { get; set; }
Property Value
Type | Description |
---|---|
Single |
controllerNode
The XRNode for this controller.
Declaration
public XRNode controllerNode { get; set; }
Property Value
Type | Description |
---|---|
XRNode |
inputDevice
(Read Only) The InputDevice being used to read data from.
Declaration
public InputDevice inputDevice { get; }
Property Value
Type | Description |
---|---|
InputDevice |
moveObjectIn
The input that will be used to translate the anchor away from the interactor.
Declaration
public InputHelpers.Button moveObjectIn { get; set; }
Property Value
Type | Description |
---|---|
InputHelpers.Button |
moveObjectOut
The input that will be used to translate the anchor towards the interactor.
Declaration
public InputHelpers.Button moveObjectOut { get; set; }
Property Value
Type | Description |
---|---|
InputHelpers.Button |
rotateObjectLeft
The input to use to rotate an anchor to the Left.
Declaration
public InputHelpers.Button rotateObjectLeft { get; set; }
Property Value
Type | Description |
---|---|
InputHelpers.Button |
rotateObjectRight
The input to use to rotate an anchor to the Right.
Declaration
public InputHelpers.Button rotateObjectRight { get; set; }
Property Value
Type | Description |
---|---|
InputHelpers.Button |
selectUsage
The input to use for detecting a select.
Declaration
public InputHelpers.Button selectUsage { get; set; }
Property Value
Type | Description |
---|---|
InputHelpers.Button |
uiPressUsage
The input to use for detecting a UI press.
Declaration
public InputHelpers.Button uiPressUsage { get; set; }
Property Value
Type | Description |
---|---|
InputHelpers.Button |
Methods
SendHapticImpulse(Single, Single)
Play a haptic impulse on the controller if one is available.
Declaration
public override bool SendHapticImpulse(float amplitude, float duration)
Parameters
Type | Name | Description |
---|---|---|
Single | amplitude | Amplitude (from 0.0 to 1.0) to play impulse at. |
Single | duration | Duration (in seconds) to play haptic impulse. |
Returns
Type | Description |
---|---|
Boolean |
Overrides
UpdateInput(XRControllerState)
Declaration
protected override void UpdateInput(XRControllerState controllerState)
Parameters
Type | Name | Description |
---|---|---|
XRControllerState | controllerState |
Overrides
UpdateTrackingInput(XRControllerState)
Declaration
protected override void UpdateTrackingInput(XRControllerState controllerState)
Parameters
Type | Name | Description |
---|---|---|
XRControllerState | controllerState |