Merge pull request #11169 from ekrctb/catch-x

Split `X` property of `CatchHitObject` to `OriginalX` and `EffectiveX`

osu.Game.Rulesets.Catch.Tests/CatchBeatmapConversionTest.cs

@@ -84,7 +84,7 @@ namespace osu.Game.Rulesets.Catch.Tests
 
         public float Position
         {
-            get => HitObject?.X ?? position;
+            get => HitObject?.EffectiveX ?? position;
             set => position = value;
         }
 

osu.Game.Rulesets.Catch.Tests/TestSceneCatcherArea.cs

@@ -44,7 +44,7 @@ namespace osu.Game.Rulesets.Catch.Tests
 
         private void attemptCatch(Fruit fruit)
         {
-            fruit.X += catcher.X;
+            fruit.X = fruit.OriginalX + catcher.X;
             fruit.ApplyDefaults(new ControlPointInfo(), new BeatmapDifficulty
             {
                 CircleSize = circleSize

osu.Game.Rulesets.Catch/Beatmaps/CatchBeatmapProcessor.cs

@@ -75,7 +75,7 @@ namespace osu.Game.Rulesets.Catch.Beatmaps
 
                     case JuiceStream juiceStream:
                         // Todo: BUG!! Stable used the last control point as the final position of the path, but it should use the computed path instead.
-                        lastPosition = juiceStream.X + juiceStream.Path.ControlPoints[^1].Position.Value.X;
+                        lastPosition = juiceStream.OriginalX + juiceStream.Path.ControlPoints[^1].Position.Value.X;
 
                         // Todo: BUG!! Stable attempted to use the end time of the stream, but referenced it too early in execution and used the start time instead.
                         lastStartTime = juiceStream.StartTime;
@@ -86,7 +86,7 @@ namespace osu.Game.Rulesets.Catch.Beatmaps
                             catchObject.XOffset = 0;
 
                             if (catchObject is TinyDroplet)
-                                catchObject.XOffset = Math.Clamp(rng.Next(-20, 20), -catchObject.X, CatchPlayfield.WIDTH - catchObject.X);
+                                catchObject.XOffset = Math.Clamp(rng.Next(-20, 20), -catchObject.OriginalX, CatchPlayfield.WIDTH - catchObject.OriginalX);
                             else if (catchObject is Droplet)
                                 rng.Next(); // osu!stable retrieved a random droplet rotation
                         }
@@ -100,7 +100,7 @@ namespace osu.Game.Rulesets.Catch.Beatmaps
 
         private static void applyHardRockOffset(CatchHitObject hitObject, ref float? lastPosition, ref double lastStartTime, FastRandom rng)
         {
-            float offsetPosition = hitObject.X;
+            float offsetPosition = hitObject.OriginalX;
             double startTime = hitObject.StartTime;
 
             if (lastPosition == null)
@@ -126,7 +126,7 @@ namespace osu.Game.Rulesets.Catch.Beatmaps
             if (positionDiff == 0)
             {
                 applyRandomOffset(ref offsetPosition, timeDiff / 4d, rng);
-                hitObject.XOffset = offsetPosition - hitObject.X;
+                hitObject.XOffset = offsetPosition - hitObject.OriginalX;
                 return;
             }
 
@@ -134,7 +134,7 @@ namespace osu.Game.Rulesets.Catch.Beatmaps
             if (Math.Abs(positionDiff) < timeDiff / 3)
                 applyOffset(ref offsetPosition, positionDiff);
 
-            hitObject.XOffset = offsetPosition - hitObject.X;
+            hitObject.XOffset = offsetPosition - hitObject.OriginalX;
 
             lastPosition = offsetPosition;
             lastStartTime = startTime;
@@ -230,9 +230,9 @@ namespace osu.Game.Rulesets.Catch.Beatmaps
                 currentObject.HyperDashTarget = null;
                 currentObject.DistanceToHyperDash = 0;
 
-                int thisDirection = nextObject.X > currentObject.X ? 1 : -1;
+                int thisDirection = nextObject.EffectiveX > currentObject.EffectiveX ? 1 : -1;
                 double timeToNext = nextObject.StartTime - currentObject.StartTime - 1000f / 60f / 4; // 1/4th of a frame of grace time, taken from osu-stable
-                double distanceToNext = Math.Abs(nextObject.X - currentObject.X) - (lastDirection == thisDirection ? lastExcess : halfCatcherWidth);
+                double distanceToNext = Math.Abs(nextObject.EffectiveX - currentObject.EffectiveX) - (lastDirection == thisDirection ? lastExcess : halfCatcherWidth);
                 float distanceToHyper = (float)(timeToNext * Catcher.BASE_SPEED - distanceToNext);
 
                 if (distanceToHyper < 0)

osu.Game.Rulesets.Catch/Difficulty/Preprocessing/CatchDifficultyHitObject.cs

@@ -32,8 +32,8 @@ namespace osu.Game.Rulesets.Catch.Difficulty.Preprocessing
             // We will scale everything by this factor, so we can assume a uniform CircleSize among beatmaps.
             var scalingFactor = normalized_hitobject_radius / halfCatcherWidth;
 
-            NormalizedPosition = BaseObject.X * scalingFactor;
+            NormalizedPosition = BaseObject.EffectiveX * scalingFactor;
-            LastNormalizedPosition = LastObject.X * scalingFactor;
+            LastNormalizedPosition = LastObject.EffectiveX * scalingFactor;
 
             // Every strain interval is hard capped at the equivalent of 375 BPM streaming speed as a safety measure
             StrainTime = Math.Max(40, DeltaTime);

osu.Game.Rulesets.Catch/Objects/CatchHitObject.cs

@@ -4,7 +4,6 @@
 using osu.Framework.Bindables;
 using osu.Game.Beatmaps;
 using osu.Game.Beatmaps.ControlPoints;
-using osu.Game.Rulesets.Catch.Beatmaps;
 using osu.Game.Rulesets.Catch.UI;
 using osu.Game.Rulesets.Objects;
 using osu.Game.Rulesets.Objects.Types;
@@ -16,38 +15,46 @@ namespace osu.Game.Rulesets.Catch.Objects
     {
         public const float OBJECT_RADIUS = 64;
 
-        // This value is after XOffset applied.
+        public readonly Bindable<float> OriginalXBindable = new Bindable<float>();
-        public readonly Bindable<float> XBindable = new Bindable<float>();
-
-        // This value is before XOffset applied.
-        private float originalX;
 
         /// <summary>
-        /// The horizontal position of the fruit between 0 and <see cref="CatchPlayfield.WIDTH"/>.
+        /// The horizontal position of the hit object between 0 and <see cref="CatchPlayfield.WIDTH"/>.
         /// </summary>
         public float X
         {
-            // TODO: I don't like this asymmetry.
+            set => OriginalXBindable.Value = value;
-            get => XBindable.Value;
-            // originalX is set by `XBindable.BindValueChanged`
-            set => XBindable.Value = value + xOffset;
         }
 
-        private float xOffset;
+        float IHasXPosition.X => OriginalXBindable.Value;
+
+        public readonly Bindable<float> XOffsetBindable = new Bindable<float>();
 
         /// <summary>
-        /// A random offset applied to <see cref="X"/>, set by the <see cref="CatchBeatmapProcessor"/>.
+        /// A random offset applied to the horizontal position, set by the beatmap processing.
         /// </summary>
-        internal float XOffset
+        public float XOffset
         {
-            get => xOffset;
+            set => XOffsetBindable.Value = value;
-            set
-            {
-                xOffset = value;
-                XBindable.Value = originalX + xOffset;
-            }
         }
 
+        /// <summary>
+        /// The horizontal position of the hit object between 0 and <see cref="CatchPlayfield.WIDTH"/>.
+        /// </summary>
+        /// <remarks>
+        /// This value is the original <see cref="X"/> value specified in the beatmap, not affected by the beatmap processing.
+        /// Use <see cref="EffectiveX"/> for a gameplay.
+        /// </remarks>
+        public float OriginalX => OriginalXBindable.Value;
+
+        /// <summary>
+        /// The effective horizontal position of the hit object between 0 and <see cref="CatchPlayfield.WIDTH"/>.
+        /// </summary>
+        /// <remarks>
+        /// This value is the original <see cref="X"/> value plus the offset applied by the beatmap processing.
+        /// Use <see cref="OriginalX"/> if a value not affected by the offset is desired.
+        /// </remarks>
+        public float EffectiveX => OriginalXBindable.Value + XOffsetBindable.Value;
+
         public double TimePreempt = 1000;
 
         public readonly Bindable<int> IndexInBeatmapBindable = new Bindable<int>();
@@ -113,10 +120,5 @@ namespace osu.Game.Rulesets.Catch.Objects
         }
 
         protected override HitWindows CreateHitWindows() => HitWindows.Empty;
-
-        protected CatchHitObject()
-        {
-            XBindable.BindValueChanged(x => originalX = x.NewValue - xOffset);
-        }
     }
 }

osu.Game.Rulesets.Catch/Objects/Drawables/DrawableCatchHitObject.cs

@@ -15,11 +15,12 @@ namespace osu.Game.Rulesets.Catch.Objects.Drawables
 {
     public abstract class DrawableCatchHitObject : DrawableHitObject<CatchHitObject>
     {
-        public readonly Bindable<float> XBindable = new Bindable<float>();
+        public readonly Bindable<float> OriginalXBindable = new Bindable<float>();
+        public readonly Bindable<float> XOffsetBindable = new Bindable<float>();
 
         protected override double InitialLifetimeOffset => HitObject.TimePreempt;
 
-        protected override float SamplePlaybackPosition => HitObject.X / CatchPlayfield.WIDTH;
+        protected override float SamplePlaybackPosition => HitObject.EffectiveX / CatchPlayfield.WIDTH;
 
         public int RandomSeed => HitObject?.RandomSeed ?? 0;
 
@@ -38,14 +39,16 @@ namespace osu.Game.Rulesets.Catch.Objects.Drawables
         {
             base.OnApply();
 
-            XBindable.BindTo(HitObject.XBindable);
+            OriginalXBindable.BindTo(HitObject.OriginalXBindable);
+            XOffsetBindable.BindTo(HitObject.XOffsetBindable);
         }
 
         protected override void OnFree()
         {
             base.OnFree();
 
-            XBindable.UnbindFrom(HitObject.XBindable);
+            OriginalXBindable.UnbindFrom(HitObject.OriginalXBindable);
+            XOffsetBindable.UnbindFrom(HitObject.XOffsetBindable);
         }
 
         public Func<CatchHitObject, bool> CheckPosition;

osu.Game.Rulesets.Catch/Objects/Drawables/DrawablePalpableCatchHitObject.cs

@@ -55,10 +55,8 @@ namespace osu.Game.Rulesets.Catch.Objects.Drawables
         [BackgroundDependencyLoader]
         private void load()
         {
-            XBindable.BindValueChanged(x =>
+            OriginalXBindable.BindValueChanged(updateXPosition);
-            {
+            XOffsetBindable.BindValueChanged(updateXPosition, true);
-                X = x.NewValue;
-            }, true);
 
             ScaleBindable.BindValueChanged(scale =>
             {
@@ -69,6 +67,11 @@ namespace osu.Game.Rulesets.Catch.Objects.Drawables
             IndexInBeatmap.BindValueChanged(_ => UpdateComboColour());
         }
 
+        private void updateXPosition(ValueChangedEvent<float> _)
+        {
+            X = OriginalXBindable.Value + XOffsetBindable.Value;
+        }
+
         protected override void OnApply()
         {
             base.OnApply();

osu.Game.Rulesets.Catch/Objects/JuiceStream.cs

@@ -75,7 +75,7 @@ namespace osu.Game.Rulesets.Catch.Objects
                             AddNested(new TinyDroplet
                             {
                                 StartTime = t + lastEvent.Value.Time,
-                                X = X + Path.PositionAt(
+                                X = OriginalX + Path.PositionAt(
                                     lastEvent.Value.PathProgress + (t / sinceLastTick) * (e.PathProgress - lastEvent.Value.PathProgress)).X,
                             });
                         }
@@ -93,7 +93,7 @@ namespace osu.Game.Rulesets.Catch.Objects
                         {
                             Samples = dropletSamples,
                             StartTime = e.Time,
-                            X = X + Path.PositionAt(e.PathProgress).X,
+                            X = OriginalX + Path.PositionAt(e.PathProgress).X,
                         });
                         break;
 
@@ -104,14 +104,14 @@ namespace osu.Game.Rulesets.Catch.Objects
                         {
                             Samples = this.GetNodeSamples(nodeIndex++),
                             StartTime = e.Time,
-                            X = X + Path.PositionAt(e.PathProgress).X,
+                            X = OriginalX + Path.PositionAt(e.PathProgress).X,
                         });
                         break;
                 }
             }
         }
 
-        public float EndX => X + this.CurvePositionAt(1).X;
+        public float EndX => OriginalX + this.CurvePositionAt(1).X;
 
         public double Duration
         {

osu.Game.Rulesets.Catch/Replays/CatchAutoGenerator.cs

@@ -42,7 +42,7 @@ namespace osu.Game.Rulesets.Catch.Replays
 
             void moveToNext(PalpableCatchHitObject h)
             {
-                float positionChange = Math.Abs(lastPosition - h.X);
+                float positionChange = Math.Abs(lastPosition - h.EffectiveX);
                 double timeAvailable = h.StartTime - lastTime;
 
                 // So we can either make it there without a dash or not.
@@ -56,7 +56,7 @@ namespace osu.Game.Rulesets.Catch.Replays
                 // todo: get correct catcher size, based on difficulty CS.
                 const float catcher_width_half = CatcherArea.CATCHER_SIZE * 0.3f * 0.5f;
 
-                if (lastPosition - catcher_width_half < h.X && lastPosition + catcher_width_half > h.X)
+                if (lastPosition - catcher_width_half < h.EffectiveX && lastPosition + catcher_width_half > h.EffectiveX)
                 {
                     // we are already in the correct range.
                     lastTime = h.StartTime;
@@ -66,12 +66,12 @@ namespace osu.Game.Rulesets.Catch.Replays
 
                 if (impossibleJump)
                 {
-                    addFrame(h.StartTime, h.X);
+                    addFrame(h.StartTime, h.EffectiveX);
                 }
                 else if (h.HyperDash)
                 {
                     addFrame(h.StartTime - timeAvailable, lastPosition);
-                    addFrame(h.StartTime, h.X);
+                    addFrame(h.StartTime, h.EffectiveX);
                 }
                 else if (dashRequired)
                 {
@@ -80,23 +80,23 @@ namespace osu.Game.Rulesets.Catch.Replays
                     double timeWeNeedToSave = timeAtNormalSpeed - timeAvailable;
                     double timeAtDashSpeed = timeWeNeedToSave / 2;
 
-                    float midPosition = (float)Interpolation.Lerp(lastPosition, h.X, (float)timeAtDashSpeed / timeAvailable);
+                    float midPosition = (float)Interpolation.Lerp(lastPosition, h.EffectiveX, (float)timeAtDashSpeed / timeAvailable);
 
                     // dash movement
                     addFrame(h.StartTime - timeAvailable + 1, lastPosition, true);
                     addFrame(h.StartTime - timeAvailable + timeAtDashSpeed, midPosition);
-                    addFrame(h.StartTime, h.X);
+                    addFrame(h.StartTime, h.EffectiveX);
                 }
                 else
                 {
                     double timeBefore = positionChange / movement_speed;
 
                     addFrame(h.StartTime - timeBefore, lastPosition);
-                    addFrame(h.StartTime, h.X);
+                    addFrame(h.StartTime, h.EffectiveX);
                 }
 
                 lastTime = h.StartTime;
-                lastPosition = h.X;
+                lastPosition = h.EffectiveX;
             }
 
             foreach (var obj in Beatmap.HitObjects)

osu.Game.Rulesets.Catch/UI/Catcher.cs

@@ -216,7 +216,7 @@ namespace osu.Game.Rulesets.Catch.UI
             var halfCatchWidth = catchWidth * 0.5f;
 
             // this stuff wil disappear once we move fruit to non-relative coordinate space in the future.
-            var catchObjectPosition = fruit.X;
+            var catchObjectPosition = fruit.EffectiveX;
             var catcherPosition = Position.X;
 
             return catchObjectPosition >= catcherPosition - halfCatchWidth &&
@@ -250,10 +250,10 @@ namespace osu.Game.Rulesets.Catch.UI
             {
                 var target = hitObject.HyperDashTarget;
                 var timeDifference = target.StartTime - hitObject.StartTime;
-                double positionDifference = target.X - X;
+                double positionDifference = target.EffectiveX - X;
                 var velocity = positionDifference / Math.Max(1.0, timeDifference - 1000.0 / 60.0);
 
-                SetHyperDashState(Math.Abs(velocity), target.X);
+                SetHyperDashState(Math.Abs(velocity), target.EffectiveX);
             }
             else
                 SetHyperDashState();