osu/osu.Game/Skinning/SkinProvidingContainer.cs

107 lines
3.4 KiB
C#
Raw Normal View History

// 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.
2018-04-13 09:19:50 +00:00
using System;
using osu.Framework.Allocation;
using osu.Framework.Audio.Sample;
using osu.Framework.Bindables;
2018-04-13 09:19:50 +00:00
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Textures;
2019-08-23 11:32:43 +00:00
using osu.Game.Audio;
2018-04-13 09:19:50 +00:00
namespace osu.Game.Skinning
{
/// <summary>
/// A container which adds a local <see cref="ISkinSource"/> to the hierarchy.
/// </summary>
public class SkinProvidingContainer : Container, ISkinSource
2018-04-13 09:19:50 +00:00
{
public event Action SourceChanged;
2019-04-25 08:36:17 +00:00
private readonly ISkin skin;
2019-06-29 01:45:11 +00:00
private ISkinSource fallbackSource;
protected virtual bool AllowDrawableLookup(ISkinComponent component) => true;
protected virtual bool AllowTextureLookup(string componentName) => true;
protected virtual bool AllowSampleLookup(ISampleInfo componentName) => true;
protected virtual bool AllowConfigurationLookup => true;
public SkinProvidingContainer(ISkin skin)
{
2019-04-25 08:36:17 +00:00
this.skin = skin;
RelativeSizeAxes = Axes.Both;
}
public Drawable GetDrawableComponent(ISkinComponent component)
2018-04-20 15:17:57 +00:00
{
Drawable sourceDrawable;
if (AllowDrawableLookup(component) && (sourceDrawable = skin?.GetDrawableComponent(component)) != null)
2018-04-20 15:17:57 +00:00
return sourceDrawable;
return fallbackSource?.GetDrawableComponent(component);
2018-04-20 15:17:57 +00:00
}
2018-04-13 09:19:50 +00:00
2018-04-20 15:17:57 +00:00
public Texture GetTexture(string componentName)
{
Texture sourceTexture;
if (AllowTextureLookup(componentName) && (sourceTexture = skin?.GetTexture(componentName)) != null)
2018-04-20 15:17:57 +00:00
return sourceTexture;
return fallbackSource?.GetTexture(componentName);
2018-04-20 15:17:57 +00:00
}
2018-04-13 09:19:50 +00:00
2019-08-23 11:32:43 +00:00
public SampleChannel GetSample(ISampleInfo sampleInfo)
{
SampleChannel sourceChannel;
if (AllowSampleLookup(sampleInfo) && (sourceChannel = skin?.GetSample(sampleInfo)) != null)
return sourceChannel;
2019-08-23 11:32:43 +00:00
return fallbackSource?.GetSample(sampleInfo);
}
2018-04-13 09:19:50 +00:00
public IBindable<TValue> GetConfig<TLookup, TValue>(TLookup lookup)
2018-04-13 09:19:50 +00:00
{
if (AllowConfigurationLookup && skin != null)
{
var bindable = skin.GetConfig<TLookup, TValue>(lookup);
if (bindable != null)
return bindable;
}
return fallbackSource?.GetConfig<TLookup, TValue>(lookup);
2018-04-13 09:19:50 +00:00
}
protected virtual void TriggerSourceChanged() => SourceChanged?.Invoke();
2018-04-13 09:19:50 +00:00
2018-07-11 08:07:14 +00:00
protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
2018-04-13 09:19:50 +00:00
{
2018-07-11 08:07:14 +00:00
var dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
2018-04-13 09:19:50 +00:00
fallbackSource = dependencies.Get<ISkinSource>();
if (fallbackSource != null)
fallbackSource.SourceChanged += TriggerSourceChanged;
2018-04-13 09:19:50 +00:00
dependencies.CacheAs<ISkinSource>(this);
return dependencies;
2018-04-13 09:19:50 +00:00
}
protected override void Dispose(bool isDisposing)
{
// Must be done before base.Dispose()
SourceChanged = null;
2018-04-13 09:19:50 +00:00
base.Dispose(isDisposing);
if (fallbackSource != null)
fallbackSource.SourceChanged -= TriggerSourceChanged;
2018-04-13 09:19:50 +00:00
}
}
}