Struct XRSimulatedControllerState
State for input device representing a simulated XR handed controller.
Namespace: UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation
Syntax
public struct XRSimulatedControllerState : IInputStateTypeInfoFields
batteryLevel
Value representing the current battery life of this device.
Declaration
public float batteryLevelField Value
| Type | Description |
|---|---|
| Single |
buttons
All the buttons on this device.
Declaration
public ushort buttonsField Value
| Type | Description |
|---|---|
| UInt16 |
devicePosition
The position of the device.
Declaration
public Vector3 devicePositionField Value
| Type | Description |
|---|---|
| Vector3 |
deviceRotation
The rotation of this device.
Declaration
public Quaternion deviceRotationField Value
| Type | Description |
|---|---|
| Quaternion |
grip
Represents the user's grip on the controller.
Declaration
public float gripField Value
| Type | Description |
|---|---|
| Single |
isTracked
Informs to the developer whether the device is currently being tracked.
Declaration
public bool isTrackedField Value
| Type | Description |
|---|---|
| Boolean |
primary2DAxis
The primary touchpad or joystick on a device.
Declaration
public Vector2 primary2DAxisField Value
| Type | Description |
|---|---|
| Vector2 |
secondary2DAxis
A secondary touchpad or joystick on a device.
Declaration
public Vector2 secondary2DAxisField Value
| Type | Description |
|---|---|
| Vector2 |
trackingState
Represents the values being tracked for this device.
Declaration
public int trackingStateField Value
| Type | Description |
|---|---|
| Int32 |
trigger
A trigger-like control, pressed with the index finger.
Declaration
public float triggerField Value
| Type | Description |
|---|---|
| Single |
Properties
format
Declaration
public FourCC format { get; }Property Value
| Type | Description |
|---|---|
| FourCC |
formatId
Memory format identifier for XRSimulatedControllerState.
Declaration
public static FourCC formatId { get; }Property Value
| Type | Description |
|---|---|
| FourCC |
Methods
Reset()
See
Declaration
public void Reset()WithButton(ControllerButton, Boolean)
Set the button mask for the given button.
Declaration
public XRSimulatedControllerState WithButton(ControllerButton button, bool state = true)Parameters
| Type | Name | Description |
|---|---|---|
| ControllerButton | button | Button whose state to set. |
| Boolean | state | Whether to set the bit on or off. |
Returns
| Type | Description |
|---|---|
| XRSimulatedControllerState | The same XRSimulatedControllerState with the change applied. |