Class ButtonFallbackComposite

A single Button value, such as the is tracked state, computed from an ordered list of bindings. Unity reads from the first binding that has a valid control.

Inheritance

object

InputBindingComposite

InputBindingComposite<float>

FallbackComposite<float>

ButtonFallbackComposite

Inherited Members

InputBindingComposite<float>.ReadValue(ref InputBindingCompositeContext, void*, int)

InputBindingComposite<float>.ReadValueAsObject(ref InputBindingCompositeContext)

InputBindingComposite<float>.valueType

InputBindingComposite<float>.valueSizeInBytes

InputBindingComposite.FinishSetup(ref InputBindingCompositeContext)

InputBindingComposite.GetExpectedControlLayoutName(string, string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.Interaction.Toolkit.Inputs.Composites

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[InitializeOnLoad]
[Preserve]
public class ButtonFallbackComposite : FallbackComposite<float>

Remarks

This composite allows for defining multiple binding paths, but unlike a Value action with multiple bindings which uses control magnitude to select the active control, this composite uses an ordered priority list of bindings. If the first input binding is not bound to an input control, it falls back to try the second input binding, and so on.

Fields

first

The first input control to evaluate.

Declaration

[InputControl(layout = "Button")]
public int first

Field Value

Type	Description
int

second

The second input control to evaluate.

Declaration

[InputControl(layout = "Button")]
public int second

Field Value

Type	Description
int

third

The third input control to evaluate.

Declaration

[InputControl(layout = "Button")]
public int third

Field Value

Type	Description
int

Methods

EvaluateMagnitude(ref InputBindingCompositeContext)

See InputBindingComposite<TValue>

Declaration

public override float EvaluateMagnitude(ref InputBindingCompositeContext context)

Parameters

Type	Name	Description
InputBindingCompositeContext	context	Callback context for the binding composite. Unity uses this to access the values supplied by part bindings.

Returns

Type	Description
float	float magnitude read from the context.

Overrides

InputBindingComposite.EvaluateMagnitude(ref InputBindingCompositeContext)

ReadValue(ref InputBindingCompositeContext)

See InputBindingComposite<TValue>

Declaration

public override float ReadValue(ref InputBindingCompositeContext context)

Parameters

Type	Name	Description
InputBindingCompositeContext	context	Callback context for the binding composite. Unity uses this to access the values supplied by part bindings.

Returns

Type	Description
float	float read from the context.

Overrides

UnityEngine.InputSystem.InputBindingComposite<float>.ReadValue(ref UnityEngine.InputSystem.InputBindingCompositeContext)