Class InputProcessorResult

Namespace

FlowGraph.Avalonia.Input

Assembly

FlowGraph.Avalonia.dll

Result of an input processor's handling.

public record InputProcessorResult : IEquatable<InputProcessorResult>

Inheritance

object

InputProcessorResult

Implements

IEquatable<InputProcessorResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

InputProcessorResult(IInputState?, bool)

Result of an input processor's handling.

public InputProcessorResult(IInputState? NewState, bool Handled)

Parameters

NewState IInputState

Optional new state to transition to.

Handled bool

Whether this input was handled (stops propagation to lower-priority processors).

Properties

Handled

Whether this input was handled (stops propagation to lower-priority processors).

public bool Handled { get; init; }

Property Value

bool

HandledStay

The processor handled this input but state remains unchanged.

public static InputProcessorResult HandledStay { get; }

Property Value

InputProcessorResult

NewState

Optional new state to transition to.

public IInputState? NewState { get; init; }

Property Value

IInputState

NotHandled

The processor did not handle this input. Continue to next processor.

public static InputProcessorResult NotHandled { get; }

Property Value

InputProcessorResult

Methods

TransitionTo(IInputState)

The processor handled this input and wants to transition to a new state.

public static InputProcessorResult TransitionTo(IInputState newState)

Parameters

newState IInputState

Returns

InputProcessorResult