Merge pull request #9083 from peppy/editor-clock-cache

Cache EditorClock as its own type

osu.Game.Tests/Visual/Editing/TestScenePlaybackControl.cs

@@ -4,8 +4,8 @@
 using NUnit.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
-using osu.Framework.Timing;
 using osu.Game.Beatmaps;
+using osu.Game.Screens.Edit;
 using osu.Game.Screens.Edit.Components;
 using osuTK;
 
@@ -17,9 +17,8 @@ namespace osu.Game.Tests.Visual.Editing
         [BackgroundDependencyLoader]
         private void load()
         {
-            var clock = new DecoupleableInterpolatingFramedClock { IsCoupled = false };
+            var clock = new EditorClock { IsCoupled = false };
-            Dependencies.CacheAs<IAdjustableClock>(clock);
+            Dependencies.CacheAs(clock);
-            Dependencies.CacheAs<IFrameBasedClock>(clock);
 
             var playback = new PlaybackControl
             {

osu.Game.Tests/Visual/Editing/TimelineTestScene.cs

@@ -7,7 +7,6 @@ using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
-using osu.Framework.Timing;
 using osu.Game.Beatmaps;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Rulesets.Edit;
@@ -69,7 +68,7 @@ namespace osu.Game.Tests.Visual.Editing
             private IBindable<WorkingBeatmap> beatmap { get; set; }
 
             [Resolved]
-            private IAdjustableClock adjustableClock { get; set; }
+            private EditorClock editorClock { get; set; }
 
             public AudioVisualiser()
             {
@@ -96,13 +95,15 @@ namespace osu.Game.Tests.Visual.Editing
                 base.Update();
 
                 if (beatmap.Value.Track.IsLoaded)
-                    marker.X = (float)(adjustableClock.CurrentTime / beatmap.Value.Track.Length);
+                    marker.X = (float)(editorClock.CurrentTime / beatmap.Value.Track.Length);
             }
         }
 
         private class StartStopButton : OsuButton
         {
-            private IAdjustableClock adjustableClock;
+            [Resolved]
+            private EditorClock editorClock { get; set; }
+
             private bool started;
 
             public StartStopButton()
@@ -114,22 +115,16 @@ namespace osu.Game.Tests.Visual.Editing
                 Action = onClick;
             }
 
-            [BackgroundDependencyLoader]
-            private void load(IAdjustableClock adjustableClock)
-            {
-                this.adjustableClock = adjustableClock;
-            }
-
             private void onClick()
             {
                 if (started)
                 {
-                    adjustableClock.Stop();
+                    editorClock.Stop();
                     Text = "Start";
                 }
                 else
                 {
-                    adjustableClock.Start();
+                    editorClock.Start();
                     Text = "Stop";
                 }
 

osu.Game/Rulesets/Edit/HitObjectComposer.cs

@@ -11,7 +11,6 @@ using osu.Framework.Graphics.Containers;
 using osu.Framework.Input;
 using osu.Framework.Input.Events;
 using osu.Framework.Logging;
-using osu.Framework.Timing;
 using osu.Game.Beatmaps;
 using osu.Game.Beatmaps.ControlPoints;
 using osu.Game.Rulesets.Configuration;
@@ -38,14 +37,11 @@ namespace osu.Game.Rulesets.Edit
         protected readonly Ruleset Ruleset;
 
         [Resolved]
-        protected IFrameBasedClock EditorClock { get; private set; }
+        protected EditorClock EditorClock { get; private set; }
 
         [Resolved]
         protected EditorBeatmap EditorBeatmap { get; private set; }
 
-        [Resolved]
-        private IAdjustableClock adjustableClock { get; set; }
-
         [Resolved]
         protected IBeatSnapProvider BeatSnapProvider { get; private set; }
 
@@ -68,7 +64,7 @@ namespace osu.Game.Rulesets.Edit
         }
 
         [BackgroundDependencyLoader]
-        private void load(IFrameBasedClock framedClock)
+        private void load()
         {
             Config = Dependencies.Get<RulesetConfigCache>().GetConfigFor(Ruleset);
 
@@ -76,7 +72,7 @@ namespace osu.Game.Rulesets.Edit
             {
                 drawableRulesetWrapper = new DrawableEditRulesetWrapper<TObject>(CreateDrawableRuleset(Ruleset, EditorBeatmap.PlayableBeatmap))
                 {
-                    Clock = framedClock,
+                    Clock = EditorClock,
                     ProcessCustomClock = false
                 };
             }
@@ -221,8 +217,8 @@ namespace osu.Game.Rulesets.Edit
             {
                 EditorBeatmap.Add(hitObject);
 
-                if (adjustableClock.CurrentTime < hitObject.StartTime)
+                if (EditorClock.CurrentTime < hitObject.StartTime)
-                    adjustableClock.Seek(hitObject.StartTime);
+                    EditorClock.Seek(hitObject.StartTime);
             }
         }
 

osu.Game/Rulesets/Edit/PlacementBlueprint.cs

@@ -6,10 +6,10 @@ using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Input.Events;
-using osu.Framework.Timing;
 using osu.Game.Beatmaps;
 using osu.Game.Beatmaps.ControlPoints;
 using osu.Game.Rulesets.Objects;
+using osu.Game.Screens.Edit;
 using osu.Game.Screens.Edit.Compose;
 using osuTK;
 
@@ -30,7 +30,8 @@ namespace osu.Game.Rulesets.Edit
         /// </summary>
         protected readonly HitObject HitObject;
 
-        protected IClock EditorClock { get; private set; }
+        [Resolved(canBeNull: true)]
+        protected EditorClock EditorClock { get; private set; }
 
         private readonly IBindable<WorkingBeatmap> beatmap = new Bindable<WorkingBeatmap>();
 
@@ -51,12 +52,10 @@ namespace osu.Game.Rulesets.Edit
         }
 
         [BackgroundDependencyLoader]
-        private void load(IBindable<WorkingBeatmap> beatmap, IAdjustableClock clock)
+        private void load(IBindable<WorkingBeatmap> beatmap)
         {
             this.beatmap.BindTo(beatmap);
 
-            EditorClock = clock;
-
             startTimeBindable = HitObject.StartTimeBindable.GetBoundCopy();
             startTimeBindable.BindValueChanged(_ => ApplyDefaultsToHitObject(), true);
         }
@@ -84,9 +83,6 @@ namespace osu.Game.Rulesets.Edit
             PlacementActive = false;
         }
 
-        [Resolved(canBeNull: true)]
-        private IFrameBasedClock editorClock { get; set; }
-
         /// <summary>
         /// Updates the position of this <see cref="PlacementBlueprint"/> to a new screen-space position.
         /// </summary>
@@ -94,7 +90,7 @@ namespace osu.Game.Rulesets.Edit
         public virtual void UpdatePosition(SnapResult snapResult)
         {
             if (!PlacementActive)
-                HitObject.StartTime = snapResult.Time ?? editorClock?.CurrentTime ?? Time.Current;
+                HitObject.StartTime = snapResult.Time ?? EditorClock?.CurrentTime ?? Time.Current;
         }
 
         /// <summary>

osu.Game/Screens/Edit/Components/PlaybackControl.cs

@@ -13,7 +13,6 @@ using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Sprites;
 using osu.Framework.Graphics.UserInterface;
 using osu.Framework.Input.Events;
-using osu.Framework.Timing;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Sprites;
 using osu.Game.Graphics.UserInterface;
@@ -26,7 +25,7 @@ namespace osu.Game.Screens.Edit.Components
         private IconButton playButton;
 
         [Resolved]
-        private IAdjustableClock adjustableClock { get; set; }
+        private EditorClock editorClock { get; set; }
 
         private readonly BindableNumber<double> tempo = new BindableDouble(1);
 
@@ -87,17 +86,17 @@ namespace osu.Game.Screens.Edit.Components
 
         private void togglePause()
         {
-            if (adjustableClock.IsRunning)
+            if (editorClock.IsRunning)
-                adjustableClock.Stop();
+                editorClock.Stop();
             else
-                adjustableClock.Start();
+                editorClock.Start();
         }
 
         protected override void Update()
         {
             base.Update();
 
-            playButton.Icon = adjustableClock.IsRunning ? FontAwesome.Regular.PauseCircle : FontAwesome.Regular.PlayCircle;
+            playButton.Icon = editorClock.IsRunning ? FontAwesome.Regular.PauseCircle : FontAwesome.Regular.PlayCircle;
         }
 
         private class PlaybackTabControl : OsuTabControl<double>

osu.Game/Screens/Edit/Components/TimeInfoContainer.cs

@@ -5,7 +5,6 @@ using osu.Framework.Graphics;
 using osu.Game.Graphics.Sprites;
 using System;
 using osu.Framework.Allocation;
-using osu.Framework.Timing;
 using osu.Game.Graphics;
 
 namespace osu.Game.Screens.Edit.Components
@@ -15,7 +14,7 @@ namespace osu.Game.Screens.Edit.Components
         private readonly OsuSpriteText trackTimer;
 
         [Resolved]
-        private IAdjustableClock adjustableClock { get; set; }
+        private EditorClock editorClock { get; set; }
 
         public TimeInfoContainer()
         {
@@ -35,7 +34,7 @@ namespace osu.Game.Screens.Edit.Components
         {
             base.Update();
 
-            trackTimer.Text = TimeSpan.FromMilliseconds(adjustableClock.CurrentTime).ToString(@"mm\:ss\:fff");
+            trackTimer.Text = TimeSpan.FromMilliseconds(editorClock.CurrentTime).ToString(@"mm\:ss\:fff");
         }
     }
 }

osu.Game/Screens/Edit/Components/Timelines/Summary/Parts/MarkerPart.cs

@@ -9,7 +9,6 @@ using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.Input.Events;
 using osu.Framework.Threading;
-using osu.Framework.Timing;
 using osu.Game.Beatmaps;
 using osu.Game.Graphics;
 
@@ -20,14 +19,14 @@ namespace osu.Game.Screens.Edit.Components.Timelines.Summary.Parts
     /// </summary>
     public class MarkerPart : TimelinePart
     {
-        private readonly Drawable marker;
+        private Drawable marker;
 
-        private readonly IAdjustableClock adjustableClock;
+        [Resolved]
+        private EditorClock editorClock { get; set; }
 
-        public MarkerPart(IAdjustableClock adjustableClock)
+        [BackgroundDependencyLoader]
+        private void load()
         {
-            this.adjustableClock = adjustableClock;
-
             Add(marker = new MarkerVisualisation());
         }
 
@@ -59,14 +58,14 @@ namespace osu.Game.Screens.Edit.Components.Timelines.Summary.Parts
                     return;
 
                 float markerPos = Math.Clamp(ToLocalSpace(screenPosition).X, 0, DrawWidth);
-                adjustableClock.Seek(markerPos / DrawWidth * Beatmap.Value.Track.Length);
+                editorClock.Seek(markerPos / DrawWidth * editorClock.TrackLength);
             });
         }
 
         protected override void Update()
         {
             base.Update();
-            marker.X = (float)adjustableClock.CurrentTime;
+            marker.X = (float)editorClock.CurrentTime;
         }
 
         protected override void LoadBeatmap(WorkingBeatmap beatmap)

osu.Game/Screens/Edit/Components/Timelines/Summary/SummaryTimeline.cs

@@ -6,7 +6,6 @@ using osu.Framework.Allocation;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
-using osu.Framework.Timing;
 using osu.Game.Graphics;
 using osu.Game.Screens.Edit.Components.Timelines.Summary.Parts;
 
@@ -18,11 +17,11 @@ namespace osu.Game.Screens.Edit.Components.Timelines.Summary
     public class SummaryTimeline : BottomBarContainer
     {
         [BackgroundDependencyLoader]
-        private void load(OsuColour colours, IAdjustableClock adjustableClock)
+        private void load(OsuColour colours)
         {
             Children = new Drawable[]
             {
-                new MarkerPart(adjustableClock) { RelativeSizeAxes = Axes.Both },
+                new MarkerPart { RelativeSizeAxes = Axes.Both },
                 new ControlPointPart
                 {
                     Anchor = Anchor.Centre,

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

@@ -13,7 +13,6 @@ using osu.Framework.Graphics.Primitives;
 using osu.Framework.Input;
 using osu.Framework.Input.Bindings;
 using osu.Framework.Input.Events;
-using osu.Framework.Timing;
 using osu.Game.Rulesets.Edit;
 using osu.Game.Rulesets.Objects;
 using osu.Game.Rulesets.Objects.Drawables;
@@ -38,7 +37,7 @@ namespace osu.Game.Screens.Edit.Compose.Components
         private IEditorChangeHandler changeHandler { get; set; }
 
         [Resolved]
-        private IAdjustableClock adjustableClock { get; set; }
+        private EditorClock editorClock { get; set; }
 
         [Resolved]
         private EditorBeatmap beatmap { get; set; }
@@ -144,7 +143,7 @@ namespace osu.Game.Screens.Edit.Compose.Components
             if (clickedBlueprint == null)
                 return false;
 
-            adjustableClock?.Seek(clickedBlueprint.HitObject.StartTime);
+            editorClock?.Seek(clickedBlueprint.HitObject.StartTime);
             return true;
         }
 

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

@@ -9,7 +9,6 @@ using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Audio;
 using osu.Framework.Input.Events;
-using osu.Framework.Timing;
 using osu.Game.Beatmaps;
 using osu.Game.Graphics;
 using osu.Game.Rulesets.Edit;
@@ -25,7 +24,7 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
         public readonly IBindable<WorkingBeatmap> Beatmap = new Bindable<WorkingBeatmap>();
 
         [Resolved]
-        private IAdjustableClock adjustableClock { get; set; }
+        private EditorClock editorClock { get; set; }
 
         public Timeline()
         {
@@ -101,7 +100,7 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
             Content.Margin = new MarginPadding { Horizontal = DrawWidth / 2 };
 
             // This needs to happen after transforms are updated, but before the scroll position is updated in base.UpdateAfterChildren
-            if (adjustableClock.IsRunning)
+            if (editorClock.IsRunning)
                 scrollToTrackTime();
         }
 
@@ -111,21 +110,21 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
 
             if (handlingDragInput)
                 seekTrackToCurrent();
-            else if (!adjustableClock.IsRunning)
+            else if (!editorClock.IsRunning)
             {
                 // The track isn't running. There are two cases we have to be wary of:
                 // 1) The user flick-drags on this timeline: We want the track to follow us
                 // 2) The user changes the track time through some other means (scrolling in the editor or overview timeline): We want to follow the track time
 
                 // The simplest way to cover both cases is by checking whether the scroll position has changed and the audio hasn't been changed externally
-                if (Current != lastScrollPosition && adjustableClock.CurrentTime == lastTrackTime)
+                if (Current != lastScrollPosition && editorClock.CurrentTime == lastTrackTime)
                     seekTrackToCurrent();
                 else
                     scrollToTrackTime();
             }
 
             lastScrollPosition = Current;
-            lastTrackTime = adjustableClock.CurrentTime;
+            lastTrackTime = editorClock.CurrentTime;
         }
 
         private void seekTrackToCurrent()
@@ -133,7 +132,7 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
             if (!track.IsLoaded)
                 return;
 
-            adjustableClock.Seek(Current / Content.DrawWidth * track.Length);
+            editorClock.Seek(Current / Content.DrawWidth * track.Length);
         }
 
         private void scrollToTrackTime()
@@ -141,7 +140,7 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
             if (!track.IsLoaded || track.Length == 0)
                 return;
 
-            ScrollTo((float)(adjustableClock.CurrentTime / track.Length) * Content.DrawWidth, false);
+            ScrollTo((float)(editorClock.CurrentTime / track.Length) * Content.DrawWidth, false);
         }
 
         protected override bool OnMouseDown(MouseDownEvent e)
@@ -164,15 +163,15 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
         private void beginUserDrag()
         {
             handlingDragInput = true;
-            trackWasPlaying = adjustableClock.IsRunning;
+            trackWasPlaying = editorClock.IsRunning;
-            adjustableClock.Stop();
+            editorClock.Stop();
         }
 
         private void endUserDrag()
         {
             handlingDragInput = false;
             if (trackWasPlaying)
-                adjustableClock.Start();
+                editorClock.Start();
         }
 
         [Resolved]

osu.Game/Screens/Edit/Editor.cs

@@ -83,8 +83,7 @@ namespace osu.Game.Screens.Edit
             clock = new EditorClock(Beatmap.Value, beatDivisor) { IsCoupled = false };
             clock.ChangeSource(sourceClock);
 
-            dependencies.CacheAs<IFrameBasedClock>(clock);
+            dependencies.CacheAs(clock);
-            dependencies.CacheAs<IAdjustableClock>(clock);
 
             // todo: remove caching of this and consume via editorBeatmap?
             dependencies.Cache(beatDivisor);

osu.Game/Screens/Edit/EditorClock.cs

@@ -37,6 +37,11 @@ namespace osu.Game.Screens.Edit
             TrackLength = trackLength;
         }
 
+        public EditorClock()
+            : this(new ControlPointInfo(), 1000, new BindableBeatDivisor())
+        {
+        }
+
         /// <summary>
         /// Seek to the closest snappable beat from a time.
         /// </summary>

osu.Game/Screens/Edit/Timing/TimingScreen.cs

@@ -7,7 +7,6 @@ using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Shapes;
-using osu.Framework.Timing;
 using osu.Game.Beatmaps;
 using osu.Game.Beatmaps.ControlPoints;
 using osu.Game.Graphics;
@@ -23,7 +22,7 @@ namespace osu.Game.Screens.Edit.Timing
         private Bindable<ControlPointGroup> selectedGroup = new Bindable<ControlPointGroup>();
 
         [Resolved]
-        private IAdjustableClock clock { get; set; }
+        private EditorClock clock { get; set; }
 
         protected override Drawable CreateMainContent() => new GridContainer
         {
@@ -62,7 +61,7 @@ namespace osu.Game.Screens.Edit.Timing
             private IBindableList<ControlPointGroup> controlGroups;
 
             [Resolved]
-            private IFrameBasedClock clock { get; set; }
+            private EditorClock clock { get; set; }
 
             [Resolved]
             protected IBindable<WorkingBeatmap> Beatmap { get; private set; }

osu.Game/Tests/Visual/EditorClockTestScene.cs

@@ -30,8 +30,7 @@ namespace osu.Game.Tests.Visual
             var dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
 
             dependencies.Cache(BeatDivisor);
-            dependencies.CacheAs<IFrameBasedClock>(Clock);
+            dependencies.CacheAs(Clock);
-            dependencies.CacheAs<IAdjustableClock>(Clock);
 
             return dependencies;
         }

osu.Game/Tests/Visual/PlacementBlueprintTestScene.cs

@@ -8,6 +8,7 @@ using osu.Framework.Timing;
 using osu.Game.Rulesets.Edit;
 using osu.Game.Rulesets.Objects;
 using osu.Game.Rulesets.Objects.Drawables;
+using osu.Game.Screens.Edit;
 using osu.Game.Screens.Edit.Compose;
 
 namespace osu.Game.Tests.Visual
@@ -32,7 +33,7 @@ namespace osu.Game.Tests.Visual
         protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
         {
             var dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
-            dependencies.CacheAs<IAdjustableClock>(new StopwatchClock());
+            dependencies.CacheAs(new EditorClock());
 
             return dependencies;
         }