mirror of
https://github.com/ppy/osu.git
synced 2025-01-27 19:35:15 +08:00
Remove DistancedHitObjectComposer
inheritance from osu! composer
This commit is contained in:
parent
3ab083b696
commit
dcfd6a0a8a
@ -47,8 +47,7 @@ namespace osu.Game.Rulesets.Osu.Tests.Editor
|
|||||||
[Cached]
|
[Cached]
|
||||||
private readonly BindableBeatDivisor beatDivisor = new BindableBeatDivisor();
|
private readonly BindableBeatDivisor beatDivisor = new BindableBeatDivisor();
|
||||||
|
|
||||||
[Cached(typeof(IDistanceSnapProvider))]
|
private readonly TestHitObjectComposer composer = new TestHitObjectComposer
|
||||||
private readonly OsuHitObjectComposer snapProvider = new OsuHitObjectComposer(new OsuRuleset())
|
|
||||||
{
|
{
|
||||||
// Just used for the snap implementation, so let's hide from vision.
|
// Just used for the snap implementation, so let's hide from vision.
|
||||||
AlwaysPresent = true,
|
AlwaysPresent = true,
|
||||||
@ -71,11 +70,18 @@ namespace osu.Game.Rulesets.Osu.Tests.Editor
|
|||||||
base.Content.Children = new Drawable[]
|
base.Content.Children = new Drawable[]
|
||||||
{
|
{
|
||||||
editorClock = new EditorClock(editorBeatmap),
|
editorClock = new EditorClock(editorBeatmap),
|
||||||
new PopoverContainer { Child = snapProvider },
|
new PopoverContainer { Child = composer },
|
||||||
Content
|
Content
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
|
||||||
|
{
|
||||||
|
var dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
|
||||||
|
dependencies.CacheAs(composer.DistanceSnapProvider);
|
||||||
|
return dependencies;
|
||||||
|
}
|
||||||
|
|
||||||
protected override Container<Drawable> Content { get; } = new PopoverContainer { RelativeSizeAxes = Axes.Both };
|
protected override Container<Drawable> Content { get; } = new PopoverContainer { RelativeSizeAxes = Axes.Both };
|
||||||
|
|
||||||
[SetUp]
|
[SetUp]
|
||||||
@ -84,7 +90,7 @@ namespace osu.Game.Rulesets.Osu.Tests.Editor
|
|||||||
editorBeatmap.Difficulty.SliderMultiplier = 1;
|
editorBeatmap.Difficulty.SliderMultiplier = 1;
|
||||||
editorBeatmap.ControlPointInfo.Clear();
|
editorBeatmap.ControlPointInfo.Clear();
|
||||||
editorBeatmap.ControlPointInfo.Add(0, new TimingControlPoint { BeatLength = beat_length });
|
editorBeatmap.ControlPointInfo.Add(0, new TimingControlPoint { BeatLength = beat_length });
|
||||||
snapProvider.DistanceSpacingMultiplier.Value = 1;
|
composer.DistanceSnapProvider.DistanceSpacingMultiplier.Value = 1;
|
||||||
|
|
||||||
Children = new Drawable[]
|
Children = new Drawable[]
|
||||||
{
|
{
|
||||||
@ -116,7 +122,7 @@ namespace osu.Game.Rulesets.Osu.Tests.Editor
|
|||||||
[TestCase(0.5f)]
|
[TestCase(0.5f)]
|
||||||
public void TestDistanceSpacing(float multiplier)
|
public void TestDistanceSpacing(float multiplier)
|
||||||
{
|
{
|
||||||
AddStep($"set distance spacing = {multiplier}", () => snapProvider.DistanceSpacingMultiplier.Value = multiplier);
|
AddStep($"set distance spacing = {multiplier}", () => composer.DistanceSnapProvider.DistanceSpacingMultiplier.Value = multiplier);
|
||||||
}
|
}
|
||||||
|
|
||||||
[Test]
|
[Test]
|
||||||
@ -153,7 +159,7 @@ namespace osu.Game.Rulesets.Osu.Tests.Editor
|
|||||||
[TestCase(2f, beat_length * 2)]
|
[TestCase(2f, beat_length * 2)]
|
||||||
public void TestDistanceSpacingAdjust(float multiplier, float expectedDistance)
|
public void TestDistanceSpacingAdjust(float multiplier, float expectedDistance)
|
||||||
{
|
{
|
||||||
AddStep($"Set distance spacing to {multiplier}", () => snapProvider.DistanceSpacingMultiplier.Value = multiplier);
|
AddStep($"Set distance spacing to {multiplier}", () => composer.DistanceSnapProvider.DistanceSpacingMultiplier.Value = multiplier);
|
||||||
AddStep("move mouse to point", () => InputManager.MoveMouseTo(grid.ToScreenSpace(grid_position + new Vector2(beat_length, 0) * 2)));
|
AddStep("move mouse to point", () => InputManager.MoveMouseTo(grid.ToScreenSpace(grid_position + new Vector2(beat_length, 0) * 2)));
|
||||||
|
|
||||||
assertSnappedDistance(expectedDistance);
|
assertSnappedDistance(expectedDistance);
|
||||||
@ -266,5 +272,15 @@ namespace osu.Game.Rulesets.Osu.Tests.Editor
|
|||||||
cursor.Position = LastSnappedPosition = GetSnapPosition.Invoke(inputManager.CurrentState.Mouse.Position);
|
cursor.Position = LastSnappedPosition = GetSnapPosition.Invoke(inputManager.CurrentState.Mouse.Position);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private partial class TestHitObjectComposer : OsuHitObjectComposer
|
||||||
|
{
|
||||||
|
public new IDistanceSnapProvider DistanceSnapProvider => base.DistanceSnapProvider;
|
||||||
|
|
||||||
|
public TestHitObjectComposer()
|
||||||
|
: base(new OsuRuleset())
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
31
osu.Game.Rulesets.Osu/Edit/OsuDistanceSnapProvider.cs
Normal file
31
osu.Game.Rulesets.Osu/Edit/OsuDistanceSnapProvider.cs
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
// 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.Game.Graphics.UserInterface;
|
||||||
|
using osu.Game.Input.Bindings;
|
||||||
|
using osu.Game.Rulesets.Edit;
|
||||||
|
using osu.Game.Rulesets.Objects;
|
||||||
|
using osu.Game.Rulesets.Osu.Objects;
|
||||||
|
using osuTK;
|
||||||
|
|
||||||
|
namespace osu.Game.Rulesets.Osu.Edit
|
||||||
|
{
|
||||||
|
public partial class OsuDistanceSnapProvider : ComposerDistanceSnapProvider
|
||||||
|
{
|
||||||
|
protected override double ReadCurrentDistanceSnap(HitObject before, HitObject after)
|
||||||
|
{
|
||||||
|
float expectedDistance = DurationToDistance(before, after.StartTime - before.GetEndTime());
|
||||||
|
float actualDistance = Vector2.Distance(((OsuHitObject)before).EndPosition, ((OsuHitObject)after).Position);
|
||||||
|
|
||||||
|
return actualDistance / expectedDistance;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected override bool AdjustDistanceSpacing(GlobalAction action, float amount)
|
||||||
|
{
|
||||||
|
// To allow better visualisation, ensure that the spacing grid is visible before adjusting.
|
||||||
|
DistanceSnapToggle.Value = TernaryState.True;
|
||||||
|
|
||||||
|
return base.AdjustDistanceSpacing(action, amount);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -17,7 +17,6 @@ using osu.Framework.Input.Events;
|
|||||||
using osu.Framework.Utils;
|
using osu.Framework.Utils;
|
||||||
using osu.Game.Beatmaps;
|
using osu.Game.Beatmaps;
|
||||||
using osu.Game.Graphics.UserInterface;
|
using osu.Game.Graphics.UserInterface;
|
||||||
using osu.Game.Input.Bindings;
|
|
||||||
using osu.Game.Rulesets.Edit;
|
using osu.Game.Rulesets.Edit;
|
||||||
using osu.Game.Rulesets.Edit.Tools;
|
using osu.Game.Rulesets.Edit.Tools;
|
||||||
using osu.Game.Rulesets.Mods;
|
using osu.Game.Rulesets.Mods;
|
||||||
@ -30,7 +29,7 @@ using osuTK;
|
|||||||
|
|
||||||
namespace osu.Game.Rulesets.Osu.Edit
|
namespace osu.Game.Rulesets.Osu.Edit
|
||||||
{
|
{
|
||||||
public partial class OsuHitObjectComposer : DistancedHitObjectComposer<OsuHitObject>
|
public partial class OsuHitObjectComposer : HitObjectComposer<OsuHitObject>
|
||||||
{
|
{
|
||||||
public OsuHitObjectComposer(Ruleset ruleset)
|
public OsuHitObjectComposer(Ruleset ruleset)
|
||||||
: base(ruleset)
|
: base(ruleset)
|
||||||
@ -49,18 +48,27 @@ namespace osu.Game.Rulesets.Osu.Edit
|
|||||||
|
|
||||||
private readonly Bindable<TernaryState> rectangularGridSnapToggle = new Bindable<TernaryState>();
|
private readonly Bindable<TernaryState> rectangularGridSnapToggle = new Bindable<TernaryState>();
|
||||||
|
|
||||||
protected override IEnumerable<TernaryButton> CreateTernaryButtons() => base.CreateTernaryButtons().Concat(new[]
|
protected override IEnumerable<TernaryButton> CreateTernaryButtons()
|
||||||
{
|
=> base.CreateTernaryButtons()
|
||||||
new TernaryButton(rectangularGridSnapToggle, "Grid Snap", () => new SpriteIcon { Icon = FontAwesome.Solid.Th })
|
.Concat(DistanceSnapProvider.CreateTernaryButtons())
|
||||||
});
|
.Concat(new[]
|
||||||
|
{
|
||||||
|
new TernaryButton(rectangularGridSnapToggle, "Grid Snap", () => new SpriteIcon { Icon = FontAwesome.Solid.Th })
|
||||||
|
});
|
||||||
|
|
||||||
private BindableList<HitObject> selectedHitObjects;
|
private BindableList<HitObject> selectedHitObjects;
|
||||||
|
|
||||||
private Bindable<HitObject> placementObject;
|
private Bindable<HitObject> placementObject;
|
||||||
|
|
||||||
|
[Cached(typeof(IDistanceSnapProvider))]
|
||||||
|
protected readonly OsuDistanceSnapProvider DistanceSnapProvider = new OsuDistanceSnapProvider();
|
||||||
|
|
||||||
[BackgroundDependencyLoader]
|
[BackgroundDependencyLoader]
|
||||||
private void load()
|
private void load()
|
||||||
{
|
{
|
||||||
|
AddInternal(DistanceSnapProvider);
|
||||||
|
DistanceSnapProvider.AttachToToolbox(RightToolbox);
|
||||||
|
|
||||||
// Give a bit of breathing room around the playfield content.
|
// Give a bit of breathing room around the playfield content.
|
||||||
PlayfieldContentContainer.Padding = new MarginPadding(10);
|
PlayfieldContentContainer.Padding = new MarginPadding(10);
|
||||||
|
|
||||||
@ -81,7 +89,7 @@ namespace osu.Game.Rulesets.Osu.Edit
|
|||||||
|
|
||||||
placementObject = EditorBeatmap.PlacementObject.GetBoundCopy();
|
placementObject = EditorBeatmap.PlacementObject.GetBoundCopy();
|
||||||
placementObject.ValueChanged += _ => updateDistanceSnapGrid();
|
placementObject.ValueChanged += _ => updateDistanceSnapGrid();
|
||||||
DistanceSnapToggle.ValueChanged += _ => updateDistanceSnapGrid();
|
DistanceSnapProvider.DistanceSnapToggle.ValueChanged += _ => updateDistanceSnapGrid();
|
||||||
|
|
||||||
// we may be entering the screen with a selection already active
|
// we may be entering the screen with a selection already active
|
||||||
updateDistanceSnapGrid();
|
updateDistanceSnapGrid();
|
||||||
@ -106,14 +114,6 @@ namespace osu.Game.Rulesets.Osu.Edit
|
|||||||
|
|
||||||
private RectangularPositionSnapGrid rectangularPositionSnapGrid;
|
private RectangularPositionSnapGrid rectangularPositionSnapGrid;
|
||||||
|
|
||||||
protected override double ReadCurrentDistanceSnap(HitObject before, HitObject after)
|
|
||||||
{
|
|
||||||
float expectedDistance = DurationToDistance(before, after.StartTime - before.GetEndTime());
|
|
||||||
float actualDistance = Vector2.Distance(((OsuHitObject)before).EndPosition, ((OsuHitObject)after).Position);
|
|
||||||
|
|
||||||
return actualDistance / expectedDistance;
|
|
||||||
}
|
|
||||||
|
|
||||||
protected override void Update()
|
protected override void Update()
|
||||||
{
|
{
|
||||||
base.Update();
|
base.Update();
|
||||||
@ -143,7 +143,7 @@ namespace osu.Game.Rulesets.Osu.Edit
|
|||||||
// We want to ensure that in this particular case, the time-snapping component of distance snap is still applied.
|
// We want to ensure that in this particular case, the time-snapping component of distance snap is still applied.
|
||||||
// The easiest way to ensure this is to attempt application of distance snap after a nearby object is found, and copy over
|
// The easiest way to ensure this is to attempt application of distance snap after a nearby object is found, and copy over
|
||||||
// the time value if the proposed positions are roughly the same.
|
// the time value if the proposed positions are roughly the same.
|
||||||
if (snapType.HasFlagFast(SnapType.RelativeGrids) && DistanceSnapToggle.Value == TernaryState.True && distanceSnapGrid != null)
|
if (snapType.HasFlagFast(SnapType.RelativeGrids) && DistanceSnapProvider.DistanceSnapToggle.Value == TernaryState.True && distanceSnapGrid != null)
|
||||||
{
|
{
|
||||||
(Vector2 distanceSnappedPosition, double distanceSnappedTime) = distanceSnapGrid.GetSnappedPosition(distanceSnapGrid.ToLocalSpace(snapResult.ScreenSpacePosition));
|
(Vector2 distanceSnappedPosition, double distanceSnappedTime) = distanceSnapGrid.GetSnappedPosition(distanceSnapGrid.ToLocalSpace(snapResult.ScreenSpacePosition));
|
||||||
if (Precision.AlmostEquals(distanceSnapGrid.ToScreenSpace(distanceSnappedPosition), snapResult.ScreenSpacePosition, 1))
|
if (Precision.AlmostEquals(distanceSnapGrid.ToScreenSpace(distanceSnappedPosition), snapResult.ScreenSpacePosition, 1))
|
||||||
@ -157,7 +157,7 @@ namespace osu.Game.Rulesets.Osu.Edit
|
|||||||
|
|
||||||
if (snapType.HasFlagFast(SnapType.RelativeGrids))
|
if (snapType.HasFlagFast(SnapType.RelativeGrids))
|
||||||
{
|
{
|
||||||
if (DistanceSnapToggle.Value == TernaryState.True && distanceSnapGrid != null)
|
if (DistanceSnapProvider.DistanceSnapToggle.Value == TernaryState.True && distanceSnapGrid != null)
|
||||||
{
|
{
|
||||||
(Vector2 pos, double time) = distanceSnapGrid.GetSnappedPosition(distanceSnapGrid.ToLocalSpace(screenSpacePosition));
|
(Vector2 pos, double time) = distanceSnapGrid.GetSnappedPosition(distanceSnapGrid.ToLocalSpace(screenSpacePosition));
|
||||||
|
|
||||||
@ -220,7 +220,7 @@ namespace osu.Game.Rulesets.Osu.Edit
|
|||||||
distanceSnapGridCache.Invalidate();
|
distanceSnapGridCache.Invalidate();
|
||||||
distanceSnapGrid = null;
|
distanceSnapGrid = null;
|
||||||
|
|
||||||
if (DistanceSnapToggle.Value != TernaryState.True)
|
if (DistanceSnapProvider.DistanceSnapToggle.Value != TernaryState.True)
|
||||||
return;
|
return;
|
||||||
|
|
||||||
switch (BlueprintContainer.CurrentTool)
|
switch (BlueprintContainer.CurrentTool)
|
||||||
@ -262,14 +262,6 @@ namespace osu.Game.Rulesets.Osu.Edit
|
|||||||
base.OnKeyUp(e);
|
base.OnKeyUp(e);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected override bool AdjustDistanceSpacing(GlobalAction action, float amount)
|
|
||||||
{
|
|
||||||
// To allow better visualisation, ensure that the spacing grid is visible before adjusting.
|
|
||||||
DistanceSnapToggle.Value = TernaryState.True;
|
|
||||||
|
|
||||||
return base.AdjustDistanceSpacing(action, amount);
|
|
||||||
}
|
|
||||||
|
|
||||||
private bool gridSnapMomentary;
|
private bool gridSnapMomentary;
|
||||||
|
|
||||||
private void handleToggleViaKey(KeyboardEvent key)
|
private void handleToggleViaKey(KeyboardEvent key)
|
||||||
|
@ -3,7 +3,6 @@
|
|||||||
|
|
||||||
using NUnit.Framework;
|
using NUnit.Framework;
|
||||||
using osu.Framework.Allocation;
|
using osu.Framework.Allocation;
|
||||||
using osu.Framework.Bindables;
|
|
||||||
using osu.Framework.Graphics;
|
using osu.Framework.Graphics;
|
||||||
using osu.Framework.Graphics.Containers;
|
using osu.Framework.Graphics.Containers;
|
||||||
using osu.Framework.Graphics.Cursor;
|
using osu.Framework.Graphics.Cursor;
|
||||||
@ -230,25 +229,25 @@ namespace osu.Game.Tests.Editing
|
|||||||
}
|
}
|
||||||
|
|
||||||
private void assertSnapDistance(float expectedDistance, HitObject? referenceObject, bool includeSliderVelocity)
|
private void assertSnapDistance(float expectedDistance, HitObject? referenceObject, bool includeSliderVelocity)
|
||||||
=> AddAssert($"distance is {expectedDistance}", () => composer.GetBeatSnapDistanceAt(referenceObject ?? new HitObject(), includeSliderVelocity), () => Is.EqualTo(expectedDistance).Within(Precision.FLOAT_EPSILON));
|
=> AddAssert($"distance is {expectedDistance}", () => composer.DistanceSnapProvider.GetBeatSnapDistanceAt(referenceObject ?? new HitObject(), includeSliderVelocity), () => Is.EqualTo(expectedDistance).Within(Precision.FLOAT_EPSILON));
|
||||||
|
|
||||||
private void assertDurationToDistance(double duration, float expectedDistance, HitObject? referenceObject = null)
|
private void assertDurationToDistance(double duration, float expectedDistance, HitObject? referenceObject = null)
|
||||||
=> AddAssert($"duration = {duration} -> distance = {expectedDistance}", () => composer.DurationToDistance(referenceObject ?? new HitObject(), duration), () => Is.EqualTo(expectedDistance).Within(Precision.FLOAT_EPSILON));
|
=> AddAssert($"duration = {duration} -> distance = {expectedDistance}", () => composer.DistanceSnapProvider.DurationToDistance(referenceObject ?? new HitObject(), duration), () => Is.EqualTo(expectedDistance).Within(Precision.FLOAT_EPSILON));
|
||||||
|
|
||||||
private void assertDistanceToDuration(float distance, double expectedDuration, HitObject? referenceObject = null)
|
private void assertDistanceToDuration(float distance, double expectedDuration, HitObject? referenceObject = null)
|
||||||
=> AddAssert($"distance = {distance} -> duration = {expectedDuration}", () => composer.DistanceToDuration(referenceObject ?? new HitObject(), distance), () => Is.EqualTo(expectedDuration).Within(Precision.FLOAT_EPSILON));
|
=> AddAssert($"distance = {distance} -> duration = {expectedDuration}", () => composer.DistanceSnapProvider.DistanceToDuration(referenceObject ?? new HitObject(), distance), () => Is.EqualTo(expectedDuration).Within(Precision.FLOAT_EPSILON));
|
||||||
|
|
||||||
private void assertSnappedDuration(float distance, double expectedDuration, HitObject? referenceObject = null)
|
private void assertSnappedDuration(float distance, double expectedDuration, HitObject? referenceObject = null)
|
||||||
=> AddAssert($"distance = {distance} -> duration = {expectedDuration} (snapped)", () => composer.FindSnappedDuration(referenceObject ?? new HitObject(), distance), () => Is.EqualTo(expectedDuration).Within(Precision.FLOAT_EPSILON));
|
=> AddAssert($"distance = {distance} -> duration = {expectedDuration} (snapped)", () => composer.DistanceSnapProvider.FindSnappedDuration(referenceObject ?? new HitObject(), distance), () => Is.EqualTo(expectedDuration).Within(Precision.FLOAT_EPSILON));
|
||||||
|
|
||||||
private void assertSnappedDistance(float distance, float expectedDistance, HitObject? referenceObject = null)
|
private void assertSnappedDistance(float distance, float expectedDistance, HitObject? referenceObject = null)
|
||||||
=> AddAssert($"distance = {distance} -> distance = {expectedDistance} (snapped)", () => composer.FindSnappedDistance(referenceObject ?? new HitObject(), distance), () => Is.EqualTo(expectedDistance).Within(Precision.FLOAT_EPSILON));
|
=> AddAssert($"distance = {distance} -> distance = {expectedDistance} (snapped)", () => composer.DistanceSnapProvider.FindSnappedDistance(referenceObject ?? new HitObject(), distance), () => Is.EqualTo(expectedDistance).Within(Precision.FLOAT_EPSILON));
|
||||||
|
|
||||||
private partial class TestHitObjectComposer : OsuHitObjectComposer
|
private partial class TestHitObjectComposer : OsuHitObjectComposer
|
||||||
{
|
{
|
||||||
public new EditorBeatmap EditorBeatmap => base.EditorBeatmap;
|
public new EditorBeatmap EditorBeatmap => base.EditorBeatmap;
|
||||||
|
|
||||||
public new Bindable<double> DistanceSpacingMultiplier => base.DistanceSpacingMultiplier;
|
public new IDistanceSnapProvider DistanceSnapProvider => base.DistanceSnapProvider;
|
||||||
|
|
||||||
public TestHitObjectComposer()
|
public TestHitObjectComposer()
|
||||||
: base(new OsuRuleset())
|
: base(new OsuRuleset())
|
||||||
|
@ -187,11 +187,9 @@ namespace osu.Game.Tests.Visual.Editing
|
|||||||
|
|
||||||
private class SnapProvider : IDistanceSnapProvider
|
private class SnapProvider : IDistanceSnapProvider
|
||||||
{
|
{
|
||||||
public SnapResult FindSnappedPositionAndTime(Vector2 screenSpacePosition, SnapType snapType = SnapType.AllGrids) => new SnapResult(screenSpacePosition, 0);
|
|
||||||
|
|
||||||
public Bindable<double> DistanceSpacingMultiplier { get; } = new BindableDouble(1);
|
public Bindable<double> DistanceSpacingMultiplier { get; } = new BindableDouble(1);
|
||||||
|
|
||||||
IBindable<double> IDistanceSnapProvider.DistanceSpacingMultiplier => DistanceSpacingMultiplier;
|
Bindable<double> IDistanceSnapProvider.DistanceSpacingMultiplier => DistanceSpacingMultiplier;
|
||||||
|
|
||||||
public float GetBeatSnapDistanceAt(HitObject referenceObject, bool useReferenceSliderVelocity = true) => beat_snap_distance;
|
public float GetBeatSnapDistanceAt(HitObject referenceObject, bool useReferenceSliderVelocity = true) => beat_snap_distance;
|
||||||
|
|
||||||
|
311
osu.Game/Rulesets/Edit/ComposerDistanceSnapProvider.cs
Normal file
311
osu.Game/Rulesets/Edit/ComposerDistanceSnapProvider.cs
Normal file
@ -0,0 +1,311 @@
|
|||||||
|
// 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 System.Collections.Generic;
|
||||||
|
using System.Diagnostics;
|
||||||
|
using System.Linq;
|
||||||
|
using osu.Framework.Allocation;
|
||||||
|
using osu.Framework.Bindables;
|
||||||
|
using osu.Framework.Extensions;
|
||||||
|
using osu.Framework.Extensions.LocalisationExtensions;
|
||||||
|
using osu.Framework.Graphics;
|
||||||
|
using osu.Framework.Graphics.Sprites;
|
||||||
|
using osu.Framework.Input.Bindings;
|
||||||
|
using osu.Framework.Input.Events;
|
||||||
|
using osu.Framework.Localisation;
|
||||||
|
using osu.Framework.Utils;
|
||||||
|
using osu.Game.Configuration;
|
||||||
|
using osu.Game.Graphics.UserInterface;
|
||||||
|
using osu.Game.Input.Bindings;
|
||||||
|
using osu.Game.Overlays;
|
||||||
|
using osu.Game.Overlays.OSD;
|
||||||
|
using osu.Game.Overlays.Settings.Sections;
|
||||||
|
using osu.Game.Rulesets.Objects;
|
||||||
|
using osu.Game.Rulesets.Objects.Types;
|
||||||
|
using osu.Game.Rulesets.UI;
|
||||||
|
using osu.Game.Screens.Edit;
|
||||||
|
using osu.Game.Screens.Edit.Components.TernaryButtons;
|
||||||
|
|
||||||
|
namespace osu.Game.Rulesets.Edit
|
||||||
|
{
|
||||||
|
public abstract partial class ComposerDistanceSnapProvider : Component, IDistanceSnapProvider, IScrollBindingHandler<GlobalAction>
|
||||||
|
{
|
||||||
|
private const float adjust_step = 0.1f;
|
||||||
|
|
||||||
|
public BindableDouble DistanceSpacingMultiplier { get; } = new BindableDouble(1.0)
|
||||||
|
{
|
||||||
|
MinValue = 0.1,
|
||||||
|
MaxValue = 6.0,
|
||||||
|
Precision = 0.01,
|
||||||
|
};
|
||||||
|
|
||||||
|
Bindable<double> IDistanceSnapProvider.DistanceSpacingMultiplier => DistanceSpacingMultiplier;
|
||||||
|
|
||||||
|
private ExpandableSlider<double, SizeSlider<double>> distanceSpacingSlider = null!;
|
||||||
|
private ExpandableButton currentDistanceSpacingButton = null!;
|
||||||
|
|
||||||
|
[Resolved]
|
||||||
|
private Playfield playfield { get; set; } = null!;
|
||||||
|
|
||||||
|
[Resolved]
|
||||||
|
private EditorClock editorClock { get; set; } = null!;
|
||||||
|
|
||||||
|
[Resolved]
|
||||||
|
private EditorBeatmap editorBeatmap { get; set; } = null!;
|
||||||
|
|
||||||
|
[Resolved]
|
||||||
|
private IBeatSnapProvider beatSnapProvider { get; set; } = null!;
|
||||||
|
|
||||||
|
[Resolved]
|
||||||
|
private OnScreenDisplay? onScreenDisplay { get; set; }
|
||||||
|
|
||||||
|
public readonly Bindable<TernaryState> DistanceSnapToggle = new Bindable<TernaryState>();
|
||||||
|
|
||||||
|
private bool distanceSnapMomentary;
|
||||||
|
|
||||||
|
private EditorToolboxGroup? toolboxGroup;
|
||||||
|
|
||||||
|
public void AttachToToolbox(ExpandingToolboxContainer toolboxContainer)
|
||||||
|
{
|
||||||
|
if (toolboxGroup != null)
|
||||||
|
throw new InvalidOperationException($"{nameof(AttachToToolbox)} may be called only once for a single {nameof(ComposerDistanceSnapProvider)} instance.");
|
||||||
|
|
||||||
|
toolboxContainer.Add(toolboxGroup = new EditorToolboxGroup("snapping")
|
||||||
|
{
|
||||||
|
Alpha = DistanceSpacingMultiplier.Disabled ? 0 : 1,
|
||||||
|
Children = new Drawable[]
|
||||||
|
{
|
||||||
|
distanceSpacingSlider = new ExpandableSlider<double, SizeSlider<double>>
|
||||||
|
{
|
||||||
|
KeyboardStep = adjust_step,
|
||||||
|
// Manual binding in LoadComplete to handle one-way event flow.
|
||||||
|
Current = DistanceSpacingMultiplier.GetUnboundCopy(),
|
||||||
|
},
|
||||||
|
currentDistanceSpacingButton = new ExpandableButton
|
||||||
|
{
|
||||||
|
Action = () =>
|
||||||
|
{
|
||||||
|
(HitObject before, HitObject after)? objects = getObjectsOnEitherSideOfCurrentTime();
|
||||||
|
|
||||||
|
Debug.Assert(objects != null);
|
||||||
|
|
||||||
|
DistanceSpacingMultiplier.Value = ReadCurrentDistanceSnap(objects.Value.before, objects.Value.after);
|
||||||
|
DistanceSnapToggle.Value = TernaryState.True;
|
||||||
|
},
|
||||||
|
RelativeSizeAxes = Axes.X,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
if (DistanceSpacingMultiplier.Disabled)
|
||||||
|
{
|
||||||
|
distanceSpacingSlider.Hide();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
DistanceSpacingMultiplier.Value = editorBeatmap.BeatmapInfo.DistanceSpacing;
|
||||||
|
DistanceSpacingMultiplier.BindValueChanged(multiplier =>
|
||||||
|
{
|
||||||
|
distanceSpacingSlider.ContractedLabelText = $"D. S. ({multiplier.NewValue:0.##x})";
|
||||||
|
distanceSpacingSlider.ExpandedLabelText = $"Distance Spacing ({multiplier.NewValue:0.##x})";
|
||||||
|
|
||||||
|
if (multiplier.NewValue != multiplier.OldValue)
|
||||||
|
onScreenDisplay?.Display(new DistanceSpacingToast(multiplier.NewValue.ToLocalisableString(@"0.##x"), multiplier));
|
||||||
|
|
||||||
|
editorBeatmap.BeatmapInfo.DistanceSpacing = multiplier.NewValue;
|
||||||
|
}, true);
|
||||||
|
|
||||||
|
// Manual binding to handle enabling distance spacing when the slider is interacted with.
|
||||||
|
distanceSpacingSlider.Current.BindValueChanged(spacing =>
|
||||||
|
{
|
||||||
|
DistanceSpacingMultiplier.Value = spacing.NewValue;
|
||||||
|
DistanceSnapToggle.Value = TernaryState.True;
|
||||||
|
});
|
||||||
|
DistanceSpacingMultiplier.BindValueChanged(spacing => distanceSpacingSlider.Current.Value = spacing.NewValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
private (HitObject before, HitObject after)? getObjectsOnEitherSideOfCurrentTime()
|
||||||
|
{
|
||||||
|
HitObject? lastBefore = playfield.HitObjectContainer.AliveObjects.LastOrDefault(h => h.HitObject.StartTime < editorClock.CurrentTime)?.HitObject;
|
||||||
|
|
||||||
|
if (lastBefore == null)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
HitObject? firstAfter = playfield.HitObjectContainer.AliveObjects.FirstOrDefault(h => h.HitObject.StartTime >= editorClock.CurrentTime)?.HitObject;
|
||||||
|
|
||||||
|
if (firstAfter == null)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
if (lastBefore == firstAfter)
|
||||||
|
return null;
|
||||||
|
|
||||||
|
return (lastBefore, firstAfter);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected abstract double ReadCurrentDistanceSnap(HitObject before, HitObject after);
|
||||||
|
|
||||||
|
protected override void Update()
|
||||||
|
{
|
||||||
|
base.Update();
|
||||||
|
|
||||||
|
(HitObject before, HitObject after)? objects = getObjectsOnEitherSideOfCurrentTime();
|
||||||
|
|
||||||
|
double currentSnap = objects == null
|
||||||
|
? 0
|
||||||
|
: ReadCurrentDistanceSnap(objects.Value.before, objects.Value.after);
|
||||||
|
|
||||||
|
if (currentSnap > DistanceSpacingMultiplier.MinValue)
|
||||||
|
{
|
||||||
|
currentDistanceSpacingButton.Enabled.Value = currentDistanceSpacingButton.Expanded.Value
|
||||||
|
&& !DistanceSpacingMultiplier.Disabled
|
||||||
|
&& !Precision.AlmostEquals(currentSnap, DistanceSpacingMultiplier.Value, DistanceSpacingMultiplier.Precision / 2);
|
||||||
|
currentDistanceSpacingButton.ContractedLabelText = $"current {currentSnap:N2}x";
|
||||||
|
currentDistanceSpacingButton.ExpandedLabelText = $"Use current ({currentSnap:N2}x)";
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
currentDistanceSpacingButton.Enabled.Value = false;
|
||||||
|
currentDistanceSpacingButton.ContractedLabelText = string.Empty;
|
||||||
|
currentDistanceSpacingButton.ExpandedLabelText = "Use current (unavailable)";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public IEnumerable<TernaryButton> CreateTernaryButtons() => new[]
|
||||||
|
{
|
||||||
|
new TernaryButton(DistanceSnapToggle, "Distance Snap", () => new SpriteIcon { Icon = FontAwesome.Solid.Ruler })
|
||||||
|
};
|
||||||
|
|
||||||
|
protected override bool OnKeyDown(KeyDownEvent e)
|
||||||
|
{
|
||||||
|
if (e.Repeat)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
handleToggleViaKey(e);
|
||||||
|
return base.OnKeyDown(e);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected override void OnKeyUp(KeyUpEvent e)
|
||||||
|
{
|
||||||
|
handleToggleViaKey(e);
|
||||||
|
base.OnKeyUp(e);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void handleToggleViaKey(KeyboardEvent key)
|
||||||
|
{
|
||||||
|
bool altPressed = key.AltPressed;
|
||||||
|
|
||||||
|
if (altPressed != distanceSnapMomentary)
|
||||||
|
{
|
||||||
|
distanceSnapMomentary = altPressed;
|
||||||
|
DistanceSnapToggle.Value = DistanceSnapToggle.Value == TernaryState.False ? TernaryState.True : TernaryState.False;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public virtual bool OnPressed(KeyBindingPressEvent<GlobalAction> e)
|
||||||
|
{
|
||||||
|
switch (e.Action)
|
||||||
|
{
|
||||||
|
case GlobalAction.EditorIncreaseDistanceSpacing:
|
||||||
|
case GlobalAction.EditorDecreaseDistanceSpacing:
|
||||||
|
return AdjustDistanceSpacing(e.Action, adjust_step);
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
public virtual void OnReleased(KeyBindingReleaseEvent<GlobalAction> e)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
public bool OnScroll(KeyBindingScrollEvent<GlobalAction> e)
|
||||||
|
{
|
||||||
|
switch (e.Action)
|
||||||
|
{
|
||||||
|
case GlobalAction.EditorIncreaseDistanceSpacing:
|
||||||
|
case GlobalAction.EditorDecreaseDistanceSpacing:
|
||||||
|
return AdjustDistanceSpacing(e.Action, e.ScrollAmount * adjust_step);
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected virtual bool AdjustDistanceSpacing(GlobalAction action, float amount)
|
||||||
|
{
|
||||||
|
if (DistanceSpacingMultiplier.Disabled)
|
||||||
|
return false;
|
||||||
|
|
||||||
|
if (action == GlobalAction.EditorIncreaseDistanceSpacing)
|
||||||
|
DistanceSpacingMultiplier.Value += amount;
|
||||||
|
else if (action == GlobalAction.EditorDecreaseDistanceSpacing)
|
||||||
|
DistanceSpacingMultiplier.Value -= amount;
|
||||||
|
|
||||||
|
DistanceSnapToggle.Value = TernaryState.True;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
#region IDistanceSnapProvider
|
||||||
|
|
||||||
|
public virtual float GetBeatSnapDistanceAt(HitObject referenceObject, bool useReferenceSliderVelocity = true)
|
||||||
|
{
|
||||||
|
return (float)(100 * (useReferenceSliderVelocity && referenceObject is IHasSliderVelocity hasSliderVelocity ? hasSliderVelocity.SliderVelocityMultiplier : 1) * editorBeatmap.Difficulty.SliderMultiplier * 1
|
||||||
|
/ beatSnapProvider.BeatDivisor);
|
||||||
|
}
|
||||||
|
|
||||||
|
public virtual float DurationToDistance(HitObject referenceObject, double duration)
|
||||||
|
{
|
||||||
|
double beatLength = beatSnapProvider.GetBeatLengthAtTime(referenceObject.StartTime);
|
||||||
|
return (float)(duration / beatLength * GetBeatSnapDistanceAt(referenceObject));
|
||||||
|
}
|
||||||
|
|
||||||
|
public virtual double DistanceToDuration(HitObject referenceObject, float distance)
|
||||||
|
{
|
||||||
|
double beatLength = beatSnapProvider.GetBeatLengthAtTime(referenceObject.StartTime);
|
||||||
|
return distance / GetBeatSnapDistanceAt(referenceObject) * beatLength;
|
||||||
|
}
|
||||||
|
|
||||||
|
public virtual double FindSnappedDuration(HitObject referenceObject, float distance)
|
||||||
|
=> beatSnapProvider.SnapTime(referenceObject.StartTime + DistanceToDuration(referenceObject, distance), referenceObject.StartTime) - referenceObject.StartTime;
|
||||||
|
|
||||||
|
public virtual float FindSnappedDistance(HitObject referenceObject, float distance)
|
||||||
|
{
|
||||||
|
double startTime = referenceObject.StartTime;
|
||||||
|
|
||||||
|
double actualDuration = startTime + DistanceToDuration(referenceObject, distance);
|
||||||
|
|
||||||
|
double snappedEndTime = beatSnapProvider.SnapTime(actualDuration, startTime);
|
||||||
|
|
||||||
|
double beatLength = beatSnapProvider.GetBeatLengthAtTime(startTime);
|
||||||
|
|
||||||
|
// we don't want to exceed the actual duration and snap to a point in the future.
|
||||||
|
// as we are snapping to beat length via SnapTime (which will round-to-nearest), check for snapping in the forward direction and reverse it.
|
||||||
|
if (snappedEndTime > actualDuration + 1)
|
||||||
|
snappedEndTime -= beatLength;
|
||||||
|
|
||||||
|
return DurationToDistance(referenceObject, snappedEndTime - startTime);
|
||||||
|
}
|
||||||
|
|
||||||
|
#endregion
|
||||||
|
|
||||||
|
private partial class DistanceSpacingToast : Toast
|
||||||
|
{
|
||||||
|
private readonly ValueChangedEvent<double> change;
|
||||||
|
|
||||||
|
public DistanceSpacingToast(LocalisableString value, ValueChangedEvent<double> change)
|
||||||
|
: base(getAction(change).GetLocalisableDescription(), value, string.Empty)
|
||||||
|
{
|
||||||
|
this.change = change;
|
||||||
|
}
|
||||||
|
|
||||||
|
[BackgroundDependencyLoader]
|
||||||
|
private void load(OsuConfigManager config)
|
||||||
|
{
|
||||||
|
ShortcutText.Text = config.LookupKeyBindings(getAction(change)).ToUpper();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static GlobalAction getAction(ValueChangedEvent<double> change) => change.NewValue - change.OldValue > 0
|
||||||
|
? GlobalAction.EditorIncreaseDistanceSpacing
|
||||||
|
: GlobalAction.EditorDecreaseDistanceSpacing;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -44,7 +44,7 @@ namespace osu.Game.Rulesets.Edit
|
|||||||
Precision = 0.01,
|
Precision = 0.01,
|
||||||
};
|
};
|
||||||
|
|
||||||
IBindable<double> IDistanceSnapProvider.DistanceSpacingMultiplier => DistanceSpacingMultiplier;
|
Bindable<double> IDistanceSnapProvider.DistanceSpacingMultiplier => DistanceSpacingMultiplier;
|
||||||
|
|
||||||
private ExpandableSlider<double, SizeSlider<double>> distanceSpacingSlider;
|
private ExpandableSlider<double, SizeSlider<double>> distanceSpacingSlider;
|
||||||
private ExpandableButton currentDistanceSpacingButton;
|
private ExpandableButton currentDistanceSpacingButton;
|
||||||
@ -52,7 +52,7 @@ namespace osu.Game.Rulesets.Edit
|
|||||||
[Resolved(canBeNull: true)]
|
[Resolved(canBeNull: true)]
|
||||||
private OnScreenDisplay onScreenDisplay { get; set; }
|
private OnScreenDisplay onScreenDisplay { get; set; }
|
||||||
|
|
||||||
protected readonly Bindable<TernaryState> DistanceSnapToggle = new Bindable<TernaryState>();
|
public readonly Bindable<TernaryState> DistanceSnapToggle = new Bindable<TernaryState>();
|
||||||
|
|
||||||
private bool distanceSnapMomentary;
|
private bool distanceSnapMomentary;
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ namespace osu.Game.Rulesets.Edit
|
|||||||
/// Importantly, this is provided for manual usage, and not multiplied into any of the methods exposed by this interface.
|
/// Importantly, this is provided for manual usage, and not multiplied into any of the methods exposed by this interface.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
/// <seealso cref="BeatmapInfo.DistanceSpacing"/>
|
/// <seealso cref="BeatmapInfo.DistanceSpacing"/>
|
||||||
IBindable<double> DistanceSpacingMultiplier { get; }
|
Bindable<double> DistanceSpacingMultiplier { get; }
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Retrieves the distance between two points within a timing point that are one beat length apart.
|
/// Retrieves the distance between two points within a timing point that are one beat length apart.
|
||||||
|
Loading…
Reference in New Issue
Block a user