osu/osu.Game/Skinning/SkinReloadableDrawable.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.

using System;
using osu.Framework.Allocation;
using osu.Framework.Extensions.ObjectExtensions;
using osu.Framework.Graphics.Pooling;
using osu.Framework.Threading;

namespace osu.Game.Skinning
{
    /// <summary>
    /// A poolable drawable implementation which has a pre-wired callback (see <see cref="SkinChanged"/>) that fires
    /// once on load and again on any subsequent skin change.
    /// </summary>
    public abstract partial class SkinReloadableDrawable : PoolableDrawable
    {
        private ScheduledDelegate? pendingSkinChange;

        /// <summary>
        /// Invoked when <see cref="CurrentSkin"/> has changed.
        /// </summary>
        public event Action? OnSkinChanged;

        /// <summary>
        /// The current skin source.
        /// </summary>
        protected ISkinSource CurrentSkin { get; private set; } = null!;

        [BackgroundDependencyLoader]
        private void load(ISkinSource source)
        {
            CurrentSkin = source;
            CurrentSkin.SourceChanged += onChange;
        }

        protected override void LoadAsyncComplete()
        {
            base.LoadAsyncComplete();
            skinChanged();
        }

        /// <summary>
        /// Force any pending <see cref="SkinChanged"/> calls to be performed immediately.
        /// </summary>
        /// <remarks>
        /// When a skin change occurs, the handling provided by this class is scheduled.
        /// In some cases, such a sample playback, this can result in the sample being played
        /// just before it is updated to a potentially different sample.
        ///
        /// Calling this method will ensure any pending update operations are run immediately.
        /// It is recommended to call this before consuming the result of skin changes for anything non-drawable.
        /// </remarks>
        protected void FlushPendingSkinChanges()
        {
            if (pendingSkinChange == null)
                return;

            pendingSkinChange.RunTask();
            pendingSkinChange = null;
        }

        /// <summary>
        /// Called when a change is made to the skin.
        /// </summary>
        /// <param name="skin">The new skin.</param>
        protected virtual void SkinChanged(ISkinSource skin)
        {
        }

        private void onChange()
        {
            // schedule required to avoid calls after disposed.
            // note that this has the side-effect of components only performing a skin change when they are alive.
            pendingSkinChange?.Cancel();
            pendingSkinChange = Scheduler.Add(skinChanged);
        }

        private void skinChanged()
        {
            SkinChanged(CurrentSkin);
            OnSkinChanged?.Invoke();

            pendingSkinChange = null;
        }

        protected override void Dispose(bool isDisposing)
        {
            base.Dispose(isDisposing);

            if (CurrentSkin.IsNotNull())
                CurrentSkin.SourceChanged -= onChange;

            OnSkinChanged = null;
        }
    }
}