docs.unity3d.com
    Show / Hide Table of Contents

    Class QuaternionControl

    A generic input control reading quaternion (rotation) values.

    Inheritance
    Object
    InputControl
    InputControl<Quaternion>
    QuaternionControl
    Inherited Members
    InputControl<Quaternion>.valueType
    InputControl<Quaternion>.valueSizeInBytes
    InputControl<Quaternion>.ReadValue()
    InputControl<Quaternion>.ReadValueFromPreviousFrame()
    InputControl<Quaternion>.ReadDefaultValue()
    InputControl<Quaternion>.ReadValueFromState(Void*)
    InputControl<Quaternion>.ReadUnprocessedValue()
    InputControl<Quaternion>.ReadValueFromStateAsObject(Void*)
    InputControl<Quaternion>.ReadValueFromStateIntoBuffer(Void*, Void*, Int32)
    InputControl<Quaternion>.WriteValueFromBufferIntoState(Void*, Int32, Void*)
    InputControl<Quaternion>.WriteValueFromObjectIntoState(Object, Void*)
    InputControl<Quaternion>.ReadValueFromBufferAsObject(Void*, Int32)
    InputControl<Quaternion>.CompareValue(Void*, Void*)
    InputControl<Quaternion>.ProcessValue(Quaternion)
    InputControl.name
    InputControl.displayName
    InputControl.shortDisplayName
    InputControl.path
    InputControl.layout
    InputControl.variants
    InputControl.device
    InputControl.parent
    InputControl.children
    InputControl.usages
    InputControl.aliases
    InputControl.stateBlock
    InputControl.noisy
    InputControl.synthetic
    InputControl.Item[String]
    InputControl.ToString()
    InputControl.EvaluateMagnitude()
    InputControl.EvaluateMagnitude(Void*)
    InputControl.TryGetChildControl(String)
    InputControl.TryGetChildControl<TControl>(String)
    InputControl.GetChildControl(String)
    InputControl.GetChildControl<TControl>(String)
    InputControl.RefreshConfigurationIfNeeded()
    InputControl.RefreshConfiguration()
    InputControl.m_StateBlock
    InputControl.currentStatePtr
    InputControl.previousFrameStatePtr
    InputControl.defaultStatePtr
    InputControl.noiseMaskPtr
    InputControl.stateOffsetRelativeToDeviceRoot
    Namespace: UnityEngine.InputSystem.Controls
    Syntax
    public class QuaternionControl : InputControl<Quaternion>

    Constructors

    QuaternionControl()

    Default-initialize the control.

    Declaration
    public QuaternionControl()

    Properties

    w

    The W component of the quaternion.

    Declaration
    public AxisControl w { get; }
    Property Value
    Type Description
    AxisControl

    Control representing the W component.

    x

    The X component of the quaternion.

    Declaration
    public AxisControl x { get; }
    Property Value
    Type Description
    AxisControl

    Control representing the X component.

    y

    The Y component of the quaternion.

    Declaration
    public AxisControl y { get; }
    Property Value
    Type Description
    AxisControl

    Control representing the Y component.

    z

    The Z component of the quaternion.

    Declaration
    public AxisControl z { get; }
    Property Value
    Type Description
    AxisControl

    Control representing the Z component.

    Methods

    FinishSetup()

    Perform final initialization tasks after the control hierarchy has been put into place.

    Declaration
    protected override void FinishSetup()
    Overrides
    InputControl.FinishSetup()
    Remarks

    This method can be overridden to perform control- or device-specific setup work. The most common use case is for looking up child controls and storing them in local getters.

    public class MyDevice : InputDevice
    {
        public ButtonControl button { get; private set; }
        public AxisControl axis { get; private set; }
    
        protected override void OnFinishSetup()
        {
            // Cache controls in getters.
            button = GetChildControl("button");
            axis = GetChildControl("axis");
        }
    }

    ReadUnprocessedValueFromState(Void*)

    Declaration
    public override Quaternion ReadUnprocessedValueFromState(void *statePtr)
    Parameters
    Type Name Description
    Void* statePtr
    Returns
    Type Description
    Quaternion
    Overrides
    UnityEngine.InputSystem.InputControl<UnityEngine.Quaternion>.ReadUnprocessedValueFromState(System.Void*)

    WriteValueIntoState(Quaternion, Void*)

    Declaration
    public override void WriteValueIntoState(Quaternion value, void *statePtr)
    Parameters
    Type Name Description
    Quaternion value
    Void* statePtr
    Overrides
    UnityEngine.InputSystem.InputControl<UnityEngine.Quaternion>.WriteValueIntoState(UnityEngine.Quaternion, System.Void*)

    Extension Methods

    InputControlExtensions.FindInParentChain<TControl>(InputControl)
    InputControlExtensions.IsPressed(InputControl, Single)
    InputControlExtensions.IsActuated(InputControl, Single)
    InputControlExtensions.ReadValueAsObject(InputControl)
    InputControlExtensions.ReadValueIntoBuffer(InputControl, Void*, Int32)
    InputControlExtensions.ReadDefaultValueAsObject(InputControl)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr)
    InputControlExtensions.ReadValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.ReadValueFromEventAsObject(InputControl, InputEventPtr)
    InputControlExtensions.ReadUnprocessedValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr)
    InputControlExtensions.ReadUnprocessedValueFromEvent<TValue>(InputControl<TValue>, InputEventPtr, out TValue)
    InputControlExtensions.WriteValueFromObjectIntoEvent(InputControl, InputEventPtr, Object)
    InputControlExtensions.WriteValueIntoState(InputControl, Void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl, TValue, Void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl<TValue>, TValue, Void*)
    InputControlExtensions.WriteValueIntoState<TValue>(InputControl<TValue>, Void*)
    InputControlExtensions.WriteValueIntoState<TValue, TState>(InputControl<TValue>, TValue, ref TState)
    InputControlExtensions.WriteValueIntoEvent<TValue>(InputControl, TValue, InputEventPtr)
    InputControlExtensions.WriteValueIntoEvent<TValue>(InputControl<TValue>, TValue, InputEventPtr)
    InputControlExtensions.CheckStateIsAtDefault(InputControl)
    InputControlExtensions.CheckStateIsAtDefault(InputControl, Void*, Void*)
    InputControlExtensions.CheckStateIsAtDefaultIgnoringNoise(InputControl)
    InputControlExtensions.CheckStateIsAtDefaultIgnoringNoise(InputControl, Void*)
    InputControlExtensions.CompareStateIgnoringNoise(InputControl, Void*)
    InputControlExtensions.CompareState(InputControl, Void*, Void*, Void*)
    InputControlExtensions.CompareState(InputControl, Void*, Void*)
    InputControlExtensions.HasValueChangeInState(InputControl, Void*)
    InputControlExtensions.HasValueChangeInEvent(InputControl, InputEventPtr)
    InputControlExtensions.GetStatePtrFromStateEvent(InputControl, InputEventPtr)
    InputControlExtensions.ResetToDefaultStateInEvent(InputControl, InputEventPtr)
    InputControlExtensions.QueueValueChange<TValue>(InputControl<TValue>, TValue, Double)
    InputControlExtensions.FindControlsRecursive<TControl>(InputControl, IList<TControl>, Func<TControl, Boolean>)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023