// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. using System; using System.Collections.Generic; using osuTK; namespace osu.Game.Rulesets.Objects { public static class SliderEventGenerator { public static IEnumerable Generate(double startTime, double spanDuration, double velocity, double tickDistance, double totalDistance, int spanCount, double? legacyLastTickOffset) { // A very lenient maximum length of a slider for ticks to be generated. // This exists for edge cases such as /b/1573664 where the beatmap has been edited by the user, and should never be reached in normal usage. const double max_length = 100000; var length = Math.Min(max_length, totalDistance); tickDistance = MathHelper.Clamp(tickDistance, 0, length); var minDistanceFromEnd = velocity * 10; yield return new SliderEventDescriptor { Type = SliderEventType.Head, SpanIndex = 0, SpanStartTime = startTime, Time = startTime, PathProgress = 0, }; if (tickDistance != 0) { for (var span = 0; span < spanCount; span++) { var spanStartTime = startTime + span * spanDuration; var reversed = span % 2 == 1; for (var d = tickDistance; d <= length; d += tickDistance) { if (d > length - minDistanceFromEnd) break; var pathProgress = d / length; var timeProgress = reversed ? 1 - pathProgress : pathProgress; yield return new SliderEventDescriptor { Type = SliderEventType.Tick, SpanIndex = span, SpanStartTime = spanStartTime, Time = spanStartTime + timeProgress * spanDuration, PathProgress = pathProgress, }; } if (span < spanCount - 1) { yield return new SliderEventDescriptor { Type = SliderEventType.Repeat, SpanIndex = span, SpanStartTime = startTime + span * spanDuration, Time = spanStartTime + spanDuration, PathProgress = (span + 1) % 2, }; } } } double totalDuration = spanCount * spanDuration; // Okay, I'll level with you. I made a mistake. It was 2007. // Times were simpler. osu! was but in its infancy and sliders were a new concept. // A hack was made, which has unfortunately lived through until this day. // // This legacy tick is used for some calculations and judgements where audio output is not required. // Generally we are keeping this around just for difficulty compatibility. // Optimistically we do not want to ever use this for anything user-facing going forwards. int finalSpanIndex = spanCount - 1; double finalSpanStartTime = startTime + finalSpanIndex * spanDuration; double finalSpanEndTime = Math.Max(startTime + totalDuration / 2, (finalSpanStartTime + spanDuration) - (legacyLastTickOffset ?? 0)); double finalProgress = (finalSpanEndTime - finalSpanStartTime) / spanDuration; if (spanCount % 2 == 0) finalProgress = 1 - finalProgress; yield return new SliderEventDescriptor { Type = SliderEventType.LegacyLastTick, SpanIndex = finalSpanIndex, SpanStartTime = finalSpanStartTime, Time = finalSpanEndTime, PathProgress = finalProgress, }; yield return new SliderEventDescriptor { Type = SliderEventType.Tail, SpanIndex = finalSpanIndex, SpanStartTime = startTime + (spanCount - 1) * spanDuration, Time = startTime + totalDuration, PathProgress = spanCount % 2, }; } } /// /// Describes a point in time on a slider given special meaning. /// Should be used by rulesets to visualise the slider. /// public struct SliderEventDescriptor { /// /// The type of event. /// public SliderEventType Type; /// /// The time of this event. /// public double Time; /// /// The zero-based index of the span. In the case of repeat sliders, this will increase after each . /// public int SpanIndex; /// /// The time at which the contained begins. /// public double SpanStartTime; /// /// The progress along the slider's at which this event occurs. /// public double PathProgress; } public enum SliderEventType { Tick, LegacyLastTick, Head, Tail, Repeat } }