1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-20 00:13:04 +08:00
osu-lazer/osu.Game/Rulesets/UI/RulesetInputManager.cs

245 lines
7.9 KiB
C#
Raw Normal View History

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
2018-04-13 17:19:50 +08:00
2020-03-23 18:03:42 +08:00
using System;
2018-04-13 17:19:50 +08:00
using System.Linq;
using osu.Framework.Allocation;
2019-02-21 18:04:31 +08:00
using osu.Framework.Bindables;
2018-04-13 17:19:50 +08:00
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Input;
using osu.Framework.Input.Bindings;
using osu.Framework.Input.Events;
using osu.Framework.Input.StateChanges.Events;
2018-07-21 10:38:28 +08:00
using osu.Framework.Input.States;
2018-04-13 17:19:50 +08:00
using osu.Game.Configuration;
using osu.Game.Input;
2018-04-13 17:19:50 +08:00
using osu.Game.Input.Bindings;
using osu.Game.Input.Handlers;
using osu.Game.Rulesets.Scoring;
2018-04-13 17:19:50 +08:00
using osu.Game.Screens.Play;
2018-06-11 22:00:26 +08:00
using static osu.Game.Input.Handlers.ReplayInputHandler;
2018-04-13 17:19:50 +08:00
namespace osu.Game.Rulesets.UI
{
2020-03-23 18:31:43 +08:00
public abstract class RulesetInputManager<T> : PassThroughInputManager, ICanAttachKeyCounter, IHasReplayHandler, IHasRecordingHandler
2018-04-13 17:19:50 +08:00
where T : struct
{
public readonly KeyBindingContainer<T> KeyBindingContainer;
private readonly Ruleset ruleset;
[Resolved(CanBeNull = true)]
private ScoreProcessor scoreProcessor { get; set; }
2020-03-23 18:03:42 +08:00
private ReplayRecorder recorder;
public ReplayRecorder Recorder
{
set
{
if (value != null && recorder != null)
2020-03-23 18:03:42 +08:00
throw new InvalidOperationException("Cannot attach more than one recorder");
recorder?.Expire();
2020-03-23 18:03:42 +08:00
recorder = value;
if (recorder != null)
KeyBindingContainer.Add(recorder);
2020-03-23 18:03:42 +08:00
}
}
protected override InputState CreateInitialState() => new RulesetInputManagerInputState<T>(base.CreateInitialState());
2018-06-11 22:00:26 +08:00
protected override Container<Drawable> Content => content;
private readonly Container content;
2018-04-13 17:19:50 +08:00
protected RulesetInputManager(RulesetInfo ruleset, int variant, SimultaneousBindingMode unique)
{
this.ruleset = ruleset.CreateInstance();
InternalChild = KeyBindingContainer =
CreateKeyBindingContainer(ruleset, variant, unique)
.WithChild(content = new Container { RelativeSizeAxes = Axes.Both });
}
[BackgroundDependencyLoader(true)]
private void load(OsuConfigManager config)
{
mouseDisabled = config.GetBindable<bool>(OsuSetting.MouseDisableButtons);
2018-04-13 17:19:50 +08:00
}
#region Action mapping (for replays)
public override void HandleInputStateChange(InputStateChangeEvent inputStateChange)
2018-04-13 17:19:50 +08:00
{
switch (inputStateChange)
2018-06-11 22:00:26 +08:00
{
case ReplayStateChangeEvent<T> stateChangeEvent:
foreach (var action in stateChangeEvent.ReleasedActions)
KeyBindingContainer.TriggerReleased(action);
2018-04-13 17:19:50 +08:00
foreach (var action in stateChangeEvent.PressedActions)
KeyBindingContainer.TriggerPressed(action);
break;
case ReplayStatisticsFrameEvent statisticsStateChangeEvent:
scoreProcessor?.ResetFromReplayFrame(ruleset, statisticsStateChangeEvent.Frame);
break;
default:
base.HandleInputStateChange(inputStateChange);
break;
2018-06-11 22:00:26 +08:00
}
2018-04-13 17:19:50 +08:00
}
#endregion
#region IHasReplayHandler
private ReplayInputHandler replayInputHandler;
2018-04-13 17:19:50 +08:00
public ReplayInputHandler ReplayInputHandler
{
get => replayInputHandler;
2018-04-13 17:19:50 +08:00
set
{
if (replayInputHandler != null) RemoveHandler(replayInputHandler);
replayInputHandler = value;
2018-06-11 22:00:26 +08:00
UseParentInput = replayInputHandler == null;
2018-04-13 17:19:50 +08:00
if (replayInputHandler != null)
AddHandler(replayInputHandler);
}
}
#endregion
#region Setting application (disables etc.)
private Bindable<bool> mouseDisabled;
protected override bool Handle(UIEvent e)
{
2018-10-04 16:55:31 +08:00
switch (e)
{
case MouseDownEvent _:
2018-10-04 16:55:31 +08:00
if (mouseDisabled.Value)
return true; // importantly, block upwards propagation so global bindings also don't fire.
2018-10-04 16:55:31 +08:00
break;
2019-04-01 11:44:46 +08:00
2018-10-04 16:55:31 +08:00
case MouseUpEvent mouseUp:
if (!CurrentState.Mouse.IsPressed(mouseUp.Button))
return false;
2018-10-04 16:55:31 +08:00
break;
}
return base.Handle(e);
}
protected override bool HandleMouseTouchStateChange(TouchStateChangeEvent e)
{
if (mouseDisabled.Value)
{
// Only propagate positional data when mouse buttons are disabled.
e = new TouchStateChangeEvent(e.State, e.Input, e.Touch, false, e.LastPosition);
}
return base.HandleMouseTouchStateChange(e);
}
2018-04-13 17:19:50 +08:00
#endregion
#region Key Counter Attachment
public void Attach(KeyCounterDisplay keyCounter)
2018-04-13 17:19:50 +08:00
{
var receptor = new ActionReceptor(keyCounter);
KeyBindingContainer.Add(receptor);
keyCounter.SetReceptor(receptor);
keyCounter.AddRange(KeyBindingContainer.DefaultKeyBindings
.Select(b => b.GetAction<T>())
.Distinct()
.OrderBy(action => action)
.Select(action => new KeyCounterAction<T>(action)));
2018-04-13 17:19:50 +08:00
}
public class ActionReceptor : KeyCounterDisplay.Receptor, IKeyBindingHandler<T>
2018-04-13 17:19:50 +08:00
{
public ActionReceptor(KeyCounterDisplay target)
2018-04-13 17:19:50 +08:00
: base(target)
{
}
2021-09-16 17:26:12 +08:00
public bool OnPressed(KeyBindingPressEvent<T> e) => Target.Children.OfType<KeyCounterAction<T>>().Any(c => c.OnPressed(e.Action, Clock.Rate >= 0));
2018-04-13 17:19:50 +08:00
2021-09-16 17:26:12 +08:00
public void OnReleased(KeyBindingReleaseEvent<T> e)
{
foreach (var c in Target.Children.OfType<KeyCounterAction<T>>())
2021-09-16 17:26:12 +08:00
c.OnReleased(e.Action, Clock.Rate >= 0);
}
2018-04-13 17:19:50 +08:00
}
#endregion
2018-06-07 19:24:33 +08:00
2020-03-23 16:33:02 +08:00
protected virtual KeyBindingContainer<T> CreateKeyBindingContainer(RulesetInfo ruleset, int variant, SimultaneousBindingMode unique)
2018-06-07 19:24:33 +08:00
=> new RulesetKeyBindingContainer(ruleset, variant, unique);
2019-01-23 13:51:13 +08:00
public class RulesetKeyBindingContainer : DatabasedKeyBindingContainer<T>
{
protected override bool HandleRepeats => false;
2019-01-23 13:51:13 +08:00
public RulesetKeyBindingContainer(RulesetInfo ruleset, int variant, SimultaneousBindingMode unique)
: base(ruleset, variant, unique)
{
}
protected override void ReloadMappings()
{
base.ReloadMappings();
KeyBindings = KeyBindings.Where(b => RealmKeyBindingStore.CheckValidForGameplay(b.KeyCombination)).ToList();
}
2019-01-23 13:51:13 +08:00
}
2018-04-13 17:19:50 +08:00
}
/// <summary>
/// Expose the <see cref="ReplayInputHandler"/> in a capable <see cref="InputManager"/>.
/// </summary>
public interface IHasReplayHandler
{
ReplayInputHandler ReplayInputHandler { get; set; }
}
2020-03-23 18:31:43 +08:00
public interface IHasRecordingHandler
{
public ReplayRecorder Recorder { set; }
}
2018-04-13 17:19:50 +08:00
/// <summary>
/// Supports attaching a <see cref="KeyCounterDisplay"/>.
2018-04-13 17:19:50 +08:00
/// Keys will be populated automatically and a receptor will be injected inside.
/// </summary>
public interface ICanAttachKeyCounter
{
void Attach(KeyCounterDisplay keyCounter);
2018-04-13 17:19:50 +08:00
}
2018-06-11 22:00:26 +08:00
public class RulesetInputManagerInputState<T> : InputState
where T : struct
2018-06-11 22:00:26 +08:00
{
public ReplayState<T> LastReplayState;
public RulesetInputManagerInputState(InputState state = null)
: base(state)
{
}
2018-06-11 22:00:26 +08:00
}
2018-04-13 17:19:50 +08:00
}