Class Vector3Control

A floating-point 3D vector control composed of three AxisControls.

Inheritance
object
InputControl
InputControl<Vector3>
Vector3Control
Inherited Members
Namespace: UnityEngine.InputSystem.Controls
Assembly: Unity.InputSystem.dll
Syntax
public class Vector3Control : InputControl<Vector3>

Constructors

Vector3Control()

Declaration
public Vector3Control()

Properties

x

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

y

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

z

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

Methods

CalculateOptimizedControlDataType()

Calculates and returns a optimized data type that can represent a control's value in memory directly. The value then is cached in optimizedControlDataType. This method is for internal use only, you should not call this from your own code.

Declaration
protected override FourCC CalculateOptimizedControlDataType()
Returns
Type Description
FourCC
Overrides

EvaluateMagnitude(void*)

Compute an absolute, normalized magnitude value that indicates the extent to which the control is actuated in the given state.

Declaration
public override float EvaluateMagnitude(void* statePtr)
Parameters
Type Name Description
void* statePtr

State containing the control's stateBlock.
Returns
Type Description
float

Amount of actuation of the control or -1 if it cannot be determined.
Overrides
See Also

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.

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");
         }
     }</code></pre></example>

ReadUnprocessedValueFromState(void*)

Declaration
public override Vector3 ReadUnprocessedValueFromState(void* statePtr)
Parameters
Type Name Description
void* statePtr
Returns
Type Description
Vector3
Overrides

WriteValueIntoState(Vector3, void*)

Declaration
public override void WriteValueIntoState(Vector3 value, void* statePtr)
Parameters
Type Name Description
Vector3 value
void* statePtr
Overrides

Extension Methods