feat(ui): #25 Phase K.3 — Settings panel + click-to-rebind + Phase K shipped
Phase K final commit. Settings panel with click-to-rebind UX on top of the K.1+K.2 input architecture, plus the roadmap / ISSUES / memory updates that retire Phase K. InputDispatcher gains BeginCapture / CancelCapture / IsCapturing / SetBindings — modal capture suppresses normal action firing for the next chord. Esc cancels (returns sentinel default chord); modifier-only keys don't complete capture; non-modifier key down with current modifier mask completes. IPanelRenderer + ImGuiPanelRenderer + FakePanelRenderer gain BeginMainMenuBar / EndMainMenuBar / BeginMenu / EndMenu / MenuItem primitives. SettingsVM owns a draft copy of KeyBindings with explicit Save / Cancel / Reset semantics. Click-to-rebind enters dispatcher capture mode; on chord captured, conflict-detect against draft (excluding the action being rebound itself); surface a ConflictPrompt when the chord collides; ResolveConflict(replace=true|false) commits or reverts. ResetActionToDefault restores a single action to RetailDefaults(); ResetAllToDefaults rebuilds the entire draft. Save invokes the onSave callback (which writes JSON + swaps the live dispatcher's bindings). SettingsPanel renders 8 retail-keymap-categorized CollapsingHeader sections (Movement, Postures, Camera, Combat, UI panels, Chat, Hotbar, Emotes). Per action: name + current binding(s) summary + "Rebind"/"Reset" buttons. Conflict prompt at the top when pending. Save / Cancel / "Reset all to retail defaults" at the top. GameWindow registers SettingsPanel + wires F11 → ToggleOptionsPanel → IsVisible toggle, plus a top-of-frame ImGui MainMenuBar with View → Settings/Vitals/Chat/Debug entries (calls ImGui directly — the abstraction methods exist for backend portability but the host doesn't own a menu-bar surface). Tests: +37 across InputDispatcherCaptureTests (7), IPanelRendererMainMenuBarTests (9), SettingsVMTests (13), SettingsPanelTests (8). Solution total 1220 green. Roadmap (docs/plans/2026-04-11-roadmap.md) appends Phase K shipped section after Phase J with K.1a–K.3 commit SHAs. ISSUES.md files Phase L deferred work as #L.1–#L.8 (hotbar UI, spellbook favorites, combat-mode dispatch, F-key panels, floating chat windows, UI layout save/load, joystick bindings, plugin input subscription) and adds #21–#25 to Recently closed. project_input_pipeline.md updated to shipped state. CLAUDE.md gets an input-pipeline reference. Closes Phase K. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Erik
parent
af74eac0c2
commit
f42c164b90
14 changed files with 1567 additions and 5 deletions
|
|
@ -0,0 +1,241 @@
|
|||
using System.IO;
|
||||
using System.Linq;
|
||||
using AcDream.UI.Abstractions.Input;
|
||||
using AcDream.UI.Abstractions.Panels.Settings;
|
||||
using AcDream.UI.Abstractions.Tests.Input;
|
||||
using Silk.NET.Input;
|
||||
|
||||
namespace AcDream.UI.Abstractions.Tests.Panels.Settings;
|
||||
|
||||
/// <summary>
|
||||
/// K.3: <see cref="SettingsVM"/> owns the click-to-rebind state machine
|
||||
/// for the Settings panel. It holds a <b>draft</b> copy of the active
|
||||
/// <see cref="KeyBindings"/>; rebinds modify the draft. Save commits to
|
||||
/// the supplied callback (which writes to disk + replaces the live
|
||||
/// dispatcher's table); Cancel reverts the draft.
|
||||
/// </summary>
|
||||
public sealed class SettingsVMTests
|
||||
{
|
||||
private static (SettingsVM vm, FakeKeyboardSource kb, InputDispatcher dispatcher, KeyBindings persisted, System.Collections.Generic.List<KeyBindings> savedHistory)
|
||||
Build(KeyBindings? persisted = null)
|
||||
{
|
||||
persisted ??= MakeMinimalBindings();
|
||||
var kb = new FakeKeyboardSource();
|
||||
var mouse = new FakeMouseSource();
|
||||
var dispatcher = new InputDispatcher(kb, mouse, persisted);
|
||||
var savedHistory = new System.Collections.Generic.List<KeyBindings>();
|
||||
var vm = new SettingsVM(persisted, dispatcher, b => savedHistory.Add(b));
|
||||
return (vm, kb, dispatcher, persisted, savedHistory);
|
||||
}
|
||||
|
||||
private static KeyBindings MakeMinimalBindings()
|
||||
{
|
||||
var b = new KeyBindings();
|
||||
b.Add(new Binding(new KeyChord(Key.W, ModifierMask.None), InputAction.MovementForward));
|
||||
b.Add(new Binding(new KeyChord(Key.A, ModifierMask.None), InputAction.MovementTurnLeft));
|
||||
b.Add(new Binding(new KeyChord(Key.S, ModifierMask.None), InputAction.MovementStop));
|
||||
return b;
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Constructor_clones_persisted_into_draft()
|
||||
{
|
||||
var (vm, _, _, persisted, _) = Build();
|
||||
Assert.Equal(persisted.All.Count, vm.Draft.All.Count);
|
||||
Assert.False(vm.HasUnsavedChanges);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void BeginRebind_enters_capture_mode()
|
||||
{
|
||||
var (vm, _, dispatcher, _, _) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
|
||||
Assert.True(dispatcher.IsCapturing);
|
||||
Assert.Equal(InputAction.MovementForward, vm.RebindInProgress);
|
||||
Assert.Equal(original, vm.RebindOriginal);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void BeginRebind_then_chord_with_no_conflict_applies_rebind()
|
||||
{
|
||||
var (vm, kb, _, _, _) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
// User presses Q — not bound to anything in our minimal table.
|
||||
kb.EmitKeyDown(Key.Q, ModifierMask.None);
|
||||
|
||||
Assert.Null(vm.RebindInProgress);
|
||||
Assert.Null(vm.PendingConflict);
|
||||
var binds = vm.Draft.ForAction(InputAction.MovementForward).ToList();
|
||||
Assert.Single(binds);
|
||||
Assert.Equal(new KeyChord(Key.Q, ModifierMask.None), binds[0].Chord);
|
||||
Assert.True(vm.HasUnsavedChanges);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void BeginRebind_then_Escape_cancels_with_no_change()
|
||||
{
|
||||
var (vm, kb, _, _, _) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
kb.EmitKeyDown(Key.Escape, ModifierMask.None);
|
||||
|
||||
Assert.Null(vm.RebindInProgress);
|
||||
Assert.Null(vm.PendingConflict);
|
||||
var binds = vm.Draft.ForAction(InputAction.MovementForward).ToList();
|
||||
Assert.Single(binds);
|
||||
Assert.Equal(new KeyChord(Key.W, ModifierMask.None), binds[0].Chord);
|
||||
Assert.False(vm.HasUnsavedChanges);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void BeginRebind_with_conflict_surfaces_PendingConflict()
|
||||
{
|
||||
var (vm, kb, _, _, _) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
|
||||
// Bind chord that conflicts with MovementTurnLeft (which has Key.A).
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
kb.EmitKeyDown(Key.A, ModifierMask.None);
|
||||
|
||||
Assert.NotNull(vm.PendingConflict);
|
||||
var c = vm.PendingConflict!.Value;
|
||||
Assert.Equal(InputAction.MovementForward, c.NewAction);
|
||||
Assert.Equal(new KeyChord(Key.A, ModifierMask.None), c.NewChord);
|
||||
Assert.Equal(InputAction.MovementTurnLeft, c.ConflictingAction);
|
||||
// Rebind has NOT been applied yet — still on W.
|
||||
var binds = vm.Draft.ForAction(InputAction.MovementForward).ToList();
|
||||
Assert.Equal(new KeyChord(Key.W, ModifierMask.None), binds[0].Chord);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ResolveConflict_replace_true_removes_conflict_and_applies_rebind()
|
||||
{
|
||||
var (vm, kb, _, _, _) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
kb.EmitKeyDown(Key.A, ModifierMask.None);
|
||||
vm.ResolveConflict(replace: true);
|
||||
|
||||
Assert.Null(vm.PendingConflict);
|
||||
Assert.Null(vm.RebindInProgress);
|
||||
// MovementForward now bound to A.
|
||||
var fwd = vm.Draft.ForAction(InputAction.MovementForward).ToList();
|
||||
Assert.Single(fwd);
|
||||
Assert.Equal(new KeyChord(Key.A, ModifierMask.None), fwd[0].Chord);
|
||||
// MovementTurnLeft no longer bound to A (conflict removed).
|
||||
var left = vm.Draft.ForAction(InputAction.MovementTurnLeft).ToList();
|
||||
Assert.Empty(left);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ResolveConflict_replace_false_cancels_rebind()
|
||||
{
|
||||
var (vm, kb, _, _, _) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
kb.EmitKeyDown(Key.A, ModifierMask.None);
|
||||
vm.ResolveConflict(replace: false);
|
||||
|
||||
Assert.Null(vm.PendingConflict);
|
||||
Assert.Null(vm.RebindInProgress);
|
||||
// MovementForward still bound to W.
|
||||
var fwd = vm.Draft.ForAction(InputAction.MovementForward).ToList();
|
||||
Assert.Equal(new KeyChord(Key.W, ModifierMask.None), fwd[0].Chord);
|
||||
// MovementTurnLeft still bound to A.
|
||||
var left = vm.Draft.ForAction(InputAction.MovementTurnLeft).ToList();
|
||||
Assert.Equal(new KeyChord(Key.A, ModifierMask.None), left[0].Chord);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ResetActionToDefault_restores_single_action_to_RetailDefaults()
|
||||
{
|
||||
// Build a draft that's been mutated for MovementForward; ensure
|
||||
// ResetActionToDefault restores W (and Up-arrow per retail).
|
||||
var (vm, kb, _, _, _) = Build(KeyBindings.RetailDefaults());
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
// F7 is unbound in retail-default (only Ctrl+F7 is acdream debug);
|
||||
// pick it deliberately to avoid triggering a conflict prompt that
|
||||
// would block the rebind from applying.
|
||||
kb.EmitKeyDown(Key.F7, ModifierMask.None);
|
||||
|
||||
Assert.True(vm.HasUnsavedChanges);
|
||||
|
||||
vm.ResetActionToDefault(InputAction.MovementForward);
|
||||
|
||||
var fwd = vm.Draft.ForAction(InputAction.MovementForward).ToList();
|
||||
Assert.Contains(fwd, x => x.Chord == new KeyChord(Key.W, ModifierMask.None));
|
||||
Assert.Contains(fwd, x => x.Chord == new KeyChord(Key.Up, ModifierMask.None));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ResetAllToDefaults_replaces_entire_draft()
|
||||
{
|
||||
var (vm, _, _, _, _) = Build();
|
||||
vm.ResetAllToDefaults();
|
||||
|
||||
// Should now include retail-default size set (~149 bindings).
|
||||
Assert.True(vm.Draft.All.Count >= 100);
|
||||
Assert.True(vm.HasUnsavedChanges);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Save_invokes_callback_with_draft()
|
||||
{
|
||||
var (vm, kb, _, _, savedHistory) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
kb.EmitKeyDown(Key.Q, ModifierMask.None);
|
||||
|
||||
vm.Save();
|
||||
|
||||
Assert.Single(savedHistory);
|
||||
var saved = savedHistory[0];
|
||||
var fwd = saved.ForAction(InputAction.MovementForward).ToList();
|
||||
Assert.Equal(new KeyChord(Key.Q, ModifierMask.None), fwd[0].Chord);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Cancel_reverts_draft_to_persisted()
|
||||
{
|
||||
var (vm, kb, _, _, _) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
kb.EmitKeyDown(Key.Q, ModifierMask.None);
|
||||
Assert.True(vm.HasUnsavedChanges);
|
||||
|
||||
vm.Cancel();
|
||||
|
||||
Assert.False(vm.HasUnsavedChanges);
|
||||
var fwd = vm.Draft.ForAction(InputAction.MovementForward).ToList();
|
||||
Assert.Equal(new KeyChord(Key.W, ModifierMask.None), fwd[0].Chord);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Cancel_during_active_capture_clears_dispatcher_capture_state()
|
||||
{
|
||||
var (vm, _, dispatcher, _, _) = Build();
|
||||
var original = vm.Draft.ForAction(InputAction.MovementForward).First();
|
||||
vm.BeginRebind(InputAction.MovementForward, original);
|
||||
|
||||
Assert.True(dispatcher.IsCapturing);
|
||||
vm.Cancel();
|
||||
Assert.False(dispatcher.IsCapturing);
|
||||
Assert.Null(vm.RebindInProgress);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void HasUnsavedChanges_false_initially_and_after_save_sync()
|
||||
{
|
||||
var (vm, _, _, _, _) = Build();
|
||||
Assert.False(vm.HasUnsavedChanges);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue