Class AxisControl

A floating-point axis control.

Inheritance
System.Object
InputControl
InputControl<System.Single>
AxisControl
ButtonControl
Inherited Members
Namespace: UnityEngine.InputSystem.Controls
Syntax
public class AxisControl : InputControl<float>
Remarks

Can optionally be configured to perform normalization. Stored as either a float, a short, a byte, or a single bit.

Constructors

AxisControl()

Declaration
public AxisControl()

Fields

clamp

Declaration
public bool clamp
Field Value
Type Description
System.Boolean

clampConstant

Declaration
public float clampConstant
Field Value
Type Description
System.Single

clampMax

Declaration
public float clampMax
Field Value
Type Description
System.Single

clampMin

Declaration
public float clampMin
Field Value
Type Description
System.Single

clampToConstant

Declaration
public bool clampToConstant
Field Value
Type Description
System.Boolean

invert

Declaration
public bool invert
Field Value
Type Description
System.Boolean

normalize

Declaration
public bool normalize
Field Value
Type Description
System.Boolean

normalizeMax

Declaration
public float normalizeMax
Field Value
Type Description
System.Single

normalizeMin

Declaration
public float normalizeMin
Field Value
Type Description
System.Single

normalizeZero

Declaration
public float normalizeZero
Field Value
Type Description
System.Single

scale

Declaration
public bool scale
Field Value
Type Description
System.Boolean

scaleFactor

Declaration
public float scaleFactor
Field Value
Type Description
System.Single

Methods

CompareValue(Void*, Void*)

Declaration
public override bool CompareValue(void *firstStatePtr, void *secondStatePtr)
Parameters
Type Name Description
System.Void* firstStatePtr
System.Void* secondStatePtr
Returns
Type Description
System.Boolean
Overrides
UnityEngine.InputSystem.InputControl<System.Single>.CompareValue(System.Void*, System.Void*)

EvaluateMagnitude(Void*)

Declaration
public override float EvaluateMagnitude(void *statePtr)
Parameters
Type Name Description
System.Void* statePtr
Returns
Type Description
System.Single
Overrides

Preprocess(Single)

Declaration
protected float Preprocess(float value)
Parameters
Type Name Description
System.Single value
Returns
Type Description
System.Single

ReadUnprocessedValueFromState(Void*)

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

WriteValueIntoState(Single, Void*)

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

Extension Methods