Artemis/src/Artemis.Core/Plugins/LayerEffects/LayerEffectDescriptor.cs

using System;
using System.Linq;
using Artemis.Core.LayerEffects.Placeholder;
using Artemis.Core.Services;
using Artemis.Storage.Entities.Profile;
using Ninject;

namespace Artemis.Core.LayerEffects
{
    /// <summary>
    ///     A class that describes a layer effect
    /// </summary>
    public class LayerEffectDescriptor
    {
        internal LayerEffectDescriptor(string displayName, string description, string icon, Type layerEffectType, LayerEffectProvider layerEffectProvider)
        {
            DisplayName = displayName;
            Description = description;
            Icon = icon;
            LayerEffectType = layerEffectType;
            LayerEffectProvider = layerEffectProvider;
        }

        /// <summary>
        ///     The name that is displayed in the UI
        /// </summary>
        public string DisplayName { get; }

        /// <summary>
        ///     The description that is displayed in the UI
        /// </summary>
        public string Description { get; }

        /// <summary>
        ///     The Material icon to display in the UI, a full reference can be found
        ///     <see href="https://materialdesignicons.com">here</see>
        /// </summary>
        public string Icon { get; }

        /// <summary>
        ///     The type of the layer effect
        /// </summary>
        public Type LayerEffectType { get; }

        /// <summary>
        ///     The plugin that provided this <see cref="LayerEffectDescriptor" />
        /// </summary>
        public LayerEffectProvider LayerEffectProvider { get; }
        
        /// <summary>
        ///     Gets the GUID this descriptor is acting as a placeholder for. If null, this descriptor is not a placeholder
        /// </summary>
        public Guid? PlaceholderFor { get; internal set; }

        /// <summary>
        ///     Creates an instance of the described effect and applies it to the render element
        /// </summary>
        internal void CreateInstance(RenderProfileElement renderElement, LayerEffectEntity entity)
        {
            // Skip effects already on the element
            if (renderElement.LayerEffects.Any(e => e.EntityId == entity.Id))
                return;

            if (PlaceholderFor != null)
            {
                CreatePlaceHolderInstance(renderElement, entity);
                return;
            }

            var effect = (BaseLayerEffect)CoreService.Kernel.Get(LayerEffectType);
            effect.ProfileElement = renderElement;
            effect.EntityId = entity.Id;
            effect.Order = entity.Order;
            effect.Name = entity.Name;
            effect.Enabled = entity.Enabled;
            effect.Descriptor = this;

            effect.Initialize();
            effect.Update(0);

            renderElement.ActivateLayerEffect(effect);
        }

        private void CreatePlaceHolderInstance(RenderProfileElement renderElement, LayerEffectEntity entity)
        {
            var effect = new PlaceholderLayerEffect(entity, PlaceholderFor.Value) {ProfileElement = renderElement, Descriptor = this};
            effect.Initialize();
            renderElement.ActivateLayerEffect(effect);
        }
    }
}