Merge pull request #84 from Live2D/develop

Update to Cubism 5 SDK for Unity R3

Author: itoh-at-live2d-com

Assets/Live2D/Cubism/CHANGELOG.md

@@ -4,6 +4,33 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+
+## [5-r.3] - 2024-11-28
+
+### Added
+
+* Add processing to parse `CombinedParameters` from `.cdi3.json` file.
+  * Also add `CubismDisplayInfoCombinedParameterInfo` component to store this information.
+* Add `AnimationBeganHandler`, which calls a function when the motion playback starts, to both `CubismMotionController` and `CubismMotionLayer`.
+* Add the definition of the function `GetLogFunction` to `CubismCoreDll`.
+
+### Changed
+
+* Change `OnGeneratedCSProjectFiles` function to be disabled in Unity 2017.3 and later by [@moz-moz](https://github.com/moz-moz)
+* Change to a single function The initialization process in CubismModel class. by [@KT](https://creatorsforum.live2d.com/t/topic/2356/)
+* Change to optimize update process for Multiply Color and Screen Color.
+* Change argument type of `CubismMotionLayer.AnimationEndHandler` and `CubismMotionController.AnimationEndHandler` to match the current usage.
+* Move the definition of `csmSetLogFunction` from `CubismLogging` to `CubismCoreDll` and rename to `SetLogFunction`.
+* Raycast processing now supports 3D intersection determination.
+* In the `AsyncBenchmark` scene and `AutomaticAsyncBenchmark`, changed it so that asynchronous processing is not performed in WebGL.
+
+### Fixed
+
+* The fade in and fade out functionality has been improved to better maintain compatibility with other CubismSDK implementations.
+* Fix an issue in which when the number of textures for masks was increased, masks were not generated for the increased number of textures from the time of execution.
+* Fix an issue that caused an error when parsing Json if the name of the model had certain characters.
+* Fix the condition for setting the fade-out end time for Expression.
+
 ## [5-r.2] - 2024-04-04
 
 ### Added
@@ -406,6 +433,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Fix issue where Priority value was not reset after playing motion with CubismMotionController.
 
 
+[5-r.3]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.2...5-r.3
 [5-r.2]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.1...5-r.2
 [5-r.1]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.1-beta.4...5-r.1
 [5-r.1-beta.4]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.1-beta.3...5-r.1-beta.4

Assets/Live2D/Cubism/Core/CubismDrawable.cs

@@ -108,6 +108,11 @@ public int TextureIndex
             }
         }
 
+        /// <summary>
+        /// <see cref="MultiplyColor"/> backing field.
+        /// </summary>
+        private Color _multiplyColor;
+
         /// <summary>
         /// Copy of MultiplyColor.
         /// </summary>
@@ -116,14 +121,22 @@ public Color MultiplyColor
             get
             {
                 var index = UnmanagedIndex * 4;
+
                 // Pull data.
-                return new Color(UnmanagedDrawables.MultiplyColors[index],
-                    UnmanagedDrawables.MultiplyColors[index + 1],
-                    UnmanagedDrawables.MultiplyColors[index + 2],
-                    UnmanagedDrawables.MultiplyColors[index + 3]);
+                _multiplyColor.r = UnmanagedDrawables.MultiplyColors[index];
+                _multiplyColor.g = UnmanagedDrawables.MultiplyColors[index + 1];
+                _multiplyColor.b = UnmanagedDrawables.MultiplyColors[index + 2];
+                _multiplyColor.a = UnmanagedDrawables.MultiplyColors[index + 3];
+
+                return _multiplyColor;
             }
         }
 
+        /// <summary>
+        /// <see cref="ScreenColor"/> backing field.
+        /// </summary>
+        public Color _screenColor;
+
         /// <summary>
         /// Copy of ScreenColor.
         /// </summary>
@@ -132,11 +145,14 @@ public Color ScreenColor
             get
             {
                 var index = UnmanagedIndex * 4;
+
                 // Pull data.
-                return new Color(UnmanagedDrawables.ScreenColors[index],
-                    UnmanagedDrawables.ScreenColors[index + 1],
-                    UnmanagedDrawables.ScreenColors[index + 2],
-                    UnmanagedDrawables.ScreenColors[index + 3]);
+                _screenColor.r = UnmanagedDrawables.ScreenColors[index];
+                _screenColor.g = UnmanagedDrawables.ScreenColors[index + 1];
+                _screenColor.b = UnmanagedDrawables.ScreenColors[index + 2];
+                _screenColor.a = UnmanagedDrawables.ScreenColors[index + 3];
+
+                return _screenColor; ;
             }
         }
 
@@ -360,7 +376,6 @@ public bool MultiplyBlend
             }
         }
 
-
         /// <summary>
         /// Revives instance.
         /// </summary>

Assets/Live2D/Cubism/Core/CubismLogging.cs

@@ -18,40 +18,36 @@ namespace Live2D.Cubism.Core
     /// <summary>
     /// Wrapper for core logs.
     /// </summary>
-    internal static class CubismLogging
+    public class CubismLogging
     {
         #region Delegates
 
         /// <summary>
         /// Delegate compatible with unmanaged log function.
         /// </summary>
         /// <param name="message">Message to log.</param>
-        private unsafe delegate void UnmanagedLogDelegate(char* message);
+        public unsafe delegate void UnmanagedLogDelegate(char* message);
 
         #endregion
 
         /// <summary>
         /// Delegate to pass to native Api.
         /// </summary>
         // ReSharper disable once PrivateFieldCanBeConvertedToLocalVariable
-        private static UnmanagedLogDelegate LogDelegate { get; set; }
+        public static UnmanagedLogDelegate LogDelegate { get; set; }
 
         #region Initialization
 
         /// <summary>
         /// Registers delegates.
         /// </summary>
-        [RuntimeInitializeOnLoadMethod]
-        // ReSharper disable once UnusedMember.Local
-        private static unsafe void Initialize()
+        public static unsafe void Initialize(UnmanagedLogDelegate logFunctionDelegate)
         {
-            LogDelegate = LogUnmanaged;
-
+            LogDelegate = logFunctionDelegate;
 
             var logFunction = Marshal.GetFunctionPointerForDelegate(LogDelegate);
 
-
-            csmSetLogFunction(logFunction);
+            CubismCoreDll.SetLogFunction(logFunction);
         }
 
         #endregion
@@ -61,7 +57,7 @@ private static unsafe void Initialize()
         /// </summary>
         /// <param name="message">Message to log.</param>
         [MonoPInvokeCallback(typeof(UnmanagedLogDelegate))]
-        private static unsafe void LogUnmanaged(char* message)
+        public static unsafe void LogUnmanaged(char* message)
         {
             // Marshal message and log it.
             var managedMessage = Marshal.PtrToStringAnsi(new IntPtr(message));
@@ -70,11 +66,16 @@ private static unsafe void LogUnmanaged(char* message)
             Debug.LogFormat("[Cubism] Core: {0}.", managedMessage);
         }
 
-        #region Extern C
-
-        [DllImport(CubismCoreDll.DllName)]
-        private static extern void csmSetLogFunction(IntPtr logFunction);
+        /// <summary>
+        /// Example log function.
+        /// </summary>
+        /// <param name="message">Log message.</param>
+        public static unsafe void InvokeLog(string message)
+        {
+            var logFunction = Marshal.GetDelegateForFunctionPointer<UnmanagedLogDelegate>(CubismCoreDll.GetLogFunction());
 
-        #endregion
+            var str = Marshal.StringToHGlobalAnsi(message);
+            logFunction.Invoke((char*)str.ToPointer());
+        }
     }
 }

Assets/Live2D/Cubism/Core/CubismModel.cs

@@ -266,26 +266,7 @@ private void Revive()
             }
 
 
-            // Revive unmanaged model.
-            TaskableModel = new CubismTaskableModel(Moc);
-
-            if (TaskableModel == null || TaskableModel.UnmanagedModel == null)
-            {
-                return;
-            }
-
-            // Revive proxies.
-            Parameters = GetComponentsInChildren<CubismParameter>();
-            Parts = GetComponentsInChildren<CubismPart>();
-            Drawables = GetComponentsInChildren<CubismDrawable>();
-
-            Parameters.Revive(TaskableModel.UnmanagedModel);
-            Parts.Revive(TaskableModel.UnmanagedModel);
-            Drawables.Revive(TaskableModel.UnmanagedModel);
-
-            CanvasInformation = new CubismCanvasInformation(TaskableModel.UnmanagedModel);
-
-            _parameterStore = GetComponent<CubismParameterStore>();
+            Reset(Moc);
         }
 
         /// <summary>
@@ -303,22 +284,52 @@ private void Reset(CubismMoc moc)
                 return;
             }
 
-            // Create and initialize proxies.
-            var parameters = CubismParameter.CreateParameters(TaskableModel.UnmanagedModel);
-            var parts = CubismPart.CreateParts(TaskableModel.UnmanagedModel);
-            var drawables = CubismDrawable.CreateDrawables(TaskableModel.UnmanagedModel);
 
+            Parameters = GetComponentsInChildren<CubismParameter>();
+            if (Parameters.Length < 1 && (transform.Find("Parameters") == null))
+            {
+                // Create and initialize proxies.
+                var parameters = CubismParameter.CreateParameters(TaskableModel.UnmanagedModel);
+                parameters.transform.SetParent(transform);
+                Parameters = parameters.GetComponentsInChildren<CubismParameter>();
+            }
+            else
+            {
+                Parameters.Revive(TaskableModel.UnmanagedModel);
+            }
 
-            parameters.transform.SetParent(transform);
-            parts.transform.SetParent(transform);
-            drawables.transform.SetParent(transform);
 
+            Parts = GetComponentsInChildren<CubismPart>();
+            if (Parts.Length < 1 && (transform.Find("Parts") == null))
+            {
+                // Create and initialize proxies.
+                var parts = CubismPart.CreateParts(TaskableModel.UnmanagedModel);
+                parts.transform.SetParent(transform);
+                Parts = parts.GetComponentsInChildren<CubismPart>();
+            }
+            else
+            {
+                Parts.Revive(TaskableModel.UnmanagedModel);
+            }
+
+
+            Drawables = GetComponentsInChildren<CubismDrawable>();
+            if (Drawables.Length < 1 && (transform.Find("Drawables") == null))
+            {
+                // Create and initialize proxies.
+                var drawables = CubismDrawable.CreateDrawables(TaskableModel.UnmanagedModel);
+                drawables.transform.SetParent(transform);
+                Drawables = drawables.GetComponentsInChildren<CubismDrawable>();
+            }
+            else
+            {
+                Drawables.Revive(TaskableModel.UnmanagedModel);
+            }
 
-            Parameters = parameters.GetComponentsInChildren<CubismParameter>();
-            Parts = parts.GetComponentsInChildren<CubismPart>();
-            Drawables = drawables.GetComponentsInChildren<CubismDrawable>();
 
             CanvasInformation = new CubismCanvasInformation(TaskableModel.UnmanagedModel);
+
+            RefreshParameterStore();
         }
 
         /// <summary>
@@ -339,6 +350,26 @@ public void ForceUpdateNow()
 #endif
         }
 
+        /// <summary>
+        /// パラメータストアを最新の情報に更新する。
+        /// </summary>
+        public void RefreshParameterStore()
+        {
+            // CubismParameterStore を取得する。
+            _parameterStore = GetComponent<CubismParameterStore>();
+
+
+            // Return early if empty.
+            if (_parameterStore == null)
+            {
+                return;
+            }
+
+
+            // 最新の情報に更新する。
+            _parameterStore.Refresh();
+        }
+
 
 #if UNITY_2018_1_OR_NEWER
         /// <summary>

Assets/Live2D/Cubism/Core/Unmanaged/CubismCoreDll.cs

@@ -142,7 +142,12 @@ public static class CubismCoreDll
         /// Sets log handler.
         /// </summary>
         [DllImport(DllName, EntryPoint = "csmSetLogFunction")]
-        public static extern void SetLogFunction(uint handler);
+        public static extern void SetLogFunction(IntPtr handler);
+        /// <summary>
+        /// Gets log handler.
+        /// </summary>
+        [DllImport(DllName, EntryPoint = "csmGetLogFunction")]
+        public static extern IntPtr GetLogFunction();
         /// <summary>
         /// Gets Size of model instance (in bytes).
         /// </summary>

Assets/Live2D/Cubism/Editor/CubismAssetProcessor.cs

@@ -28,6 +28,7 @@ public class CubismAssetProcessor : AssetPostprocessor
     {
         #region Unity Event Handling
 
+#if !UNITY_2017_3_OR_NEWER
         /// <summary>
         /// Called by Unity. Makes sure <see langword="unsafe"/> code is allowed.
         /// </summary>
@@ -36,6 +37,7 @@ public static void OnGeneratedCSProjectFiles()
         {
             AllowUnsafeCode();
         }
+#endif
 
 
         /// <summary>

Assets/Live2D/Cubism/Framework/CubismDisplayInfoCombinedParameterInfo.cs

@@ -0,0 +1,33 @@
+/**
+ * Copyright(c) Live2D Inc. All rights reserved.
+ *
+ * Use of this source code is governed by the Live2D Open Software license
+ * that can be found at https://www.live2d.com/eula/live2d-open-software-license-agreement_en.html.
+ */
+
+
+using Live2D.Cubism.Framework.Json;
+using UnityEngine;
+
+public class CubismDisplayInfoCombinedParameterInfo : MonoBehaviour
+{
+    /// <summary>
+    /// Combined parameters from .cdi3.json.
+    /// </summary>
+    public CubismDisplayInfo3Json.CombinedParameter[] CombinedParameters
+    {
+        get
+        {
+            return combinedParameters;
+        }
+        set
+        {
+            combinedParameters = value;
+        }
+    }
+
+    /// <summary>
+    /// backing field for <see cref="CombinedParameters"/>.
+    /// </summary>
+    private CubismDisplayInfo3Json.CombinedParameter[] combinedParameters;
+}

Assets/Live2D/Cubism/Framework/CubismDisplayInfoCombinedParameterInfo.cs.meta

@@ -95,7 +95,12 @@ private void StartExpression()
             if(_playingExpressions.Count > 0)
             {
                 var playingExpression = _playingExpressions[_playingExpressions.Count - 1];
-                playingExpression.ExpressionEndTime = playingExpression.ExpressionUserTime + playingExpression.FadeOutTime;
+                var newExpressionEndTime = playingExpression.ExpressionUserTime + playingExpression.FadeOutTime;
+
+                if (playingExpression.ExpressionEndTime == 0.0f || newExpressionEndTime < playingExpression.ExpressionEndTime)
+                {
+                    playingExpression.ExpressionEndTime = newExpressionEndTime;
+                }
                 _playingExpressions[_playingExpressions.Count - 1] = playingExpression;
             }