Class XRInputDeviceBoolValueReader

A ScriptableObject that provides a bool value from a device from the XR input subsystem as defined by its characteristics and feature usage string. Intended to be used with an XRInputValueReader as its object reference or as part of an XRInputDeviceButtonReader.

Inheritance

object

Object

ScriptableObject

XRInputDeviceValueReader

XRInputDeviceValueReader<bool>

XRInputDeviceBoolValueReader

Implements

IXRInputValueReader<bool>

IXRInputValueReader

Inherited Members

XRInputDeviceValueReader<bool>.usage

XRInputDeviceValueReader<bool>.ReadBoolValue()

XRInputDeviceValueReader<bool>.ReadUIntValue()

XRInputDeviceValueReader<bool>.ReadFloatValue()

XRInputDeviceValueReader<bool>.ReadVector2Value()

XRInputDeviceValueReader<bool>.ReadVector3Value()

XRInputDeviceValueReader<bool>.ReadQuaternionValue()

XRInputDeviceValueReader<bool>.ReadInputTrackingStateValue()

XRInputDeviceValueReader<bool>.TryReadBoolValue(out bool)

XRInputDeviceValueReader<bool>.TryReadUIntValue(out uint)

XRInputDeviceValueReader<bool>.TryReadFloatValue(out float)

XRInputDeviceValueReader<bool>.TryReadVector2Value(out Vector2)

XRInputDeviceValueReader<bool>.TryReadVector3Value(out Vector3)

XRInputDeviceValueReader<bool>.TryReadQuaternionValue(out Quaternion)

XRInputDeviceValueReader<bool>.TryReadInputTrackingStateValue(out InputTrackingState)

XRInputDeviceValueReader<bool>.RefreshInputDeviceIfNeeded()

XRInputDeviceValueReader.characteristics

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Interaction.Toolkit.Inputs.Readers

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.0/api/UnityEngine.XR.Interaction.Toolkit.Inputs.Readers.XRInputDeviceBoolValueReader.html")]
[CreateAssetMenu(fileName = "XRInputDeviceBoolValueReader", menuName = "XR/Input Value Reader/bool")]
public class XRInputDeviceBoolValueReader : XRInputDeviceValueReader<bool>, IXRInputValueReader<bool>, IXRInputValueReader

Methods

ReadValue()

Read the current value from the input source.

Declaration

public override bool ReadValue()

Returns

Type	Description
bool	Returns the current value from the input source. May return default(TValue) if unused or no source is set.

Overrides

XRInputDeviceValueReader<bool>.ReadValue()

TryReadValue(out bool)

Try to read the current value from the input source.

Declaration

public override bool TryReadValue(out bool value)

Parameters

Type	Name	Description
bool	value	When this method returns, contains the current value from the input source. May return default(TValue) if unused or no source is set.

Returns

Type	Description
bool	Returns true if the current value was able to be read (and for actions, also if in progress).

Overrides

XRInputDeviceValueReader<bool>.TryReadValue(out bool)

Remarks

You can use the return value of this method instead of only using ReadValue() in order to avoid doing any work when the input action is not in progress, such as when the control is not actuated. This can be useful for performance reasons.
If an input processor on an input action returns a different value from the default bool when the input action is not in progress, the outvalue returned by this method may not be default(TValue) as is typically the case for Try- methods. If you need to support processors that return a different value from the default when the control is not actuated, you should use ReadValue() instead of using the return value of this method to skip input handling.

Implements

IXRInputValueReader<TValue>

IXRInputValueReader