DecorativeSprite.cs

using Microsoft.Xna.Framework;
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Xml.Linq;
 
namespace Barotrauma
{
    class DecorativeSprite : ISerializableEntity
    {
        public class State
        {
            public float RotationState;
            public float OffsetState;
            public float ScaleState;
            public Vector2 RandomOffsetMultiplier = new Vector2(Rand.Range(-1.0f, 1.0f), Rand.Range(-1.0f, 1.0f));
            public float RandomRotationFactor = Rand.Range(0.0f, 1.0f);
            public float RandomScaleFactor = Rand.Range(0.0f, 1.0f);
            public bool IsActive = true;
        }
 
        public string Name => $"Decorative Sprite";
        public Dictionary<Identifier, SerializableProperty> SerializableProperties { get; set; }
 
        public Sprite Sprite { get; private set; }
 
        public enum AnimationType
        {
            None,
            Sine,
            Noise,
            Circle
        }
 
        [Serialize(0.0f, IsPropertySaveable.Yes), Editable]
        public float BlinkFrequency { get; private set; }
 
        private float blinkTimer = 0.0f;
 
        [Serialize("0,0", IsPropertySaveable.Yes), Editable]
        public Vector2 Offset { get; private set; }
 
        [Serialize("0,0", IsPropertySaveable.Yes), Editable]
        public Vector2 RandomOffset { get; private set; }
 
        [Serialize(AnimationType.None, IsPropertySaveable.No), Editable]
        public AnimationType OffsetAnim { get; private set; }
 
        [Serialize(0.0f, IsPropertySaveable.Yes), Editable]
        public float OffsetAnimSpeed { get; private set; }
 
        [Serialize(AnimationType.None, IsPropertySaveable.No), Editable]
        public AnimationType ScaleAnim { get; private set; }
 
        [Serialize("0,0", IsPropertySaveable.Yes), Editable]
        public Vector2 ScaleAnimAmount { get; private set; }
 
        [Serialize(0.0f, IsPropertySaveable.Yes), Editable]
        public float ScaleAnimSpeed { get; private set; }
 
        private float rotationSpeedRadians;
        private float absRotationSpeedRadians;
 
        [Serialize(0.0f, IsPropertySaveable.Yes), Editable]
        public float RotationSpeed
        {
            get
            {
                return MathHelper.ToDegrees(rotationSpeedRadians);
            }
            private set
            {
                rotationSpeedRadians = MathHelper.ToRadians(value);
                absRotationSpeedRadians = Math.Abs(rotationSpeedRadians);
            }
        }
 
        private float rotationRadians;
        [Serialize(0.0f, IsPropertySaveable.Yes), Editable]
        public float Rotation
        {
            get
            {
                return MathHelper.ToDegrees(rotationRadians);
            }
            private set
            {
                rotationRadians = MathHelper.ToRadians(value);
            }
        }
 
        private Vector2 randomRotationRadians;
        [Serialize("0,0", IsPropertySaveable.Yes), Editable]
        public Vector2 RandomRotation
        {
            get
            {
                return new Vector2(MathHelper.ToDegrees(randomRotationRadians.X), MathHelper.ToDegrees(randomRotationRadians.Y));
            }
            private set
            {
                randomRotationRadians = new Vector2(MathHelper.ToRadians(value.X), MathHelper.ToRadians(value.Y));
            }
        }
 
        private float scale;
        [Serialize(1.0f, IsPropertySaveable.Yes), Editable]
        public float Scale
        {
            get { return scale; }
            private set { scale = MathHelper.Clamp(value, 0.0f, 10.0f); }
        }
 
        [Serialize("0,0", IsPropertySaveable.Yes), Editable]
        public Vector2 RandomScale
        {
            get;
            private set;
        }
 
        [Serialize(AnimationType.None, IsPropertySaveable.No), Editable]
        public AnimationType RotationAnim { get; private set; }
 
        [Serialize(0, IsPropertySaveable.No, description: "If > 0, only one sprite of the same group is used (chosen randomly)"), Editable(ReadOnly = true)]
        public int RandomGroupID { get; private set; }
 
        [Serialize("1.0,1.0,1.0,1.0", IsPropertySaveable.Yes), Editable()]
        public Color Color { get; set; }
 
        internal List<PropertyConditional> IsActiveConditionals { get; private set; } = new List<PropertyConditional>();
        internal List<PropertyConditional> AnimationConditionals { get; private set; } = new List<PropertyConditional>();
 
        public DecorativeSprite(ContentXElement element, string path = "", string file = "", bool lazyLoad = false)
        {
            Sprite = new Sprite(element, path, file, lazyLoad: lazyLoad);
            SerializableProperties = SerializableProperty.DeserializeProperties(this, element);
            // load property conditionals
            foreach (var subElement in element.Elements())
            {
                //choose which list the new conditional should be placed to
                List<PropertyConditional> conditionalList;
                switch (subElement.Name.ToString().ToLowerInvariant())
                {
                    case "conditional":
                    case "isactiveconditional":
                        conditionalList = IsActiveConditionals;
                        break;
                    case "animationconditional":
                        conditionalList = AnimationConditionals;
                        break;
                    default:
                        continue;
                }
                conditionalList.AddRange(PropertyConditional.FromXElement(subElement));
            }
        }
 
        public Vector2 GetOffset(ref float offsetState, Vector2 randomOffsetMultiplier, float rotation = 0.0f)
        {
            Vector2 offset = Offset;
            if (OffsetAnimSpeed > 0.0f)
            {
                switch (OffsetAnim)
                {
                    case AnimationType.Sine:
                        offsetState %= (MathHelper.TwoPi / OffsetAnimSpeed);
                        offset *= MathF.Sin(offsetState * OffsetAnimSpeed);
                        break;
                    case AnimationType.Circle:
                        offsetState %= (MathHelper.TwoPi / OffsetAnimSpeed);
                        offset *= new Vector2(MathF.Cos(offsetState * OffsetAnimSpeed), MathF.Sin(offsetState * OffsetAnimSpeed));
                        break;
                    case AnimationType.Noise:
                        offset *= GetNoiseVector(ref offsetState, OffsetAnimSpeed);
                        break;
                }
            }
            offset += new Vector2(
                RandomOffset.X * randomOffsetMultiplier.X, 
                RandomOffset.Y * randomOffsetMultiplier.Y);
            if (Math.Abs(rotation) > 0.01f)
            {
                Matrix transform = Matrix.CreateRotationZ(rotation);
                offset = Vector2.Transform(offset, transform);
            }
            return offset;
        }
 
        public float GetRotation(ref float rotationState, float randomRotationFactor)
        {
            switch (RotationAnim)
            {
                case AnimationType.Sine:
                    rotationState %= MathHelper.TwoPi / absRotationSpeedRadians;
                    return 
                        rotationRadians * MathF.Sin(rotationState * rotationSpeedRadians)
                        + MathHelper.Lerp(randomRotationRadians.X, randomRotationRadians.Y, randomRotationFactor);
                case AnimationType.Noise:
                    rotationState %= 1.0f / absRotationSpeedRadians;
                    return 
                        rotationRadians * (PerlinNoise.GetPerlin(rotationState * absRotationSpeedRadians, rotationState * absRotationSpeedRadians) - 0.5f)
                        + MathHelper.Lerp(randomRotationRadians.X, randomRotationRadians.Y, randomRotationFactor);
                default:
                    return  
                        rotationRadians + 
                        rotationState * rotationSpeedRadians
                        + MathHelper.Lerp(randomRotationRadians.X, randomRotationRadians.Y, randomRotationFactor);
            }
        }
 
        public Vector2 GetScale(ref float scaleState, float randomScaleModifier)
        {
            Vector2 currentScale = Vector2.One *
                (RandomScale == Vector2.Zero ? scale : MathHelper.Lerp(RandomScale.X, RandomScale.Y, randomScaleModifier));
            if (ScaleAnimSpeed > 0.0f)
            {
                switch (ScaleAnim)
                {
                    case AnimationType.Sine:
                        scaleState %= (MathHelper.TwoPi / ScaleAnimSpeed);
                        currentScale *= Vector2.One + ScaleAnimAmount * MathF.Sin(scaleState * ScaleAnimSpeed);
                        break;
                    case AnimationType.Noise:
                        currentScale *= Vector2.One + ScaleAnimAmount * GetNoiseVector(ref scaleState, ScaleAnimSpeed);
                        break;
                }
            }            
            return currentScale;            
        }
 
        private static Vector2 GetNoiseVector(ref float state, float speed)
        {
            //multiply speed by a magic constant, because otherwise a speed of 1 would already be very fast (looping through the noise texture once per second)
            //just makes the values more intuitive / closer to what constitutes as "fast" on the other types of animations
            float modifiedSpeed = speed * 0.1f;
            // wrap around the edge of the noise (t == 1)
            state %= 1.0f / modifiedSpeed;
            float t = state * modifiedSpeed;
            Vector2 noiseValue = new Vector2(
                PerlinNoise.GetPerlin(t, t),
                //sample the y coordinate from a different position in the noise texture
                PerlinNoise.GetPerlin(t + 0.5f, t + 0.5f));
            //move the value so it's in the range of -0.5 and 0.5, as opposed to 0-1.
            return noiseValue - new Vector2(0.5f, 0.5f);
        }
 
        public static void UpdateSpriteStates(ImmutableDictionary<int, ImmutableArray<DecorativeSprite>> spriteGroups, Dictionary<DecorativeSprite, State> animStates,
            int entityID, float deltaTime, Func<PropertyConditional, bool> checkConditional)
        {
            foreach (int spriteGroup in spriteGroups.Keys)
            {
                for (int i = 0; i < spriteGroups[spriteGroup].Length; i++)
                {
                    var decorativeSprite = spriteGroups[spriteGroup][i];
                    if (decorativeSprite == null) { continue; }
                    if (spriteGroup > 0)
                    {
                        int activeSpriteIndex = entityID % spriteGroups[spriteGroup].Length;
                        if (i != activeSpriteIndex)
                        {
                            animStates[decorativeSprite].IsActive = false;
                            continue;
                        }
                    }
 
                    //check if the sprite is active (whether it should be drawn or not)
                    var spriteState = animStates[decorativeSprite];
                    spriteState.IsActive = true;
                    foreach (PropertyConditional conditional in decorativeSprite.IsActiveConditionals)
                    {
                        if (!checkConditional(conditional))
                        {
                            spriteState.IsActive = false;
                            break;
                        }
                    }
                    if (!spriteState.IsActive) { continue; }
                    if (decorativeSprite.BlinkFrequency > 0.0f)
                    {
                        decorativeSprite.blinkTimer += deltaTime * decorativeSprite.BlinkFrequency;
                        decorativeSprite.blinkTimer %= 1.0f;
                        if (decorativeSprite.blinkTimer > 0.5f)
                        {
                            spriteState.IsActive = false;
                            continue;
                        }
                    }
                    //check if the sprite should be animated
                    bool animate = true;
                    foreach (PropertyConditional conditional in decorativeSprite.AnimationConditionals)
                    {
                        if (!checkConditional(conditional)) { animate = false; break; }
                    }
                    if (!animate) { continue; }
                    spriteState.ScaleState += deltaTime;
                    spriteState.OffsetState += deltaTime;
                    spriteState.RotationState += deltaTime;
                }
            }
        }
 
        public void Remove()
        {
            Sprite?.Remove();
            Sprite = null;
        }
    }
}