This commit is contained in:
2025-01-17 13:10:42 +01:00
commit 4536213c91
15115 changed files with 1442174 additions and 0 deletions

View File

@@ -0,0 +1,65 @@
using System;
using UnityEngine.InputSystem.LowLevel;
namespace UnityEngine.InputSystem.Utilities
{
internal class ForDeviceEventObservable : IObservable<InputEventPtr>
{
private IObservable<InputEventPtr> m_Source;
private InputDevice m_Device;
private Type m_DeviceType;
public ForDeviceEventObservable(IObservable<InputEventPtr> source, Type deviceType, InputDevice device)
{
m_Source = source;
m_DeviceType = deviceType;
m_Device = device;
}
public IDisposable Subscribe(IObserver<InputEventPtr> observer)
{
return m_Source.Subscribe(new ForDevice(m_DeviceType, m_Device, observer));
}
private class ForDevice : IObserver<InputEventPtr>
{
private IObserver<InputEventPtr> m_Observer;
private InputDevice m_Device;
private Type m_DeviceType;
public ForDevice(Type deviceType, InputDevice device, IObserver<InputEventPtr> observer)
{
m_Device = device;
m_DeviceType = deviceType;
m_Observer = observer;
}
public void OnCompleted()
{
}
public void OnError(Exception error)
{
Debug.LogException(error);
}
public void OnNext(InputEventPtr value)
{
if (m_DeviceType != null)
{
var device = InputSystem.GetDeviceById(value.deviceId);
if (device == null)
return;
if (!m_DeviceType.IsInstanceOfType(device))
return;
}
if (m_Device != null && value.deviceId != m_Device.deviceId)
return;
m_Observer.OnNext(value);
}
}
}
}

View File

@@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: 8242c97e8771412fb5f5637b7278e18f
timeCreated: 1627655656

View File

@@ -0,0 +1,243 @@
using System;
using System.Collections.Generic;
using UnityEngine.InputSystem.LowLevel;
namespace UnityEngine.InputSystem.Utilities
{
/// <summary>
/// Extension methods for working with <a ref="https://docs.microsoft.com/en-us/dotnet/api/system.iobservable-1">IObservable</a>
/// in the context of the Input System.
/// </summary>
public static class Observable
{
/// <summary>
/// Filter a stream of observable values by a predicate.
/// </summary>
/// <param name="source">The stream of observable values.</param>
/// <param name="predicate">Filter to apply to the stream. Only values for which the predicate returns true
/// are passed on to <c>OnNext</c> of the observer.</param>
/// <typeparam name="TValue">Value type for the observable stream.</typeparam>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is <c>null</c> -or- <paramref name="predicate"/> is <c>null</c>.</exception>
/// <returns>A new observable that is filtered by the given predicate.</returns>
/// <remarks>
/// <example>
/// <code>
/// InputSystem.onEvent
/// .Where(e => e.HasButtonPress())
/// .Call(e => Debug.Log("Press"));
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="InputEventListener"/>
/// <seealso cref="InputSystem.onEvent"/>
public static IObservable<TValue> Where<TValue>(this IObservable<TValue> source, Func<TValue, bool> predicate)
{
if (source == null)
throw new ArgumentNullException(nameof(source));
if (predicate == null)
throw new ArgumentNullException(nameof(predicate));
return new WhereObservable<TValue>(source, predicate);
}
/// <summary>
/// Transform each value in an observable stream of values into a value of a different type.
/// </summary>
/// <param name="source">The stream of observable values.</param>
/// <param name="filter">Function to transform values in the stream.</param>
/// <typeparam name="TSource">Type of source values to transform from.</typeparam>
/// <typeparam name="TResult">Type of target values to transform to.</typeparam>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is <c>null</c> -or- <paramref name="filter"/> is <c>null</c>.</exception>
/// <returns>A new observable of values of the new result type.</returns>
/// <remarks>
/// <example>
/// <code>
/// InputSystem.onEvent
/// .Select(eventPtr => eventPtr.GetFirstButtonPressOrNull())
/// .Call(ctrl =>
/// {
/// if (ctrl != null)
/// Debug.Log(ctrl);
/// });
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="InputEventListener"/>
/// <seealso cref="InputSystem.onEvent"/>
public static IObservable<TResult> Select<TSource, TResult>(this IObservable<TSource> source, Func<TSource, TResult> filter)
{
if (source == null)
throw new ArgumentNullException(nameof(source));
if (filter == null)
throw new ArgumentNullException(nameof(filter));
return new SelectObservable<TSource, TResult>(source, filter);
}
/// <summary>
/// Transform each value in an observable stream of values such that one value is translated to zero or more values
/// of a new type.
/// </summary>
/// <param name="source">The stream of observable values.</param>
/// <param name="filter">Function to transform each value in the stream into zero or more new values.</param>
/// <typeparam name="TSource">Type of source values to transform from.</typeparam>
/// <typeparam name="TResult">Type of target values to transform to.</typeparam>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is <c>null</c> -or- <paramref name="filter"/> is <c>null</c>.</exception>
/// <returns>A new observable of values of the new result type.</returns>
/// <remarks>
/// <example>
/// <code>
/// InputSystem.onEvent
/// .SelectMany(eventPtr => eventPtr.GetAllButtonPresses())
/// .Call(ctrl =>
/// Debug.Log($"Button {ctrl} pressed"));
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="InputEventListener"/>
/// <seealso cref="InputSystem.onEvent"/>
public static IObservable<TResult> SelectMany<TSource, TResult>(this IObservable<TSource> source, Func<TSource, IEnumerable<TResult>> filter)
{
if (source == null)
throw new ArgumentNullException(nameof(source));
if (filter == null)
throw new ArgumentNullException(nameof(filter));
return new SelectManyObservable<TSource, TResult>(source, filter);
}
/// <summary>
/// Take up to the first N values from the given observable stream of values.
/// </summary>
/// <param name="source">An observable source of values.</param>
/// <param name="count">The maximum number of values to take from the source.</param>
/// <typeparam name="TValue">Types of values to read from the stream.</typeparam>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="count"/> is negative.</exception>
/// <returns>A stream of up to <paramref name="count"/> values.</returns>
public static IObservable<TValue> Take<TValue>(this IObservable<TValue> source, int count)
{
if (source == null)
throw new ArgumentNullException(nameof(source));
if (count < 0)
throw new ArgumentOutOfRangeException(nameof(count));
return new TakeNObservable<TValue>(source, count);
}
/// <summary>
/// From an observable stream of events, take only those that are for the given <paramref name="device"/>.
/// </summary>
/// <param name="source">An observable stream of events.</param>
/// <param name="device">Device to filter events for.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is <c>null</c>.</exception>
/// <returns>An observable stream of events for the given device.</returns>
/// <remarks>
/// Each event has an <see cref="InputEvent.deviceId"/> associated with it. This is used to match
/// against the <see cref="InputDevice.deviceId"/> of <paramref name="device"/>.
///
/// <example>
/// <code>
/// InputSystem.onEvent
/// .ForDevice(Mouse.current)
/// .Call(e => Debug.Log($"Mouse event: {e}");
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="InputEvent.deviceId"/>
/// <seealso cref="InputEventListener"/>
/// <seealso cref="InputSystem.onEvent"/>
public static IObservable<InputEventPtr> ForDevice(this IObservable<InputEventPtr> source, InputDevice device)
{
if (source == null)
throw new ArgumentNullException(nameof(source));
return new ForDeviceEventObservable(source, null, device);
}
/// <summary>
/// From an observable stream of events, take only those that are for a device of the given type.
/// </summary>
/// <param name="source">An observable stream of events.</param>
/// <typeparam name="TDevice">Type of device (such as <see cref="Gamepad"/>) to filter for.</typeparam>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is <c>null</c>.</exception>
/// <returns>An observable stream of events for devices of type <typeparamref name="TDevice"/>.</returns>
/// <remarks>
/// <example>
/// <code>
/// InputSystem.onEvent
/// .ForDevice&lt;Gamepad&gt;()
/// .Where(e => e.HasButtonPress())
/// .CallOnce(e => PlayerInput.Instantiate(myPrefab,
/// pairWithDevice: InputSystem.GetDeviceById(e.deviceId)));
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="InputEventListener"/>
/// <seealso cref="InputSystem.onEvent"/>
public static IObservable<InputEventPtr> ForDevice<TDevice>(this IObservable<InputEventPtr> source)
where TDevice : InputDevice
{
if (source == null)
throw new ArgumentNullException(nameof(source));
return new ForDeviceEventObservable(source, typeof(TDevice), null);
}
/// <summary>
/// Call an action for the first value in the given stream of values and then automatically dispose
/// the observer.
/// </summary>
/// <param name="source">An observable source of values.</param>
/// <param name="action">Action to call for the first value that arrives from the source.</param>
/// <typeparam name="TValue">Type of values delivered by the source.</typeparam>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is <c>null</c> -or- <paramref name="action"/> is <c>null</c>.</exception>
/// <returns>A handle to the subscription. Call <c>Dispose</c> to unsubscribe at any time.</returns>
/// <remarks>
/// <example>
/// <code>
/// InputSystem.onEvent
/// .Where(e => e.type == DeviceConfigurationEvent.typeStatic)
/// .CallOnce(_ => Debug.Log("Device configuration changed"));
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="InputEventListener"/>
/// <seealso cref="InputSystem.onEvent"/>
/// <seealso cref="Call{TValue}"/>
public static IDisposable CallOnce<TValue>(this IObservable<TValue> source, Action<TValue> action)
{
if (source == null)
throw new ArgumentNullException(nameof(source));
if (action == null)
throw new ArgumentNullException(nameof(action));
IDisposable subscription = null;
subscription = source.Take(1).Subscribe(new Observer<TValue>(action, () => subscription?.Dispose()));
return subscription;
}
/// <summary>
/// Call the given callback for every value generated by the given observable stream of values.
/// </summary>
/// <param name="source">An observable stream of values.</param>
/// <param name="action">A callback to invoke for each value.</param>
/// <typeparam name="TValue"></typeparam>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is <c>null</c> -or- <paramref name="action"/> is <c>null</c>.</exception>
/// <returns>A handle to the subscription. Call <c>Dispose</c> to unsubscribe at any time.</returns>
/// <remarks>
/// <example>
/// <code>
/// InputSystem.onEvent
/// .Where(e => e.type == DeviceConfigurationEvent.typeStatic)
/// .Call(_ => Debug.Log("Device configuration changed"));
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="InputEventListener"/>
/// <seealso cref="InputSystem.onEvent"/>
/// <seealso cref="CallOnce{TValue}"/>
public static IDisposable Call<TValue>(this IObservable<TValue> source, Action<TValue> action)
{
if (source == null)
throw new ArgumentNullException(nameof(source));
if (action == null)
throw new ArgumentNullException(nameof(action));
return source.Subscribe(new Observer<TValue>(action));
}
}
}

View File

@@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: a9586270a56c4658a83ff649811e0cb3
timeCreated: 1627654668

View File

@@ -0,0 +1,31 @@
using System;
namespace UnityEngine.InputSystem.Utilities
{
internal class Observer<TValue> : IObserver<TValue>
{
private Action<TValue> m_OnNext;
private Action m_OnCompleted;
public Observer(Action<TValue> onNext, Action onCompleted = null)
{
m_OnNext = onNext;
m_OnCompleted = onCompleted;
}
public void OnCompleted()
{
m_OnCompleted?.Invoke();
}
public void OnError(Exception error)
{
Debug.LogException(error);
}
public void OnNext(TValue evt)
{
m_OnNext?.Invoke(evt);
}
}
}

View File

@@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: 92b3f5ed3a3e41daaf0bed64ebc854d9
timeCreated: 1627651936

View File

@@ -0,0 +1,49 @@
using System;
using System.Collections.Generic;
namespace UnityEngine.InputSystem.Utilities
{
internal class SelectManyObservable<TSource, TResult> : IObservable<TResult>
{
private readonly IObservable<TSource> m_Source;
private readonly Func<TSource, IEnumerable<TResult>> m_Filter;
public SelectManyObservable(IObservable<TSource> source, Func<TSource, IEnumerable<TResult>> filter)
{
m_Source = source;
m_Filter = filter;
}
public IDisposable Subscribe(IObserver<TResult> observer)
{
return m_Source.Subscribe(new Select(this, observer));
}
private class Select : IObserver<TSource>
{
private SelectManyObservable<TSource, TResult> m_Observable;
private readonly IObserver<TResult> m_Observer;
public Select(SelectManyObservable<TSource, TResult> observable, IObserver<TResult> observer)
{
m_Observable = observable;
m_Observer = observer;
}
public void OnCompleted()
{
}
public void OnError(Exception error)
{
Debug.LogException(error);
}
public void OnNext(TSource evt)
{
foreach (var result in m_Observable.m_Filter(evt))
m_Observer.OnNext(result);
}
}
}
}

View File

@@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: 3e12c30fe9774947a81ce7eb7054cfb7
timeCreated: 1627658976

View File

@@ -0,0 +1,48 @@
using System;
namespace UnityEngine.InputSystem.LowLevel
{
internal class SelectObservable<TSource, TResult> : IObservable<TResult>
{
private readonly IObservable<TSource> m_Source;
private readonly Func<TSource, TResult> m_Filter;
public SelectObservable(IObservable<TSource> source, Func<TSource, TResult> filter)
{
m_Source = source;
m_Filter = filter;
}
public IDisposable Subscribe(IObserver<TResult> observer)
{
return m_Source.Subscribe(new Select(this, observer));
}
private class Select : IObserver<TSource>
{
private SelectObservable<TSource, TResult> m_Observable;
private readonly IObserver<TResult> m_Observer;
public Select(SelectObservable<TSource, TResult> observable, IObserver<TResult> observer)
{
m_Observable = observable;
m_Observer = observer;
}
public void OnCompleted()
{
}
public void OnError(Exception error)
{
Debug.LogException(error);
}
public void OnNext(TSource evt)
{
var result = m_Observable.m_Filter(evt);
m_Observer.OnNext(result);
}
}
}
}

View File

@@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: 29a78370a46c4b59875764266185b105
timeCreated: 1627651658

View File

@@ -0,0 +1,57 @@
using System;
namespace UnityEngine.InputSystem.Utilities
{
internal class TakeNObservable<TValue> : IObservable<TValue>
{
private IObservable<TValue> m_Source;
private int m_Count;
public TakeNObservable(IObservable<TValue> source, int count)
{
m_Source = source;
m_Count = count;
}
public IDisposable Subscribe(IObserver<TValue> observer)
{
return m_Source.Subscribe(new Take(this, observer));
}
private class Take : IObserver<TValue>
{
private IObserver<TValue> m_Observer;
private int m_Remaining;
public Take(TakeNObservable<TValue> observable, IObserver<TValue> observer)
{
m_Observer = observer;
m_Remaining = observable.m_Count;
}
public void OnCompleted()
{
}
public void OnError(Exception error)
{
Debug.LogException(error);
}
public void OnNext(TValue evt)
{
if (m_Remaining <= 0)
return;
m_Remaining--;
m_Observer.OnNext(evt);
if (m_Remaining == 0)
{
m_Observer.OnCompleted();
m_Observer = default;
}
}
}
}
}

View File

@@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: 25881642ba784356b23ef34898fdc690
timeCreated: 1627651729

View File

@@ -0,0 +1,48 @@
using System;
namespace UnityEngine.InputSystem.Utilities
{
internal class WhereObservable<TValue> : IObservable<TValue>
{
private readonly IObservable<TValue> m_Source;
private readonly Func<TValue, bool> m_Predicate;
public WhereObservable(IObservable<TValue> source, Func<TValue, bool> predicate)
{
m_Source = source;
m_Predicate = predicate;
}
public IDisposable Subscribe(IObserver<TValue> observer)
{
return m_Source.Subscribe(new Where(this, observer));
}
private class Where : IObserver<TValue>
{
private WhereObservable<TValue> m_Observable;
private readonly IObserver<TValue> m_Observer;
public Where(WhereObservable<TValue> observable, IObserver<TValue> observer)
{
m_Observable = observable;
m_Observer = observer;
}
public void OnCompleted()
{
}
public void OnError(Exception error)
{
Debug.LogException(error);
}
public void OnNext(TValue evt)
{
if (m_Observable.m_Predicate(evt))
m_Observer.OnNext(evt);
}
}
}
}

View File

@@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: ea70775d141141a3bca036e60a89e8fa
timeCreated: 1627651688