2019-08-26 07:31:46 +00:00
// 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.Linq ;
2020-09-17 08:40:05 +00:00
using System.Threading ;
2019-08-26 07:31:46 +00:00
using NUnit.Framework ;
2019-09-24 07:49:42 +00:00
using osu.Framework.Bindables ;
2019-08-26 07:31:46 +00:00
using osu.Framework.Graphics ;
using osu.Framework.Graphics.Containers ;
using osu.Framework.Graphics.Shapes ;
using osu.Framework.Input ;
2020-01-09 04:43:44 +00:00
using osu.Framework.Utils ;
2019-08-26 07:31:46 +00:00
using osu.Framework.Timing ;
using osu.Game.Beatmaps ;
using osu.Game.Beatmaps.ControlPoints ;
using osu.Game.Configuration ;
using osu.Game.Rulesets ;
using osu.Game.Rulesets.Difficulty ;
using osu.Game.Rulesets.Mods ;
using osu.Game.Rulesets.Objects ;
using osu.Game.Rulesets.Objects.Drawables ;
2020-02-25 10:07:15 +00:00
using osu.Game.Rulesets.Objects.Legacy ;
2019-08-26 07:31:46 +00:00
using osu.Game.Rulesets.Objects.Types ;
using osu.Game.Rulesets.Osu ;
using osu.Game.Rulesets.UI ;
using osu.Game.Rulesets.UI.Scrolling ;
using osuTK ;
using osuTK.Graphics ;
namespace osu.Game.Tests.Visual.Gameplay
{
public class TestSceneDrawableScrollingRuleset : OsuTestScene
{
/// <summary>
/// The amount of time visible by the "view window" of the playfield.
/// All hitobjects added through <see cref="createBeatmap"/> are spaced apart by this value, such that for a beat length of 1000,
/// there will be at most 2 hitobjects visible in the "view window".
/// </summary>
private const double time_range = 1000 ;
private readonly ManualClock testClock = new ManualClock ( ) ;
private TestDrawableScrollingRuleset drawableRuleset ;
[SetUp]
public void Setup ( ) = > Schedule ( ( ) = > testClock . CurrentTime = 0 ) ;
[Test]
public void TestRelativeBeatLengthScaleSingleTimingPoint ( )
{
2019-10-25 10:48:01 +00:00
var beatmap = createBeatmap ( ) ;
beatmap . ControlPointInfo . Add ( 0 , new TimingControlPoint { BeatLength = time_range / 2 } ) ;
2019-08-26 07:31:46 +00:00
createTest ( beatmap , d = > d . RelativeScaleBeatLengthsOverride = true ) ;
assertPosition ( 0 , 0f ) ;
// The single timing point is 1x speed relative to itself, such that the hitobject occurring time_range milliseconds later should appear
// at the bottom of the view window regardless of the timing point's beat length
assertPosition ( 1 , 1f ) ;
}
[Test]
public void TestRelativeBeatLengthScaleTimingPointBeyondEndDoesNotBecomeDominant ( )
{
2019-10-25 10:48:01 +00:00
var beatmap = createBeatmap ( ) ;
beatmap . ControlPointInfo . Add ( 0 , new TimingControlPoint { BeatLength = time_range / 2 } ) ;
beatmap . ControlPointInfo . Add ( 12000 , new TimingControlPoint { BeatLength = time_range } ) ;
beatmap . ControlPointInfo . Add ( 100000 , new TimingControlPoint { BeatLength = time_range } ) ;
2019-08-26 07:31:46 +00:00
createTest ( beatmap , d = > d . RelativeScaleBeatLengthsOverride = true ) ;
assertPosition ( 0 , 0f ) ;
assertPosition ( 1 , 1f ) ;
}
[Test]
public void TestRelativeBeatLengthScaleFromSecondTimingPoint ( )
{
2019-10-25 10:48:01 +00:00
var beatmap = createBeatmap ( ) ;
beatmap . ControlPointInfo . Add ( 0 , new TimingControlPoint { BeatLength = time_range } ) ;
beatmap . ControlPointInfo . Add ( 3 * time_range , new TimingControlPoint { BeatLength = time_range / 2 } ) ;
2019-08-26 07:31:46 +00:00
createTest ( beatmap , d = > d . RelativeScaleBeatLengthsOverride = true ) ;
// The first timing point should have a relative velocity of 2
assertPosition ( 0 , 0f ) ;
assertPosition ( 1 , 0.5f ) ;
assertPosition ( 2 , 1f ) ;
// Move to the second timing point
setTime ( 3 * time_range ) ;
assertPosition ( 3 , 0f ) ;
// As above, this is the timing point that is 1x speed relative to itself, so the hitobject occurring time_range milliseconds later should be at the bottom of the view window
assertPosition ( 4 , 1f ) ;
}
[Test]
public void TestNonRelativeScale ( )
{
2019-10-25 10:48:01 +00:00
var beatmap = createBeatmap ( ) ;
beatmap . ControlPointInfo . Add ( 0 , new TimingControlPoint { BeatLength = time_range } ) ;
beatmap . ControlPointInfo . Add ( 3 * time_range , new TimingControlPoint { BeatLength = time_range / 2 } ) ;
2019-08-26 07:31:46 +00:00
createTest ( beatmap ) ;
assertPosition ( 0 , 0f ) ;
assertPosition ( 1 , 1 ) ;
// Move to the second timing point
setTime ( 3 * time_range ) ;
assertPosition ( 3 , 0f ) ;
// For a beat length of 500, the view window of this timing point is elongated 2x (1000 / 500), such that the second hitobject is two TimeRanges away (offscreen)
// To bring it on-screen, half TimeRange is added to the current time, bringing the second half of the view window into view, and the hitobject should appear at the bottom
setTime ( 3 * time_range + time_range / 2 ) ;
assertPosition ( 4 , 1f ) ;
}
2019-09-24 07:49:42 +00:00
[Test]
2019-09-25 11:03:03 +00:00
public void TestSliderMultiplierDoesNotAffectRelativeBeatLength ( )
2019-09-24 07:49:42 +00:00
{
2019-10-25 10:48:01 +00:00
var beatmap = createBeatmap ( ) ;
beatmap . ControlPointInfo . Add ( 0 , new TimingControlPoint { BeatLength = time_range } ) ;
2019-09-24 07:49:42 +00:00
beatmap . BeatmapInfo . BaseDifficulty . SliderMultiplier = 2 ;
createTest ( beatmap , d = > d . RelativeScaleBeatLengthsOverride = true ) ;
AddStep ( "adjust time range" , ( ) = > drawableRuleset . TimeRange . Value = 5000 ) ;
for ( int i = 0 ; i < 5 ; i + + )
assertPosition ( i , i / 5f ) ;
}
2019-09-25 11:12:01 +00:00
[Test]
public void TestSliderMultiplierAffectsNonRelativeBeatLength ( )
{
2019-10-25 10:48:01 +00:00
var beatmap = createBeatmap ( ) ;
beatmap . ControlPointInfo . Add ( 0 , new TimingControlPoint { BeatLength = time_range } ) ;
2019-09-25 11:12:01 +00:00
beatmap . BeatmapInfo . BaseDifficulty . SliderMultiplier = 2 ;
createTest ( beatmap ) ;
AddStep ( "adjust time range" , ( ) = > drawableRuleset . TimeRange . Value = 2000 ) ;
assertPosition ( 0 , 0 ) ;
assertPosition ( 1 , 1 ) ;
}
2019-08-26 07:31:46 +00:00
private void assertPosition ( int index , float relativeY ) = > AddAssert ( $"hitobject {index} at {relativeY}" ,
( ) = > Precision . AlmostEquals ( drawableRuleset . Playfield . AllHitObjects . ElementAt ( index ) . DrawPosition . Y , drawableRuleset . Playfield . HitObjectContainer . DrawHeight * relativeY ) ) ;
private void setTime ( double time )
{
AddStep ( $"set time = {time}" , ( ) = > testClock . CurrentTime = time ) ;
}
/// <summary>
/// Creates an <see cref="IBeatmap"/>, containing 10 hitobjects and user-provided timing points.
/// The hitobjects are spaced <see cref="time_range"/> milliseconds apart.
/// </summary>
/// <returns>The <see cref="IBeatmap"/>.</returns>
2019-10-25 10:48:01 +00:00
private IBeatmap createBeatmap ( )
2019-08-26 07:31:46 +00:00
{
var beatmap = new Beatmap < HitObject > { BeatmapInfo = { Ruleset = new OsuRuleset ( ) . RulesetInfo } } ;
for ( int i = 0 ; i < 10 ; i + + )
2020-02-25 10:07:15 +00:00
beatmap . HitObjects . Add ( new HitObject { StartTime = i * time_range } ) ;
2019-08-26 07:31:46 +00:00
return beatmap ;
}
private void createTest ( IBeatmap beatmap , Action < TestDrawableScrollingRuleset > overrideAction = null ) = > AddStep ( "create test" , ( ) = >
{
var ruleset = new TestScrollingRuleset ( ) ;
2019-12-12 07:48:33 +00:00
drawableRuleset = ( TestDrawableScrollingRuleset ) ruleset . CreateDrawableRulesetWith ( CreateWorkingBeatmap ( beatmap ) . GetPlayableBeatmap ( ruleset . RulesetInfo ) ) ;
2019-08-26 07:31:46 +00:00
drawableRuleset . FrameStablePlayback = false ;
overrideAction ? . Invoke ( drawableRuleset ) ;
Child = new Container
{
Anchor = Anchor . Centre ,
Origin = Anchor . Centre ,
RelativeSizeAxes = Axes . Y ,
Height = 0.75f ,
Width = 400 ,
Masking = true ,
Clock = new FramedClock ( testClock ) ,
Child = drawableRuleset
} ;
} ) ;
#region Ruleset
private class TestScrollingRuleset : Ruleset
{
public override IEnumerable < Mod > GetModsFor ( ModType type ) = > throw new NotImplementedException ( ) ;
2019-12-12 06:58:11 +00:00
public override DrawableRuleset CreateDrawableRulesetWith ( IBeatmap beatmap , IReadOnlyList < Mod > mods = null ) = > new TestDrawableScrollingRuleset ( this , beatmap , mods ) ;
2019-08-26 07:31:46 +00:00
2019-12-24 07:02:16 +00:00
public override IBeatmapConverter CreateBeatmapConverter ( IBeatmap beatmap ) = > new TestBeatmapConverter ( beatmap , null ) ;
2019-08-26 07:31:46 +00:00
public override DifficultyCalculator CreateDifficultyCalculator ( WorkingBeatmap beatmap ) = > throw new NotImplementedException ( ) ;
public override string Description { get ; } = string . Empty ;
public override string ShortName { get ; } = string . Empty ;
}
private class TestDrawableScrollingRuleset : DrawableScrollingRuleset < TestHitObject >
{
public bool RelativeScaleBeatLengthsOverride { get ; set ; }
protected override bool RelativeScaleBeatLengths = > RelativeScaleBeatLengthsOverride ;
protected override ScrollVisualisationMethod VisualisationMethod = > ScrollVisualisationMethod . Overlapping ;
2019-09-24 07:49:42 +00:00
public new Bindable < double > TimeRange = > base . TimeRange ;
2019-12-12 06:58:11 +00:00
public TestDrawableScrollingRuleset ( Ruleset ruleset , IBeatmap beatmap , IReadOnlyList < Mod > mods = null )
2019-08-26 07:31:46 +00:00
: base ( ruleset , beatmap , mods )
{
TimeRange . Value = time_range ;
}
public override DrawableHitObject < TestHitObject > CreateDrawableRepresentation ( TestHitObject h ) = > new DrawableTestHitObject ( h ) ;
protected override PassThroughInputManager CreateInputManager ( ) = > new PassThroughInputManager ( ) ;
protected override Playfield CreatePlayfield ( ) = > new TestPlayfield ( ) ;
}
private class TestPlayfield : ScrollingPlayfield
{
public TestPlayfield ( )
{
AddInternal ( new Container
{
RelativeSizeAxes = Axes . Both ,
Children = new Drawable [ ]
{
new Box
{
RelativeSizeAxes = Axes . Both ,
Alpha = 0.2f ,
} ,
new Container
{
RelativeSizeAxes = Axes . Both ,
Padding = new MarginPadding { Top = 150 } ,
Children = new Drawable [ ]
{
new Box
{
Anchor = Anchor . TopCentre ,
Origin = Anchor . Centre ,
RelativeSizeAxes = Axes . X ,
Height = 2 ,
Colour = Color4 . Green
} ,
HitObjectContainer
}
}
}
} ) ;
}
}
private class TestBeatmapConverter : BeatmapConverter < TestHitObject >
{
2019-12-24 07:02:16 +00:00
public TestBeatmapConverter ( IBeatmap beatmap , Ruleset ruleset )
: base ( beatmap , ruleset )
2019-08-26 07:31:46 +00:00
{
}
2019-12-23 08:44:18 +00:00
public override bool CanConvert ( ) = > true ;
2019-08-26 07:31:46 +00:00
2020-09-17 08:40:05 +00:00
protected override IEnumerable < TestHitObject > ConvertHitObject ( HitObject original , IBeatmap beatmap , CancellationToken cancellationToken )
2019-08-26 07:31:46 +00:00
{
yield return new TestHitObject
{
StartTime = original . StartTime ,
2020-05-27 03:38:39 +00:00
Duration = ( original as IHasDuration ) ? . Duration ? ? 100
2019-08-26 07:31:46 +00:00
} ;
}
}
#endregion
#region HitObject
2020-05-27 03:38:39 +00:00
private class TestHitObject : ConvertHitObject , IHasDuration
2019-08-26 07:31:46 +00:00
{
2020-05-27 03:37:44 +00:00
public double EndTime = > StartTime + Duration ;
2019-08-26 07:31:46 +00:00
2020-05-27 03:37:44 +00:00
public double Duration { get ; set ; }
2019-08-26 07:31:46 +00:00
}
private class DrawableTestHitObject : DrawableHitObject < TestHitObject >
{
public DrawableTestHitObject ( TestHitObject hitObject )
: base ( hitObject )
{
Anchor = Anchor . TopCentre ;
Origin = Anchor . TopCentre ;
Size = new Vector2 ( 100 , 25 ) ;
AddRangeInternal ( new Drawable [ ]
{
new Box
{
RelativeSizeAxes = Axes . Both ,
Colour = Color4 . LightPink
} ,
new Box
{
Origin = Anchor . CentreLeft ,
RelativeSizeAxes = Axes . X ,
Height = 2 ,
Colour = Color4 . Red
}
} ) ;
}
}
#endregion
}
}