CaughtObject.cs

// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System;
using osu.Framework.Allocation;
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Game.Skinning;
using osuTK;
using osuTK.Graphics;

namespace osu.Game.Rulesets.Catch.Objects.Drawables
{
    /// <summary>
    /// Represents a <see cref="PalpableCatchHitObject"/> caught by the catcher.
    /// </summary>
    [Cached(typeof(IHasCatchObjectState))]
    public abstract partial class CaughtObject : SkinnableDrawable, IHasCatchObjectState
    {
        public PalpableCatchHitObject HitObject { get; private set; } = null!;
        public Bindable<Color4> AccentColour { get; } = new Bindable<Color4>();
        public Bindable<bool> HyperDash { get; } = new Bindable<bool>();
        public Bindable<int> IndexInBeatmap { get; } = new Bindable<int>();
        public Vector2 DisplayPosition => DrawPosition;
        public Vector2 DisplaySize => Size * Scale;
        public float DisplayRotation => Rotation;
        public double DisplayStartTime => HitObject.StartTime;

        /// <summary>
        /// Whether this hit object should stay on the catcher plate when the object is caught by the catcher.
        /// </summary>
        public virtual bool StaysOnPlate => true;

        public override bool RemoveWhenNotAlive => true;

        protected CaughtObject(CatchSkinComponents skinComponent, Func<ISkinComponentLookup, Drawable> defaultImplementation)
            : base(new CatchSkinComponentLookup(skinComponent), defaultImplementation)
        {
            Origin = Anchor.Centre;

            RelativeSizeAxes = Axes.None;
            Size = new Vector2(CatchHitObject.OBJECT_RADIUS * 2);
        }

        protected override void FreeAfterUse()
        {
            ClearTransforms();
            Alpha = 1;

            base.FreeAfterUse();
        }

        public void RestoreState(CatchObjectState state)
        {
            HitObject = state.HitObject;
            AccentColour.Value = state.AccentColour;
            HyperDash.Value = state.HyperDash;
            IndexInBeatmap.Value = state.IndexInBeatmap;
            Position = state.DisplayPosition;
            Scale = Vector2.Divide(state.DisplaySize, Size);
            Rotation = state.DisplayRotation;
        }
    }
}