2019-01-24 16:43:03 +08: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.
|
2018-09-19 02:23:25 +08:00
|
|
|
|
|
2022-06-17 15:37:17 +08:00
|
|
|
|
#nullable disable
|
|
|
|
|
|
|
2018-11-02 18:52:40 +08:00
|
|
|
|
namespace osu.Game.Rulesets.UI.Scrolling.Algorithms
|
2018-09-19 02:23:25 +08:00
|
|
|
|
{
|
2018-11-02 18:51:34 +08:00
|
|
|
|
public class ConstantScrollAlgorithm : IScrollAlgorithm
|
2018-09-19 02:23:25 +08:00
|
|
|
|
{
|
Fix lifetime calculation in overlapping algorithm
Changes to lifetime calculation in scrolling rulesets introduced in
#7367, which aimed to account for the distance between hit objects'
origin and its edge entering the scrolling area, fixed some issues with
hitobjects appearing abruptly, but also regressed some other scenarios.
Upon investigation, the regression was localised to the overlapping
scroll algorithm. The reason for this was two-fold:
* The previous code used TimeAt() to calculate the time of travel from
the hit object's edge to its origin. For other algorithms, that time
can be accurately reconstructed, because they don't have periods of
time where there are multiple hit objects scrolling at different
velocities.
That invariant does not hold for the overlapping algorithm, therefore
it is possible for different values to be technically correct for
TimeAt(). However, the only value that matters for the adjustment
is the one that's indicated by the control point that applies to the
hit object origin, which can be uniquely identified.
* Additionally, the offset returned (even if correct) was applied
externally to the hit object's start time and passed to
GetDisplayStartTime(). In the overlapping algorithm, the choice of
control point used in GetDisplayStartTime() is important, since
the value of the speed multiplier is read within.
Externally rewinding the hit object's start time meant that in some
cases the speed multiplier of the *previous* control point is applied,
which led to hit objects appearing too late if the scrolling rate
decreased.
Because of the above, modify GetDisplayStartTime() to take the offset
into account in all algorithms, and apply the adjustment correctly
inside of them. The constant and sequential algorithms needed no
adjustment from the previous logic, since:
* the constant algorithm disregarded control points, and
* the sequential algorithm would effectively rewind to time = 0,
calculate the absolute distance from time = 0 to the hit object start,
apply the origin offset *to the absolute distance*, and then convert
back to time, applying all control points in sequence. Due to this
it was impossible for control points to get mixed up while
calculating.
As for the overlapping algorithm, the high-level logic is as follows:
* The distance that the origin has to travel is the length of the scroll
plus the distance from the origin to the object edge.
* The above distance divided by the scroll length gives the relative
scroll lengths that the object has to travel.
* As one relative scroll length takes one time range, the relative
travel length multiplied by the time range gives the absolute travel
time of the object origin.
* Finally, the control point multiplier applicable at origin time is
applied to the whole travel time.
Correctness of the above is demonstrated by visual tests added before
and headless unit tests of the algorithms themselves. The sequential
scroll algorithm was not covered by unit tests, and remains uncovered
due to floating-point inaccuracies that should be addressed separately.
2020-02-07 05:46:31 +08:00
|
|
|
|
public double GetDisplayStartTime(double originTime, float offset, double timeRange, float scrollLength)
|
|
|
|
|
|
{
|
2021-10-27 12:04:41 +08:00
|
|
|
|
double adjustedTime = TimeAt(-offset, originTime, timeRange, scrollLength);
|
Fix lifetime calculation in overlapping algorithm
Changes to lifetime calculation in scrolling rulesets introduced in
#7367, which aimed to account for the distance between hit objects'
origin and its edge entering the scrolling area, fixed some issues with
hitobjects appearing abruptly, but also regressed some other scenarios.
Upon investigation, the regression was localised to the overlapping
scroll algorithm. The reason for this was two-fold:
* The previous code used TimeAt() to calculate the time of travel from
the hit object's edge to its origin. For other algorithms, that time
can be accurately reconstructed, because they don't have periods of
time where there are multiple hit objects scrolling at different
velocities.
That invariant does not hold for the overlapping algorithm, therefore
it is possible for different values to be technically correct for
TimeAt(). However, the only value that matters for the adjustment
is the one that's indicated by the control point that applies to the
hit object origin, which can be uniquely identified.
* Additionally, the offset returned (even if correct) was applied
externally to the hit object's start time and passed to
GetDisplayStartTime(). In the overlapping algorithm, the choice of
control point used in GetDisplayStartTime() is important, since
the value of the speed multiplier is read within.
Externally rewinding the hit object's start time meant that in some
cases the speed multiplier of the *previous* control point is applied,
which led to hit objects appearing too late if the scrolling rate
decreased.
Because of the above, modify GetDisplayStartTime() to take the offset
into account in all algorithms, and apply the adjustment correctly
inside of them. The constant and sequential algorithms needed no
adjustment from the previous logic, since:
* the constant algorithm disregarded control points, and
* the sequential algorithm would effectively rewind to time = 0,
calculate the absolute distance from time = 0 to the hit object start,
apply the origin offset *to the absolute distance*, and then convert
back to time, applying all control points in sequence. Due to this
it was impossible for control points to get mixed up while
calculating.
As for the overlapping algorithm, the high-level logic is as follows:
* The distance that the origin has to travel is the length of the scroll
plus the distance from the origin to the object edge.
* The above distance divided by the scroll length gives the relative
scroll lengths that the object has to travel.
* As one relative scroll length takes one time range, the relative
travel length multiplied by the time range gives the absolute travel
time of the object origin.
* Finally, the control point multiplier applicable at origin time is
applied to the whole travel time.
Correctness of the above is demonstrated by visual tests added before
and headless unit tests of the algorithms themselves. The sequential
scroll algorithm was not covered by unit tests, and remains uncovered
due to floating-point inaccuracies that should be addressed separately.
2020-02-07 05:46:31 +08:00
|
|
|
|
return adjustedTime - timeRange;
|
|
|
|
|
|
}
|
2018-09-19 02:23:25 +08:00
|
|
|
|
|
2018-10-30 17:33:24 +08:00
|
|
|
|
public float GetLength(double startTime, double endTime, double timeRange, float scrollLength)
|
2018-09-19 02:23:25 +08:00
|
|
|
|
{
|
2018-10-30 17:33:24 +08:00
|
|
|
|
// At the hitobject's end time, the hitobject will be positioned such that its end rests at the origin.
|
|
|
|
|
|
// This results in a negative-position value, and the absolute of it indicates the length of the hitobject.
|
|
|
|
|
|
return -PositionAt(startTime, endTime, timeRange, scrollLength);
|
2018-09-19 02:23:25 +08:00
|
|
|
|
}
|
2018-10-30 16:31:43 +08:00
|
|
|
|
|
2018-10-30 17:33:24 +08:00
|
|
|
|
public float PositionAt(double time, double currentTime, double timeRange, float scrollLength)
|
|
|
|
|
|
=> (float)((time - currentTime) / timeRange * scrollLength);
|
2018-10-30 16:31:43 +08:00
|
|
|
|
|
2018-11-09 18:55:48 +08:00
|
|
|
|
public double TimeAt(float position, double currentTime, double timeRange, float scrollLength)
|
|
|
|
|
|
=> position * timeRange / scrollLength + currentTime;
|
|
|
|
|
|
|
2018-10-30 17:33:24 +08:00
|
|
|
|
public void Reset()
|
2018-10-30 16:31:43 +08:00
|
|
|
|
{
|
|
|
|
|
|
}
|
2018-09-19 02:23:25 +08:00
|
|
|
|
}
|
|
|
|
|
|
}
|
