2019-07-22 03:34:40 +00:00
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
2019-01-24 08:43:03 +00:00
// See the LICENCE file in the repository root for full licence text.
2018-04-13 09:19:50 +00:00
using System ;
using osu.Framework.Allocation ;
using osu.Framework.Graphics.Containers ;
namespace osu.Game.Skinning
{
/// <summary>
/// A drawable which has a callback when the skin changes.
/// </summary>
public abstract class SkinReloadableDrawable : CompositeDrawable
{
private readonly Func < ISkinSource , bool > allowFallback ;
private ISkinSource skin ;
/// <summary>
/// Whether fallback to default skin should be allowed if the custom skin is missing this resource.
/// </summary>
private bool allowDefaultFallback = > allowFallback = = null | | allowFallback . Invoke ( skin ) ;
/// <summary>
/// Create a new <see cref="SkinReloadableDrawable"/>
/// </summary>
/// <param name="allowFallback">A conditional to decide whether to allow fallback to the default implementation if a skinned element is not present.</param>
protected SkinReloadableDrawable ( Func < ISkinSource , bool > allowFallback = null )
{
this . allowFallback = allowFallback ;
}
[BackgroundDependencyLoader]
private void load ( ISkinSource source )
{
skin = source ;
skin . SourceChanged + = onChange ;
}
2019-07-22 03:34:40 +00:00
private void onChange ( ) = >
// schedule required to avoid calls after disposed.
2019-07-29 09:35:22 +00:00
// note that this has the side-effect of components only performing a skin change when they are alive.
2019-07-25 06:59:44 +00:00
Scheduler . AddOnce ( ( ) = > SkinChanged ( skin , allowDefaultFallback ) ) ;
2018-04-13 09:19:50 +00:00
protected override void LoadAsyncComplete ( )
{
base . LoadAsyncComplete ( ) ;
2019-07-22 03:34:40 +00:00
SkinChanged ( skin , allowDefaultFallback ) ;
2018-04-13 09:19:50 +00:00
}
/// <summary>
/// Called when a change is made to the skin.
/// </summary>
/// <param name="skin">The new skin.</param>
/// <param name="allowFallback">Whether fallback to default skin should be allowed if the custom skin is missing this resource.</param>
protected virtual void SkinChanged ( ISkinSource skin , bool allowFallback )
{
}
2018-08-23 05:53:16 +00:00
protected override void Dispose ( bool isDisposing )
{
base . Dispose ( isDisposing ) ;
2018-08-23 06:21:36 +00:00
if ( skin ! = null )
skin . SourceChanged - = onChange ;
2018-08-23 05:53:16 +00:00
}
2018-04-13 09:19:50 +00:00
}
}