DrawableOsuHitObject.cs

// 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.

#nullable disable

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using osu.Framework.Allocation;
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Primitives;
using osu.Game.Rulesets.Judgements;
using osu.Game.Rulesets.Objects.Drawables;
using osu.Game.Rulesets.Osu.Judgements;
using osu.Game.Rulesets.Osu.Scoring;
using osu.Game.Rulesets.Osu.UI;
using osu.Game.Rulesets.Scoring;
using osuTK;
using osuTK.Graphics;

namespace osu.Game.Rulesets.Osu.Objects.Drawables
{
    public abstract partial class DrawableOsuHitObject : DrawableHitObject<OsuHitObject>
    {
        public readonly IBindable<Vector2> PositionBindable = new Bindable<Vector2>();
        public readonly IBindable<int> StackHeightBindable = new Bindable<int>();
        public readonly IBindable<float> ScaleBindable = new BindableFloat();
        public readonly IBindable<int> IndexInCurrentComboBindable = new Bindable<int>();

        // Must be set to update IsHovered as it's used in relax mod to detect osu hit objects.
        public override bool HandlePositionalInput => true;

        protected override float SamplePlaybackPosition => CalculateDrawableRelativePosition(this);

        /// <summary>
        /// What action this <see cref="DrawableOsuHitObject"/> should take in response to a
        /// click at the given time value.
        /// If non-null, judgements will be ignored for return values of <see cref="ClickAction.Ignore"/>
        /// and <see cref="ClickAction.Shake"/>, and this hit object will be shaken for return values of
        /// <see cref="ClickAction.Shake"/>.
        /// </summary>
        public Func<DrawableHitObject, double, HitResult, ClickAction> CheckHittable;

        protected DrawableOsuHitObject(OsuHitObject hitObject)
            : base(hitObject)
        {
        }

        [BackgroundDependencyLoader]
        private void load()
        {
            Alpha = 0;
        }

        protected override void OnApply()
        {
            base.OnApply();

            IndexInCurrentComboBindable.BindTo(HitObject.IndexInCurrentComboBindable);
            PositionBindable.BindTo(HitObject.PositionBindable);
            StackHeightBindable.BindTo(HitObject.StackHeightBindable);
            ScaleBindable.BindTo(HitObject.ScaleBindable);
        }

        protected override void OnFree()
        {
            base.OnFree();

            IndexInCurrentComboBindable.UnbindFrom(HitObject.IndexInCurrentComboBindable);
            PositionBindable.UnbindFrom(HitObject.PositionBindable);
            StackHeightBindable.UnbindFrom(HitObject.StackHeightBindable);
            ScaleBindable.UnbindFrom(HitObject.ScaleBindable);
        }

        protected virtual IEnumerable<Drawable> DimmablePieces => [];

        protected override void UpdateInitialTransforms()
        {
            base.UpdateInitialTransforms();

            foreach (var piece in DimmablePieces)
            {
                // if the specified dimmable piece is a DHO, it is generally not safe to tack transforms onto it directly
                // as they may be cleared via the `updateState()` DHO flow,
                // so use `ApplyCustomUpdateState` instead. which does not have this pitfall.
                if (piece is DrawableHitObject drawableObjectPiece)
                {
                    // this method can be called multiple times, and we don't want to subscribe to the event more than once,
                    // so this is what it is going to have to be...
                    drawableObjectPiece.ApplyCustomUpdateState -= applyDimToDrawableHitObject;
                    drawableObjectPiece.ApplyCustomUpdateState += applyDimToDrawableHitObject;
                }

                // but at the end apply the transforms now regardless of whether this is a DHO or not.
                // the above is just to ensure they don't get overwritten later.
                applyDim(piece);
            }
        }

        protected override void ClearNestedHitObjects()
        {
            base.ClearNestedHitObjects();

            // any dimmable pieces that are DHOs will be pooled separately.
            // `applyDimToDrawableHitObject` is a closure that implicitly captures `this`,
            // and because of separate pooling of parent and child objects, there is no guarantee that the pieces will be associated with `this` again on re-use.
            // therefore, clean up the subscription here to avoid crosstalk.
            // not doing so can result in the callback attempting to read things from `this` when it is in a completely bogus state (not in use or similar).
            foreach (var piece in DimmablePieces)
            {
                if (piece is DrawableHitObject dho)
                    dho.ApplyCustomUpdateState -= applyDimToDrawableHitObject;
            }
        }

        private void applyDim(Drawable piece)
        {
            piece.FadeColour(new Color4(195, 195, 195, 255));
            using (piece.BeginDelayedSequence(InitialLifetimeOffset - OsuHitWindows.MISS_WINDOW))
                piece.FadeColour(Color4.White, 100);
        }

        private void applyDimToDrawableHitObject(DrawableHitObject dho, ArmedState _) => applyDim(dho);

        protected sealed override double InitialLifetimeOffset => HitObject.TimePreempt;

        internal OsuInputManager OsuActionInputManager => field ??= GetContainingInputManager() as OsuInputManager;

        /// <summary>
        /// Shake the hit object in case it was clicked far too early or late (aka "note lock").
        /// </summary>
        public virtual void Shake() { }

        /// <summary>
        /// Causes this <see cref="DrawableOsuHitObject"/> to get hit, disregarding all conditions in implementations of <see cref="DrawableHitObject.CheckForResult"/>.
        /// </summary>
        public void HitForcefully() => ApplyMaxResult();

        /// <summary>
        /// Causes this <see cref="DrawableOsuHitObject"/> to get missed, disregarding all conditions in implementations of <see cref="DrawableHitObject.CheckForResult"/>.
        /// </summary>
        public void MissForcefully() => ApplyMinResult();

        // ReSharper disable once FunctionRecursiveOnAllPaths (TODO: remove after fixed https://youtrack.jetbrains.com/issue/RIDER-135036/Incorrect-recursive-on-all-execution-paths-inspection)
        private RectangleF parentScreenSpaceRectangle => ((DrawableOsuHitObject)ParentHitObject)?.parentScreenSpaceRectangle ?? Parent!.ScreenSpaceDrawQuad.AABBFloat;

        /// <summary>
        /// Calculates the position of the given <paramref name="drawable"/> relative to the playfield area.
        /// </summary>
        /// <param name="drawable">The drawable to calculate its relative position.</param>
        protected float CalculateDrawableRelativePosition(Drawable drawable) => (drawable.ScreenSpaceDrawQuad.Centre.X - parentScreenSpaceRectangle.X) / parentScreenSpaceRectangle.Width;

        protected override JudgementResult CreateResult(Judgement judgement) => new OsuJudgementResult(HitObject, judgement);

        protected void ApplyRepeatFadeIn(Drawable target, double fadeTime)
        {
            DrawableSlider slider = (DrawableSlider)ParentHitObject;
            int repeatIndex = ((SliderEndCircle)HitObject).RepeatIndex;

            Debug.Assert(slider != null);

            // When snaking in is enabled, the first end circle needs to be delayed until the snaking completes.
            bool delayFadeIn = slider.SliderBody?.SnakingIn.Value == true && repeatIndex == 0;

            if (repeatIndex > 0)
                fadeTime = Math.Min(slider.HitObject.SpanDuration, fadeTime);

            target
                .FadeOut()
                .Delay(delayFadeIn ? (slider.HitObject.TimePreempt) / 3 : 0)
                .FadeIn(fadeTime);
        }
    }
}