CUE.NET/Effects/IEffect.cs

// ReSharper disable UnusedMember.Global
// ReSharper disable UnusedMemberInSuper.Global

using System.Collections.Generic;
using CUE.NET.Brushes;
using CUE.NET.Devices.Generic;

namespace CUE.NET.Effects
{
    /// <summary>
    /// Represents a basic effect.
    /// </summary>
    public interface IEffect
    {
        #region Properties & Fields

        /// <summary>
        /// Gets or sets the list of LEDs to which the effect applies.
        /// </summary>
        IEnumerable<CorsairLed> LedList { get; set; }

        /// <summary>
        /// Gets the brush which is drawn by the effect.
        /// </summary>
        IBrush EffectBrush { get; }

        /// <summary>
        /// Gets or sets the z-index of the effect to allow ordering them before drawing. (lowest first) (default: 0)
        /// </summary>
        int ZIndex { get; set; }

        /// <summary>
        /// Gets or sets if this effect has finished all of his work.
        /// </summary>
        bool IsDone { get; }

        #endregion

        #region Methods

        /// <summary>
        /// Updates the effect.
        /// </summary>
        /// <param name="deltaTime">The elapsed time (in seconds) since the last update.</param>
        void Update(float deltaTime);

        /// <summary>
        /// Hook which is called when the effect is attached to a device.
        /// </summary>
        void OnAttach();

        /// <summary>
        /// Hook which is called when the effect is detached from a device.
        /// </summary>
        void OnDetach();

        #endregion
    }
}