feat: add v4 compatible components

Use these components for an easy upgrade to v5 with minimal changes.

Author: mob-sakai

Packages/src/Samples~/v4 Compatible Components.meta

@@ -0,0 +1,136 @@
+using UnityEngine;
+using System;
+using Coffee.UIEffectInternal;
+
+namespace Coffee.UIEffects
+{
+    /// <summary>
+    /// Effect player.
+    /// </summary>
+    [Serializable]
+    public class EffectPlayer
+    {
+        //################################
+        // Public Members.
+        //################################
+        /// <summary>
+        /// Gets or sets a value indicating whether is playing.
+        /// </summary>
+        [Header("Effect Player")]
+        [Tooltip("Playing.")]
+        public bool play = false;
+
+        /// <summary>
+        /// Gets or sets the delay before looping.
+        /// </summary>
+        [Tooltip("Initial play delay.")]
+        [Range(0f, 10f)]
+        public float initialPlayDelay = 0;
+
+        /// <summary>
+        /// Gets or sets the duration.
+        /// </summary>
+        [Tooltip("Duration.")]
+        [Range(0.01f, 10f)]
+        public float duration = 1;
+
+        /// <summary>
+        /// Gets or sets a value indicating whether can loop.
+        /// </summary>
+        [Tooltip("Loop.")]
+        public bool loop = false;
+
+        /// <summary>
+        /// Gets or sets the delay before looping.
+        /// </summary>
+        [Tooltip("Delay before looping.")]
+        [Range(0f, 10f)]
+        public float loopDelay = 0;
+
+        /// <summary>
+        /// Gets or sets the update mode.
+        /// </summary>
+        [Tooltip("Update mode")]
+        public AnimatorUpdateMode updateMode = AnimatorUpdateMode.Normal;
+
+        private UIEffectTweener _tweener;
+        private UIEffectBase _target;
+
+        /// <summary>
+        /// Register player.
+        /// </summary>
+        public void OnEnable()
+        {
+            if (play)
+            {
+                Play(true);
+            }
+        }
+
+        /// <summary>
+        /// Unregister player.
+        /// </summary>
+        public void OnDisable()
+        {
+            Stop(false);
+        }
+
+        /// <summary>
+        /// Start playing.
+        /// </summary>
+        public void Play(bool reset)
+        {
+            play = true;
+            SetupProperty();
+            if (reset && _tweener)
+            {
+                _tweener.direction = UIEffectTweener.Direction.Forward;
+                _tweener.SetTime(0);
+            }
+        }
+
+        public void PlayReverse(bool reset)
+        {
+            play = true;
+            SetupProperty();
+            if (reset && _tweener)
+            {
+                _tweener.direction = UIEffectTweener.Direction.Reverse;
+                _tweener.SetTime(_tweener.totalTime);
+            }
+        }
+
+        /// <summary>
+        /// Stop playing.
+        /// </summary>
+        public void Stop(bool reset)
+        {
+            play = false;
+            if (reset && _tweener)
+            {
+                SetupProperty();
+                _tweener.SetTime(0);
+            }
+        }
+
+        public void Attach(UIEffectBase target)
+        {
+            _target = target;
+            SetupProperty();
+        }
+
+        private void SetupProperty()
+        {
+            if (!_target) return;
+            _tweener = _target.GetOrAddComponent<UIEffectTweener>();
+            _tweener.enabled = play;
+            _tweener.duration = duration;
+            _tweener.wrapMode = loop ? UIEffectTweener.WrapMode.Loop : UIEffectTweener.WrapMode.Once;
+            _tweener.interval = loopDelay;
+            _tweener.delay = initialPlayDelay;
+            _tweener.updateMode = updateMode == AnimatorUpdateMode.UnscaledTime
+                ? UIEffectTweener.UpdateMode.Unscaled
+                : UIEffectTweener.UpdateMode.Normal;
+        }
+    }
+}

Packages/src/Samples~/v4 Compatible Components/Runtime.meta

@@ -0,0 +1,43 @@
+#if UNITY_EDITOR
+using System.Linq;
+using Coffee.UIEffectInternal;
+using UnityEditor;
+
+namespace Coffee.UIEffects
+{
+    internal static class UIEffectV4Editor
+    {
+        [MenuItem("CONTEXT/" + nameof(UIDissolve) + "/Convert To UIEffect")]
+        [MenuItem("CONTEXT/" + nameof(UIShiny) + "/Convert To UIEffect")]
+        [MenuItem("CONTEXT/" + nameof(UIHsvModifier) + "/Convert To UIEffect")]
+        [MenuItem("CONTEXT/" + nameof(UITransitionEffect) + "/Convert To UIEffect")]
+        [MenuItem("CONTEXT/" + nameof(UIEffectV4) + "/Convert To UIEffect")]
+        private static void ConvertToUIEffect(MenuCommand command)
+        {
+            if (command.context is UIEffectBase legacy)
+            {
+                var go = legacy.gameObject;
+                var legacyContext = legacy.context;
+                command.context.ConvertTo<UIEffect>();
+                go.GetComponent<UIEffect>().CopyFrom(legacyContext);
+            }
+        }
+
+        [InitializeOnLoadMethod]
+        private static void InitializeOnLoad()
+        {
+            var presets = new[]
+                {
+                    "3b09ad143990c4c8795c6e93760e132a",
+                    "4f70ff0f1e25b4388b9bcb38d619f7bf"
+                }
+                .Select(AssetDatabase.GUIDToAssetPath)
+                .Select(AssetDatabase.LoadAssetAtPath<UIEffect>);
+            foreach (var preset in presets)
+            {
+                UIEffectProjectSettings.RegisterRuntimePreset(preset);
+            }
+        }
+    }
+}
+#endif

Packages/src/Samples~/v4 Compatible Components/Runtime/Common.meta

@@ -0,0 +1,13 @@
+namespace Coffee.UIEffects
+{
+    /// <summary>
+    /// Blur effect mode.
+    /// </summary>
+    public enum BlurMode
+    {
+        None = 0,
+        FastBlur = 1,
+        MediumBlur = 2,
+        DetailBlur = 3
+    }
+}

Packages/src/Samples~/v4 Compatible Components/Runtime/Common/EffectPlayer.cs

@@ -0,0 +1,13 @@
+namespace Coffee.UIEffects
+{
+    /// <summary>
+    /// Color effect mode.
+    /// </summary>
+    public enum ColorMode
+    {
+        Multiply = 0,
+        Fill = 1,
+        Add = 2,
+        Subtract = 3
+    }
+}