Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to cycle slider control point types via keyboard #28509

Merged
merged 18 commits into from
Jul 4, 2024
Merged

Add ability to cycle slider control point types via keyboard #28509

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
b5f0e58
Add ability to better control slider control point type during placem…
bdach Jun 17, 2024
16ea8f6
Add ability to start a new segment during placement via `S` key
bdach Jun 17, 2024
88bdc12
Add ability to cycle through available types when selecting single co…
bdach Jun 17, 2024
1e13727
Add testing for keyboard control of path during placement
bdach Jun 17, 2024
7898100
Add testing for keyboard control of path during selection
bdach Jun 17, 2024
a631d24
Fix test failure
bdach Jun 17, 2024
683d531
Implement direct choice of slider control point path type via `Alt`-n…
bdach Jun 17, 2024
310265c
Add slider placement binding description in tooltip
bdach Jun 18, 2024
a332608
Adjust hotkeys to address feedback
bdach Jun 18, 2024
73786a6
Adjust & expand test coverage
bdach Jun 18, 2024
2421751
Fix code quality inspections
bdach Jun 18, 2024
5fe21f1
Fix test failures
bdach Jun 18, 2024
57774ae
Merge branch 'master' into slider-anchor-type-switching
peppy Jun 20, 2024
8837569
Merge branch 'master' into slider-anchor-type-switching
peppy Jul 3, 2024
42aff95
Ensure menu items update when curve type changes
peppy Jul 3, 2024
6abb728
Change menu items to be in same order as hotkeys
peppy Jul 3, 2024
f7339e3
Remove outdated(?) todo
peppy Jul 3, 2024
e151454
Add missing check for curve menu items not yet being created
peppy Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions osu.Game.Rulesets.Osu.Tests/Editor/TestScenePathControlPointVisualiser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
using osu.Game.Rulesets.Osu.Objects;
using osu.Game.Tests.Visual;
using osuTK;
using osuTK.Input;

namespace osu.Game.Rulesets.Osu.Tests.Editor
{
Expand Down Expand Up @@ -177,6 +178,79 @@ public void TestStackingUpdatesPointsPosition()
addAssertPointPositionChanged(points, i);
}

[Test]
public void TestChangingControlPointTypeViaTab()
{
createVisualiser(true);

addControlPointStep(new Vector2(200), PathType.LINEAR);
addControlPointStep(new Vector2(300));
addControlPointStep(new Vector2(500, 300));
addControlPointStep(new Vector2(700, 200));
addControlPointStep(new Vector2(500, 100));

AddStep("select first control point", () => visualiser.Pieces[0].IsSelected.Value = true);
AddStep("press tab", () => InputManager.Key(Key.Tab));
assertControlPointPathType(0, PathType.BEZIER);

AddStep("press shift-tab", () =>
{
InputManager.PressKey(Key.LShift);
InputManager.Key(Key.Tab);
InputManager.ReleaseKey(Key.LShift);
});
assertControlPointPathType(0, PathType.LINEAR);

AddStep("press shift-tab", () =>
{
InputManager.PressKey(Key.LShift);
InputManager.Key(Key.Tab);
InputManager.ReleaseKey(Key.LShift);
});
assertControlPointPathType(0, PathType.BSpline(4));

AddStep("press shift-tab", () =>
{
InputManager.PressKey(Key.LShift);
InputManager.Key(Key.Tab);
InputManager.ReleaseKey(Key.LShift);
});
assertControlPointPathType(0, PathType.PERFECT_CURVE);
assertControlPointPathType(2, PathType.BSpline(4));

AddStep("select third last control point", () =>
{
visualiser.Pieces[0].IsSelected.Value = false;
visualiser.Pieces[2].IsSelected.Value = true;
});

AddStep("press shift-tab", () =>
{
InputManager.PressKey(Key.LShift);
InputManager.Key(Key.Tab);
InputManager.ReleaseKey(Key.LShift);
});
assertControlPointPathType(2, PathType.PERFECT_CURVE);

AddRepeatStep("press tab", () => InputManager.Key(Key.Tab), 2);
assertControlPointPathType(0, PathType.BEZIER);
assertControlPointPathType(2, null);

AddStep("select first and third control points", () =>
{
visualiser.Pieces[0].IsSelected.Value = true;
visualiser.Pieces[2].IsSelected.Value = true;
});
AddStep("press alt-1", () =>
{
InputManager.PressKey(Key.AltLeft);
InputManager.Key(Key.Number1);
InputManager.ReleaseKey(Key.AltLeft);
});
assertControlPointPathType(0, PathType.LINEAR);
assertControlPointPathType(2, PathType.LINEAR);
}

private void addAssertPointPositionChanged(Vector2[] points, int index)
{
AddAssert($"Point at {points.ElementAt(index)} changed",
Expand Down
106 changes: 75 additions & 31 deletions osu.Game.Rulesets.Osu.Tests/Editor/TestSceneSliderPlacementBlueprint.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@
// See the LICENCE file in the repository root for full licence text.

using System;
using System.Linq;
using NUnit.Framework;
using osu.Framework.Testing;
using osu.Framework.Utils;
using osu.Game.Rulesets.Edit;
using osu.Game.Rulesets.Objects;
using osu.Game.Rulesets.Objects.Drawables;
using osu.Game.Rulesets.Objects.Types;
using osu.Game.Rulesets.Osu.Edit.Blueprints.Sliders;
using osu.Game.Rulesets.Osu.Edit.Blueprints.Sliders.Components;
using osu.Game.Rulesets.Osu.Objects;
using osu.Game.Rulesets.Osu.Objects.Drawables;
using osu.Game.Tests.Visual;
Expand Down Expand Up @@ -57,7 +60,7 @@ public void TestPlaceWithMouseMovement()
assertPlaced(true);
assertLength(200);
assertControlPointCount(2);
assertControlPointType(0, PathType.LINEAR);
assertFinalControlPointType(0, PathType.LINEAR);
}

[Test]
Expand All @@ -71,7 +74,7 @@ public void TestPlaceWithMouseMovementOutsidePlayfield()

assertPlaced(true);
assertControlPointCount(2);
assertControlPointType(0, PathType.LINEAR);
assertFinalControlPointType(0, PathType.LINEAR);
}

[Test]
Expand All @@ -89,7 +92,7 @@ public void TestPlaceNormalControlPoint()
assertPlaced(true);
assertControlPointCount(3);
assertControlPointPosition(1, new Vector2(100, 0));
assertControlPointType(0, PathType.PERFECT_CURVE);
assertFinalControlPointType(0, PathType.PERFECT_CURVE);
}

[Test]
Expand All @@ -111,7 +114,7 @@ public void TestPlaceTwoNormalControlPoints()
assertControlPointCount(4);
assertControlPointPosition(1, new Vector2(100, 0));
assertControlPointPosition(2, new Vector2(100, 100));
assertControlPointType(0, PathType.BEZIER);
assertFinalControlPointType(0, PathType.BEZIER);
}

[Test]
Expand All @@ -130,8 +133,8 @@ public void TestPlaceSegmentControlPoint()
assertPlaced(true);
assertControlPointCount(3);
assertControlPointPosition(1, new Vector2(100, 0));
assertControlPointType(0, PathType.LINEAR);
assertControlPointType(1, PathType.LINEAR);
assertFinalControlPointType(0, PathType.LINEAR);
assertFinalControlPointType(1, PathType.LINEAR);
}

[Test]
Expand All @@ -149,7 +152,7 @@ public void TestMoveToPerfectCurveThenPlaceLinear()

assertPlaced(true);
assertControlPointCount(2);
assertControlPointType(0, PathType.LINEAR);
assertFinalControlPointType(0, PathType.LINEAR);
assertLength(100);
}

Expand All @@ -171,7 +174,7 @@ public void TestMoveToBezierThenPlacePerfectCurve()

assertPlaced(true);
assertControlPointCount(3);
assertControlPointType(0, PathType.PERFECT_CURVE);
assertFinalControlPointType(0, PathType.PERFECT_CURVE);
}

[Test]
Expand All @@ -195,7 +198,7 @@ public void TestMoveToFourthOrderBezierThenPlaceThirdOrderBezier()

assertPlaced(true);
assertControlPointCount(4);
assertControlPointType(0, PathType.BEZIER);
assertFinalControlPointType(0, PathType.BEZIER);
}

[Test]
Expand All @@ -215,8 +218,8 @@ public void TestPlaceLinearSegmentThenPlaceLinearSegment()
assertControlPointCount(3);
assertControlPointPosition(1, new Vector2(100, 0));
assertControlPointPosition(2, new Vector2(100));
assertControlPointType(0, PathType.LINEAR);
assertControlPointType(1, PathType.LINEAR);
assertFinalControlPointType(0, PathType.LINEAR);
assertFinalControlPointType(1, PathType.LINEAR);
}

[Test]
Expand All @@ -239,8 +242,8 @@ public void TestPlaceLinearSegmentThenPlacePerfectCurveSegment()
assertControlPointCount(4);
assertControlPointPosition(1, new Vector2(100, 0));
assertControlPointPosition(2, new Vector2(100));
assertControlPointType(0, PathType.LINEAR);
assertControlPointType(1, PathType.PERFECT_CURVE);
assertFinalControlPointType(0, PathType.LINEAR);
assertFinalControlPointType(1, PathType.PERFECT_CURVE);
}

[Test]
Expand Down Expand Up @@ -268,8 +271,46 @@ public void TestPlacePerfectCurveSegmentThenPlacePerfectCurveSegment()
assertControlPointPosition(2, new Vector2(100));
assertControlPointPosition(3, new Vector2(200, 100));
assertControlPointPosition(4, new Vector2(200));
assertControlPointType(0, PathType.PERFECT_CURVE);
assertControlPointType(2, PathType.PERFECT_CURVE);
assertFinalControlPointType(0, PathType.PERFECT_CURVE);
assertFinalControlPointType(2, PathType.PERFECT_CURVE);
}

[Test]
public void TestManualPathTypeControlViaKeyboard()
{
addMovementStep(new Vector2(200));
addClickStep(MouseButton.Left);

addMovementStep(new Vector2(300, 200));
addClickStep(MouseButton.Left);

addMovementStep(new Vector2(300));

assertControlPointTypeDuringPlacement(0, PathType.PERFECT_CURVE);

AddRepeatStep("press tab", () => InputManager.Key(Key.Tab), 2);
assertControlPointTypeDuringPlacement(0, PathType.LINEAR);

AddStep("press shift-tab", () =>
{
InputManager.PressKey(Key.ShiftLeft);
InputManager.Key(Key.Tab);
InputManager.ReleaseKey(Key.ShiftLeft);
});
assertControlPointTypeDuringPlacement(0, PathType.BSpline(4));

AddStep("start new segment via S", () => InputManager.Key(Key.S));
assertControlPointTypeDuringPlacement(2, PathType.LINEAR);

addMovementStep(new Vector2(400, 300));
addClickStep(MouseButton.Left);

addMovementStep(new Vector2(400));
addClickStep(MouseButton.Right);

assertPlaced(true);
assertFinalControlPointType(0, PathType.BSpline(4));
assertFinalControlPointType(2, PathType.PERFECT_CURVE);
}

[Test]
Expand All @@ -293,7 +334,7 @@ public void TestSliderDrawingDoesntActivateAfterNormalPlacement()
addClickStep(MouseButton.Right);
assertPlaced(true);

assertControlPointType(0, PathType.BEZIER);
assertFinalControlPointType(0, PathType.BEZIER);
}

[Test]
Expand All @@ -312,11 +353,11 @@ public void TestSliderDrawingCurve()
assertPlaced(true);
assertLength(808, tolerance: 10);
assertControlPointCount(5);
assertControlPointType(0, PathType.BSpline(4));
assertControlPointType(1, null);
assertControlPointType(2, null);
assertControlPointType(3, null);
assertControlPointType(4, null);
assertFinalControlPointType(0, PathType.BSpline(4));
assertFinalControlPointType(1, null);
assertFinalControlPointType(2, null);
assertFinalControlPointType(3, null);
assertFinalControlPointType(4, null);
}

[Test]
Expand All @@ -337,10 +378,10 @@ public void TestSliderDrawingLinear()
assertPlaced(true);
assertLength(600, tolerance: 10);
assertControlPointCount(4);
assertControlPointType(0, PathType.BSpline(4));
assertControlPointType(1, PathType.BSpline(4));
assertControlPointType(2, PathType.BSpline(4));
assertControlPointType(3, null);
assertFinalControlPointType(0, PathType.BSpline(4));
assertFinalControlPointType(1, PathType.BSpline(4));
assertFinalControlPointType(2, PathType.BSpline(4));
assertFinalControlPointType(3, null);
}

[Test]
Expand All @@ -359,7 +400,7 @@ public void TestPlacePerfectCurveSegmentAlmostLinearlyExterior()

assertPlaced(true);
assertControlPointCount(3);
assertControlPointType(0, PathType.BEZIER);
assertFinalControlPointType(0, PathType.BEZIER);
}

[Test]
Expand All @@ -379,7 +420,7 @@ public void TestPlacePerfectCurveSegmentRecovery()

assertPlaced(true);
assertControlPointCount(3);
assertControlPointType(0, PathType.PERFECT_CURVE);
assertFinalControlPointType(0, PathType.PERFECT_CURVE);
}

[Test]
Expand All @@ -400,7 +441,7 @@ public void TestPlacePerfectCurveSegmentLarge()

assertPlaced(true);
assertControlPointCount(3);
assertControlPointType(0, PathType.PERFECT_CURVE);
assertFinalControlPointType(0, PathType.PERFECT_CURVE);
}

[Test]
Expand All @@ -421,7 +462,7 @@ public void TestPlacePerfectCurveSegmentTooLarge()

assertPlaced(true);
assertControlPointCount(3);
assertControlPointType(0, PathType.BEZIER);
assertFinalControlPointType(0, PathType.BEZIER);
}

[Test]
Expand All @@ -438,7 +479,7 @@ public void TestPlacePerfectCurveSegmentCompleteArc()

assertPlaced(true);
assertControlPointCount(3);
assertControlPointType(0, PathType.PERFECT_CURVE);
assertFinalControlPointType(0, PathType.PERFECT_CURVE);
}

private void addMovementStep(Vector2 position) => AddStep($"move mouse to {position}", () => InputManager.MoveMouseTo(InputManager.ToScreenSpace(position)));
Expand All @@ -454,7 +495,10 @@ private void addClickStep(MouseButton button)

private void assertControlPointCount(int expected) => AddAssert($"has {expected} control points", () => getSlider()!.Path.ControlPoints.Count, () => Is.EqualTo(expected));

private void assertControlPointType(int index, PathType? type) => AddAssert($"control point {index} is {type?.ToString() ?? "inherit"}", () => getSlider()!.Path.ControlPoints[index].Type, () => Is.EqualTo(type));
private void assertControlPointTypeDuringPlacement(int index, PathType? type) => AddAssert($"control point {index} is {type?.ToString() ?? "inherit"}",
() => this.ChildrenOfType<PathControlPointPiece<Slider>>().ElementAt(index).ControlPoint.Type, () => Is.EqualTo(type));

private void assertFinalControlPointType(int index, PathType? type) => AddAssert($"control point {index} is {type?.ToString() ?? "inherit"}", () => getSlider()!.Path.ControlPoints[index].Type, () => Is.EqualTo(type));

private void assertControlPointPosition(int index, Vector2 position) =>
AddAssert($"control point {index} at {position}", () => Precision.AlmostEquals(position, getSlider()!.Path.ControlPoints[index].Position, 1));
Expand Down
Loading
Loading