docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class XRInputDeviceVector3ValueReader

    A ScriptableObject that provides a Vector3 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.

    Inheritance
    object
    Object
    ScriptableObject
    XRInputDeviceValueReader
    XRInputDeviceValueReader<Vector3>
    XRInputDeviceVector3ValueReader
    Implements
    IXRInputValueReader<Vector3>
    IXRInputValueReader
    Inherited Members
    XRInputDeviceValueReader<Vector3>.usage
    XRInputDeviceValueReader<Vector3>.ReadBoolValue()
    XRInputDeviceValueReader<Vector3>.ReadUIntValue()
    XRInputDeviceValueReader<Vector3>.ReadFloatValue()
    XRInputDeviceValueReader<Vector3>.ReadVector2Value()
    XRInputDeviceValueReader<Vector3>.ReadVector3Value()
    XRInputDeviceValueReader<Vector3>.ReadQuaternionValue()
    XRInputDeviceValueReader<Vector3>.ReadInputTrackingStateValue()
    XRInputDeviceValueReader<Vector3>.TryReadBoolValue(out bool)
    XRInputDeviceValueReader<Vector3>.TryReadUIntValue(out uint)
    XRInputDeviceValueReader<Vector3>.TryReadFloatValue(out float)
    XRInputDeviceValueReader<Vector3>.TryReadVector2Value(out Vector2)
    XRInputDeviceValueReader<Vector3>.TryReadVector3Value(out Vector3)
    XRInputDeviceValueReader<Vector3>.TryReadQuaternionValue(out Quaternion)
    XRInputDeviceValueReader<Vector3>.TryReadInputTrackingStateValue(out InputTrackingState)
    XRInputDeviceValueReader<Vector3>.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.XRInputDeviceVector3ValueReader.html")]
    [CreateAssetMenu(fileName = "XRInputDeviceVector3ValueReader", menuName = "XR/Input Value Reader/Vector3")]
    public class XRInputDeviceVector3ValueReader : XRInputDeviceValueReader<Vector3>, IXRInputValueReader<Vector3>, IXRInputValueReader

    Methods

    ReadValue()

    Read the current value from the input source.

    Declaration
    public override Vector3 ReadValue()
    Returns
    Type Description
    Vector3

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

    Overrides
    XRInputDeviceValueReader<Vector3>.ReadValue()

    TryReadValue(out Vector3)

    Try to read the current value from the input source.

    Declaration
    public override bool TryReadValue(out Vector3 value)
    Parameters
    Type Name Description
    Vector3 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<Vector3>.TryReadValue(out Vector3)
    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 Vector3 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
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)