Class QuaternionControl
A generic input control reading quaternion (rotation) values.
Inherited Members
Namespace: UnityEngine .InputSystem .Controls
Assembly: Unity.InputSystem.dll
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; set; }Property Value
| Type | Description |
|---|---|
| Axis |
Control representing the W component. |
x
The X component of the quaternion.
Declaration
public AxisControl x { get; set; }Property Value
| Type | Description |
|---|---|
| Axis |
Control representing the X component. |
y
The Y component of the quaternion.
Declaration
public AxisControl y { get; set; }Property Value
| Type | Description |
|---|---|
| Axis |
Control representing the Y component. |
z
The Z component of the quaternion.
Declaration
public AxisControl z { get; set; }Property Value
| Type | Description |
|---|---|
| Axis |
Control representing the Z component. |
Methods
CalculateOptimizedControlDataType()
Calculates and returns an optimized data type that can represent a control's value in memory directly.
Declaration
protected override FourCC CalculateOptimizedControlDataType()Returns
| Type | Description |
|---|---|
| Four |
An optimized data type that can represent a control's value in memory directly. Input |
Overrides
Remarks
The value then is cached in optimized
FinishSetup()
Perform final initialization tasks after the control hierarchy has been put into place.
Declaration
protected override void FinishSetup()Overrides
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.
Examples
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*)
Read value from provided statePtr.
Declaration
public override Quaternion ReadUnprocessedValueFromState(void* statePtr)Parameters
| Type | Name | Description |
|---|---|---|
| void* | statePtr | State pointer to read from. |
Returns
| Type | Description |
|---|---|
| Quaternion | The controls current value. |
Overrides
Remarks
Read value from provided statePtr without any caching.
See Also
WriteValueIntoState(Quaternion, void*)
Write a value into state at the given memory.
Declaration
public override void WriteValueIntoState(Quaternion value, void* statePtr)Parameters
| Type | Name | Description |
|---|---|---|
| Quaternion | value | Value for the control to store in the state. |
| void* | statePtr | State containing the control's state |
Overrides
Remarks
Writing values will NOT apply processors to the given value. This can mean that when reading a value from a control after it has been written to its state, the resulting value differs from what was written.
Exceptions
| Type | Condition |
|---|---|
| Not |
The control does not support writing. This is the case, for example, that compute values (such as the magnitude of a vector). |