// ReSharper disable MemberCanBePrivate.Global
// ReSharper disable AutoPropertyCanBeMadeGetOnly.Global
// ReSharper disable UnusedMember.Global
using System;
using CUE.NET.Brushes;
namespace CUE.NET.Effects
{
///
/// Represents an effect which allows to flash an brush by modifying his opacity.
///
public class FlashEffect : AbstractBrushEffect
{
#region Properties & Fields
///
/// Gets or sets the attack-time (in seconds) of the effect. (default: 0.2f)
/// This is close to a synthesizer envelope. (See as reference)
///
public float Attack { get; set; } = 0.2f;
///
/// Gets or sets the decay-time (in seconds) of the effect. (default: 0f)
/// This is close to a synthesizer envelope. (See as reference)
///
public float Decay { get; set; } = 0f;
///
/// Gets or sets the sustain-time (in seconds) of the effect. (default: 0.3f)
/// This is close to a synthesizer envelope. (See as reference)
/// Note that this value for naming reasons represents the time NOT the level.
///
public float Sustain { get; set; } = 0.3f;
///
/// Gets or sets the release-time (in seconds) of the effect. (default: 0.2f)
/// This is close to a synthesizer envelope. (See as reference)
///
public float Release { get; set; } = 0.2f;
///
/// Gets or sets the level to which the oppacity (percentage) should raise in the attack-cycle. (default: 1f);
///
public float AttackValue { get; set; } = 1f;
///
/// Gets or sets the level at which the oppacity (percentage) should stay in the sustain-cycle. (default: 1f);
///
public float SustainValue { get; set; } = 1f;
///
/// Gets or sets the interval (in seconds) in which the effect should repeat (if repetition is enabled). (default: 1f)
///
public float Interval { get; set; } = 1f;
///
/// Gets or sets the amount of repetitions the effect should do until it's finished. Zero means infinite. (default: 0)
///
public int Repetitions { get; set; } = 0;
private ADSRPhase _currentPhase;
private float _currentPhaseValue;
private int _repetitionCount;
#endregion
#region Methods
///
/// Updates the effect.
///
/// The elapsed time (in seconds) since the last update.
public override void Update(float deltaTime)
{
_currentPhaseValue -= deltaTime;
// Using ifs instead of a switch allows to skip phases with time 0.
// ReSharper disable InvertIf
if (_currentPhase == ADSRPhase.Attack)
if (_currentPhaseValue > 0f)
Brush.Opacity = Math.Min(1f, (Attack - _currentPhaseValue) / Attack) * AttackValue;
else
{
_currentPhaseValue = Decay;
_currentPhase = ADSRPhase.Decay;
}
if (_currentPhase == ADSRPhase.Decay)
if (_currentPhaseValue > 0f)
Brush.Opacity = SustainValue + (Math.Min(1f, _currentPhaseValue / Decay) * (AttackValue - SustainValue));
else
{
_currentPhaseValue = Sustain;
_currentPhase = ADSRPhase.Sustain;
}
if (_currentPhase == ADSRPhase.Sustain)
if (_currentPhaseValue > 0f)
Brush.Opacity = SustainValue;
else
{
_currentPhaseValue = Release;
_currentPhase = ADSRPhase.Release;
}
if (_currentPhase == ADSRPhase.Release)
if (_currentPhaseValue > 0f)
Brush.Opacity = Math.Min(1f, _currentPhaseValue / Release) * SustainValue;
else
{
_currentPhaseValue = Interval;
_currentPhase = ADSRPhase.Pause;
}
if (_currentPhase == ADSRPhase.Pause)
if (_currentPhaseValue > 0f)
Brush.Opacity = 0f;
else
{
if (++_repetitionCount >= Repetitions && Repetitions > 0)
IsDone = true;
_currentPhaseValue = Attack;
_currentPhase = ADSRPhase.Attack;
}
// ReSharper restore InvertIf
}
///
/// Resets the effect.
///
public override void OnAttach(IBrush brush)
{
base.OnAttach(brush);
_currentPhase = ADSRPhase.Attack;
_currentPhaseValue = Attack;
_repetitionCount = 0;
brush.Opacity = 0f;
}
#endregion
// ReSharper disable once InconsistentNaming
private enum ADSRPhase
{
Attack,
Decay,
Sustain,
Release,
Pause
}
}
}