Implement base class for beat snapping grids

osu.Game.Tests/Visual/Editor/TestSceneBeatSnapGrid.cs

@@ -0,0 +1,210 @@
+// 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.
+
+using System;
+using NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.MathUtils;
+using osu.Game.Beatmaps;
+using osu.Game.Beatmaps.ControlPoints;
+using osu.Game.Rulesets.Objects;
+using osu.Game.Rulesets.Osu.Beatmaps;
+using osu.Game.Rulesets.Osu.Objects;
+using osu.Game.Screens.Edit;
+using osu.Game.Screens.Edit.Compose.Components;
+using osuTK;
+using osuTK.Graphics;
+
+namespace osu.Game.Tests.Visual.Editor
+{
+    public class TestSceneBeatSnapGrid : EditorClockTestScene
+    {
+        private const double beat_length = 100;
+        private static readonly Vector2 grid_position = new Vector2(512, 384);
+
+        [Cached(typeof(IEditorBeatmap))]
+        private readonly EditorBeatmap<OsuHitObject> editorBeatmap;
+
+        private TestBeatSnapGrid grid;
+
+        public TestSceneBeatSnapGrid()
+        {
+            editorBeatmap = new EditorBeatmap<OsuHitObject>(new OsuBeatmap());
+        }
+
+        [SetUp]
+        public void Setup() => Schedule(() =>
+        {
+            Clear();
+
+            editorBeatmap.ControlPointInfo.TimingPoints.Clear();
+            editorBeatmap.ControlPointInfo.TimingPoints.Add(new TimingControlPoint { BeatLength = beat_length });
+
+            BeatDivisor.Value = 1;
+        });
+
+        [TestCase(1)]
+        [TestCase(2)]
+        [TestCase(3)]
+        [TestCase(4)]
+        [TestCase(6)]
+        [TestCase(8)]
+        [TestCase(12)]
+        [TestCase(16)]
+        public void TestInitialBeatDivisor(int divisor)
+        {
+            AddStep($"set beat divisor = {divisor}", () => BeatDivisor.Value = divisor);
+            createGrid();
+
+            float expectedDistance = (float)beat_length / divisor;
+            AddAssert($"spacing is {expectedDistance}", () => Precision.AlmostEquals(grid.DistanceSpacing, expectedDistance));
+        }
+
+        [Test]
+        public void TestChangeBeatDivisor()
+        {
+            createGrid();
+            AddStep("set beat divisor = 2", () => BeatDivisor.Value = 2);
+
+            const float expected_distance = (float)beat_length / 2;
+            AddAssert($"spacing is {expected_distance}", () => Precision.AlmostEquals(grid.DistanceSpacing, expected_distance));
+        }
+
+        [TestCase(100)]
+        [TestCase(200)]
+        public void TestBeatLength(double beatLength)
+        {
+            AddStep($"set beat length = {beatLength}", () =>
+            {
+                editorBeatmap.ControlPointInfo.TimingPoints.Clear();
+                editorBeatmap.ControlPointInfo.TimingPoints.Add(new TimingControlPoint { BeatLength = beatLength });
+            });
+
+            createGrid();
+            AddAssert($"spacing is {beatLength}", () => Precision.AlmostEquals(grid.DistanceSpacing, beatLength));
+        }
+
+        [TestCase(1)]
+        [TestCase(2)]
+        public void TestGridVelocity(float velocity)
+        {
+            createGrid(g => g.Velocity = velocity);
+
+            float expectedDistance = (float)beat_length * velocity;
+            AddAssert($"spacing is {expectedDistance}", () => Precision.AlmostEquals(grid.DistanceSpacing, expectedDistance));
+        }
+
+        [Test]
+        public void TestGetSnappedTime()
+        {
+            createGrid();
+
+            Vector2 screenSpacePosition = Vector2.Zero;
+            AddStep("get first tick position", () => screenSpacePosition = grid.ToScreenSpace(grid_position + new Vector2((float)beat_length, 0)));
+            AddAssert("snap time is 1 beat away", () => Precision.AlmostEquals(beat_length, grid.GetSnapTime(screenSpacePosition), 0.01));
+
+            createGrid(g => g.Velocity = 2, " with velocity = 2");
+            AddAssert("snap time is now 0.5 beats away", () => Precision.AlmostEquals(beat_length / 2, grid.GetSnapTime(screenSpacePosition), 0.01));
+        }
+
+        private void createGrid(Action<TestBeatSnapGrid> func = null, string description = null)
+        {
+            AddStep($"create grid {description ?? string.Empty}", () =>
+            {
+                Children = new Drawable[]
+                {
+                    new Box
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = Color4.SlateGray
+                    },
+                    grid = new TestBeatSnapGrid(new HitObject(), grid_position)
+                };
+
+                func?.Invoke(grid);
+            });
+        }
+
+        private class TestBeatSnapGrid : BeatSnapGrid
+        {
+            public new float Velocity = 1;
+
+            public new float DistanceSpacing => base.DistanceSpacing;
+
+            public TestBeatSnapGrid(HitObject hitObject, Vector2 startPosition)
+                : base(hitObject, startPosition)
+            {
+            }
+
+            protected override void CreateGrid(Vector2 startPosition)
+            {
+                AddInternal(new Circle
+                {
+                    Origin = Anchor.Centre,
+                    Size = new Vector2(5),
+                    Position = startPosition
+                });
+
+                int beatIndex = 0;
+
+                for (float s = startPosition.X + DistanceSpacing; s <= DrawWidth; s += DistanceSpacing, beatIndex++)
+                {
+                    AddInternal(new Circle
+                    {
+                        Origin = Anchor.Centre,
+                        Size = new Vector2(5, 10),
+                        Position = new Vector2(s, startPosition.Y),
+                        Colour = GetColourForBeatIndex(beatIndex)
+                    });
+                }
+
+                beatIndex = 0;
+
+                for (float s = startPosition.X - DistanceSpacing; s >= 0; s -= DistanceSpacing, beatIndex++)
+                {
+                    AddInternal(new Circle
+                    {
+                        Origin = Anchor.Centre,
+                        Size = new Vector2(5, 10),
+                        Position = new Vector2(s, startPosition.Y),
+                        Colour = GetColourForBeatIndex(beatIndex)
+                    });
+                }
+
+                beatIndex = 0;
+
+                for (float s = startPosition.Y + DistanceSpacing; s <= DrawHeight; s += DistanceSpacing, beatIndex++)
+                {
+                    AddInternal(new Circle
+                    {
+                        Origin = Anchor.Centre,
+                        Size = new Vector2(10, 5),
+                        Position = new Vector2(startPosition.X, s),
+                        Colour = GetColourForBeatIndex(beatIndex)
+                    });
+                }
+
+                beatIndex = 0;
+
+                for (float s = startPosition.Y - DistanceSpacing; s >= 0; s -= DistanceSpacing, beatIndex++)
+                {
+                    AddInternal(new Circle
+                    {
+                        Origin = Anchor.Centre,
+                        Size = new Vector2(10, 5),
+                        Position = new Vector2(startPosition.X, s),
+                        Colour = GetColourForBeatIndex(beatIndex)
+                    });
+                }
+            }
+
+            protected override float GetVelocity(double time, ControlPointInfo controlPointInfo, BeatmapDifficulty difficulty)
+                => Velocity;
+
+            public override Vector2 GetSnapPosition(Vector2 screenSpacePosition)
+                => Vector2.Zero;
+        }
+    }
+}

osu.Game/Screens/Edit/Compose/Components/BeatSnapGrid.cs

@@ -0,0 +1,149 @@
+// 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.
+
+using osu.Framework.Allocation;
+using osu.Framework.Caching;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Colour;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Timing;
+using osu.Game.Beatmaps;
+using osu.Game.Beatmaps.ControlPoints;
+using osu.Game.Graphics;
+using osu.Game.Rulesets.Objects;
+using osu.Game.Rulesets.Objects.Types;
+using osuTK;
+
+namespace osu.Game.Screens.Edit.Compose.Components
+{
+    public abstract class BeatSnapGrid : CompositeDrawable
+    {
+        protected double Velocity { get; private set; }
+
+        protected float DistanceSpacing { get; private set; }
+
+        [Resolved]
+        private IFrameBasedClock framedClock { get; set; }
+
+        [Resolved]
+        private IEditorBeatmap beatmap { get; set; }
+
+        [Resolved]
+        private BindableBeatDivisor beatDivisor { get; set; }
+
+        [Resolved]
+        private OsuColour colours { get; set; }
+
+        private readonly Cached gridCache = new Cached();
+        private readonly HitObject hitObject;
+        private readonly Vector2 startPosition;
+
+        private double startTime;
+        private double beatLength;
+
+        protected BeatSnapGrid(HitObject hitObject, Vector2 startPosition)
+        {
+            this.hitObject = hitObject;
+            this.startPosition = startPosition;
+
+            RelativeSizeAxes = Axes.Both;
+        }
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            startTime = (hitObject as IHasEndTime)?.EndTime ?? hitObject.StartTime;
+            beatLength = beatmap.ControlPointInfo.TimingPointAt(startTime).BeatLength;
+        }
+
+        protected override void LoadComplete()
+        {
+            base.LoadComplete();
+
+            beatDivisor.BindValueChanged(_ => updateSpacing(), true);
+        }
+
+        private void updateSpacing()
+        {
+            Velocity = GetVelocity(startTime, beatmap.ControlPointInfo, beatmap.BeatmapInfo.BaseDifficulty);
+            DistanceSpacing = (float)(beatLength / beatDivisor.Value * Velocity);
+            gridCache.Invalidate();
+        }
+
+        public override bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null, bool shallPropagate = true)
+        {
+            if ((invalidation & Invalidation.RequiredParentSizeToFit) > 0)
+                gridCache.Invalidate();
+
+            return base.Invalidate(invalidation, source, shallPropagate);
+        }
+
+        protected override void Update()
+        {
+            base.Update();
+
+            if (!gridCache.IsValid)
+            {
+                ClearInternal();
+                CreateGrid(startPosition);
+                gridCache.Validate();
+            }
+        }
+
+        /// <summary>
+        /// Draws the grid.
+        /// </summary>
+        protected abstract void CreateGrid(Vector2 startPosition);
+
+        /// <summary>
+        /// Retrieves the velocity of gameplay at a time.
+        /// </summary>
+        /// <param name="time">The time to retrieve the velocity at.</param>
+        /// <param name="controlPointInfo">The beatmap's <see cref="ControlPointInfo"/> at the requested time.</param>
+        /// <param name="difficulty">The beatmap's <see cref="BeatmapDifficulty"/> at the requested time.</param>
+        /// <returns>The velocity in pixels per millisecond.</returns>
+        protected abstract float GetVelocity(double time, ControlPointInfo controlPointInfo, BeatmapDifficulty difficulty);
+
+        /// <summary>
+        /// Snaps a position to this grid.
+        /// </summary>
+        /// <param name="screenSpacePosition">The original screen-space position.</param>
+        /// <returns>The snapped position.</returns>
+        public abstract Vector2 GetSnapPosition(Vector2 screenSpacePosition);
+
+        /// <summary>
+        /// Retrieves the time at a snapped position.
+        /// </summary>
+        /// <param name="snappedPosition">The snapped position.</param>
+        /// <returns>The time at the snapped position.</returns>
+        public double GetSnapTime(Vector2 snappedPosition) => startTime + (ToLocalSpace(snappedPosition) - startPosition).Length / Velocity;
+
+        /// <summary>
+        /// Retrieves the applicable colour for a beat index.
+        /// </summary>
+        /// <param name="index">The 0-based beat index.</param>
+        /// <returns>The applicable colour.</returns>
+        protected ColourInfo GetColourForBeatIndex(int index)
+        {
+            int divIndex = beatDivisor.Value - (index % beatDivisor.Value) - 1;
+
+            ColourInfo colour = colours.Gray5;
+
+            {
+                for (int i = 0; i < BindableBeatDivisor.VALID_DIVISORS.Length; i++)
+                {
+                    int divisor = BindableBeatDivisor.VALID_DIVISORS[i];
+
+                    if ((divIndex * divisor) % beatDivisor.Value == 0)
+                    {
+                        colour = BindableBeatDivisor.GetColourFor(divisor, colours);
+                        break;
+                    }
+                }
+            }
+
+            int repeatIndex = index / beatDivisor.Value;
+            return colour.MultiplyAlpha(0.5f / (repeatIndex + 1));
+        }
+    }
+}