Merge pull request #92 from Live2D/develop

Update to Cubism 5 SDK for Unity R5

Author: itoh-at-live2d-com

Assets/Live2D/Cubism/CHANGELOG.md

@@ -5,6 +5,40 @@ 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.5] - 2026-04-02
+
+### Added
+
+* Added Cubism Core for ARM64 iOS Simulator.
+  * See `CHANGELOG.md` in Core.
+
+### Changed
+
+* Update each model's prefab to match environment updates.
+* Change to allow specifying `AnimatorController` in scenes under `Assets/Live2D/Cubism/Samples/AsyncBenchmark`.
+* Change to explicitly set texture sampler settings.
+* Change the version of the development project to `6000.0.68f1`.
+* Change to work with the `Input System` package.
+* Change property names related to multiply color and screen color.
+
+### Fixed
+
+* Fix an issue in URP where Cubism models could not be picked in the Scene View.
+* Fix an issue in URP where selected Cubism models were not highlighted with an outline in the Scene View.
+* Fix an issue where the scaling reference position was set to the center of the rendering area.
+* Fix incorrect quaternion composition in `CubismRenderer`.
+* Fix an issue where the model would disappear when regaining Editor focus if `Run In Background` was disabled.
+* Fix an issue where the import process would run for models imported under the `StreamingAssets` folder. by [@redwyre](https://github.com/Live2D/CubismUnityComponents/pull/90)
+* Fix an issue where the `Koharu` model used in scenes under `Assets/Live2D/Cubism/Samples` was outdated.
+* Fix an issue where `CubismPartColorsEditor` was using incorrect flags for determination.
+* Fix an issue where the re-import process for a model did not support increasing or decreasing parameters and other elements.
+* Fix CubismImporterBase.Save so that it no longer performs a reimport when saving.
+* Fix the importer to import motion3.json first, followed by model3.json, and then all other assets.
+* Fix PoseMotionImporter processing to accommodate the new import order.
+* Fix an issue where specifying an override in `CubismParameterExtensionMethods.BlendToValue()` caused the applied value to be the current value of that parameter. by [@LoS-Light](https://github.com/Live2D/CubismUnityComponents/pull/89)
+* Fix an issue where offscreen rendering of models was not functioning correctly with Z Buffer in Reversed Z environments.
+
+
 ## [5-r.5-beta.3] - 2026-01-08
 
 ### Added
@@ -165,7 +199,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Added
 
-* Add `CubimMath` class in namespace `Live2D.Cubism.Framework.Utils`.
+* Add `CubismMath` class in namespace `Live2D.Cubism.Framework.Utils`.
 * Add function `ModF()` to compute floating-point remainder in `CubismMath` class.
 
 ### Changed
@@ -552,6 +586,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.5]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.5-beta.3...5-r.5
 [5-r.5-beta.3]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.5-beta.2...5-r.5-beta.3
 [5-r.5-beta.2]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.5-beta.1...5-r.5-beta.2
 [5-r.5-beta.1]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.4.1...5-r.5-beta.1

Assets/Live2D/Cubism/Core/CubismModel.cs

@@ -89,6 +89,30 @@ public static void ResetMocReference(CubismModel model, CubismMoc moc)
             model.Moc = moc;
         }
 
+        /// <summary>
+        /// Resets non-serialized fields of a <see cref="CubismModel"/>.
+        /// </summary>
+        /// <remarks>
+        /// Call after <c>PrefabUtility.SaveAsPrefabAsset</c> to clear stale
+        /// component references that may have been cached by <see cref="OnValidate"/>
+        /// during the prefab replacement.
+        /// </remarks>
+        /// <param name="model">Target Cubism model.</param>
+        public static void ResetNonSerializedFields(CubismModel model)
+        {
+            if (model.TaskableModel != null)
+            {
+                model.TaskableModel.ReleaseUnmanaged();
+                model.TaskableModel = null;
+            }
+
+            model._parameters = null;
+            model._parts = null;
+            model._drawables = null;
+            model._offscreens = null;
+            model._canvasInformation = null;
+        }
+
         /// <summary>
         /// <see cref="Moc"/> backing field.
         /// </summary>
@@ -355,6 +379,28 @@ private void Reset(CubismMoc moc)
             }
             else
             {
+                // Filter stale entries whose UnmanagedIndex exceeds the new Moc count.
+                var unmanagedParameterCount = TaskableModel.UnmanagedModel.Parameters.Count;
+                if (Parameters.Length > unmanagedParameterCount)
+                {
+                    var filtered = new CubismParameter[unmanagedParameterCount];
+                    var n = 0;
+                    for (var i = 0; i < Parameters.Length; i++)
+                    {
+                        if (Parameters[i].UnmanagedIndex < unmanagedParameterCount)
+                        {
+                            filtered[n++] = Parameters[i];
+                        }
+                    }
+
+                    if (n < unmanagedParameterCount)
+                    {
+                        Array.Resize(ref filtered, n);
+                    }
+
+                    Parameters = filtered;
+                }
+
                 Parameters.Revive(TaskableModel.UnmanagedModel);
             }
 
@@ -369,6 +415,27 @@ private void Reset(CubismMoc moc)
             }
             else
             {
+                // Filter stale entries whose UnmanagedIndex exceeds the new Moc count.
+                var unmanagedPartCount = TaskableModel.UnmanagedModel.Parts.Count;
+                if (Parts.Length > unmanagedPartCount)
+                {
+                    var filtered = new CubismPart[unmanagedPartCount];
+                    var n = 0;
+                    for (var i = 0; i < Parts.Length; i++)
+                    {
+                        if (Parts[i].UnmanagedIndex < unmanagedPartCount)
+                        {
+                            filtered[n++] = Parts[i];
+                        }
+                    }
+
+                    if (n < unmanagedPartCount)
+                    {
+                         Array.Resize(ref filtered, n);
+                    }
+
+                    Parts = filtered;
+                }
                 Parts.Revive(TaskableModel.UnmanagedModel);
             }
 
@@ -383,6 +450,28 @@ private void Reset(CubismMoc moc)
             }
             else
             {
+                // Filter stale entries whose UnmanagedIndex exceeds the new Moc count.
+                var unmanagedDrawableCount = TaskableModel.UnmanagedModel.Drawables.Count;
+                if (Drawables.Length > unmanagedDrawableCount)
+                {
+                    var filtered = new CubismDrawable[unmanagedDrawableCount];
+                    var n = 0;
+                    for (var i = 0; i < Drawables.Length; i++)
+                    {
+                        if (Drawables[i].UnmanagedIndex < unmanagedDrawableCount)
+                        {
+                            filtered[n++] = Drawables[i];
+                        }
+                    }
+
+                    if (n < unmanagedDrawableCount)
+                    {
+                        Array.Resize(ref filtered, n);
+                    }
+
+                    Drawables = filtered;
+                }
+
                 Drawables.Revive(TaskableModel.UnmanagedModel);
             }
 
@@ -398,6 +487,28 @@ private void Reset(CubismMoc moc)
                 }
                 else
                 {
+                    // Filter stale entries whose UnmanagedIndex exceeds the new Moc count.
+                    var unmanagedOffscreenCount = TaskableModel.UnmanagedModel.Offscreens.Count;
+                    if (Offscreens.Length > unmanagedOffscreenCount)
+                    {
+                        var filtered = new CubismOffscreen[unmanagedOffscreenCount];
+                        var n = 0;
+                        for (var i = 0; i < Offscreens.Length; i++)
+                        {
+                            if (Offscreens[i].UnmanagedIndex < unmanagedOffscreenCount)
+                            {
+                                filtered[n++] = Offscreens[i];
+                            }
+                        }
+
+                        if (n < unmanagedOffscreenCount)
+                        {
+                            Array.Resize(ref filtered, n);
+                        }
+
+                        Offscreens = filtered;
+                    }
+
                     Offscreens.Revive(TaskableModel.UnmanagedModel);
                 }
             }

Assets/Live2D/Cubism/Editor/CubismAssetProcessor.cs

@@ -26,6 +26,9 @@ namespace Live2D.Cubism.Editor
     /// </summary>
     public class CubismAssetProcessor : AssetPostprocessor
     {
+        private const string Motion3JsonExtension = ".motion3.json";
+        private const string Model3JsonExtension = ".model3.json";
+
         #region Unity Event Handling
 
 #if !UNITY_2017_3_OR_NEWER
@@ -58,8 +61,26 @@ private static void OnPostprocessAllAssets(
 
             var assetList = CubismCreatedAssetList.GetInstance();
 
+            // Import motion3.json first to create AnimationClip
+            var orderedAssetPaths = importedAssetPaths
+                .OrderBy(path =>
+                {
+                    if (path.EndsWith(Motion3JsonExtension, StringComparison.OrdinalIgnoreCase))
+                    {
+                        return 0;
+                    }
+
+                    if (path.EndsWith(Model3JsonExtension, StringComparison.OrdinalIgnoreCase))
+                    {
+                        return 1;
+                    }
+
+                    return 2;
+                })
+                .ToArray();
+
             // Handle any imported Cubism assets.
-            foreach (var assetPath in importedAssetPaths)
+            foreach (var assetPath in orderedAssetPaths)
             {
                 var importer = CubismImporter.GetImporterAtPath(assetPath);
 
@@ -69,11 +90,17 @@ private static void OnPostprocessAllAssets(
                     continue;
                 }
 
+                if (assetPath.StartsWith("Assets/StreamingAssets/"))
+                {
+                    Debug.LogWarning("CubismAssetProcessor : Skipping import of " + assetPath);
+                    continue;
+                }
+
                 try
                 {
                     importer.Import();
                 }
-                catch(Exception e)
+                catch (Exception e)
                 {
                     Debug.LogError("CubismAssetProcessor : Following error occurred while importing " + assetPath);
                     Debug.LogError(e);
@@ -299,6 +326,17 @@ private static void GenerateBuiltinResources()
                 AssetDatabase.CreateAsset(material, $"{materialsRoot}/{material.name}.mat");
             }
 
+            if (CubismBuiltinMaterials.TransparentPicking == null)
+            {
+                // Create transparent material for Scene View picking.
+                var material = new Material (CubismBuiltinShaders.TransparentPicking)
+                {
+                    name = "TransparentPicking"
+                };
+
+                AssetDatabase.CreateAsset(material, $"{materialsRoot}/{material.name}.mat");
+            }
+
             #region Cubism 5.3
 
             var materialsDir = materialsRoot + "/BlendMode";

Assets/Live2D/Cubism/Editor/Importers/CubismImporter.cs

@@ -234,7 +234,9 @@ private static void BuiltinTextureImportHandler(CubismModel3JsonImporter importe
             if (!textureImporter.mipmapEnabled
                 && textureImporter.alphaIsTransparency
                 && textureImporter.textureType == TextureImporterType.Default
-                && textureImporter.textureCompression == TextureImporterCompression.Uncompressed)
+                && textureImporter.textureCompression == TextureImporterCompression.Uncompressed
+                && textureImporter.wrapMode == TextureWrapMode.Repeat
+                && textureImporter.filterMode == FilterMode.Bilinear)
             {
                 return;
             }
@@ -245,7 +247,8 @@ private static void BuiltinTextureImportHandler(CubismModel3JsonImporter importe
             textureImporter.alphaIsTransparency = true;
             textureImporter.textureType = TextureImporterType.Default;
             textureImporter.textureCompression = TextureImporterCompression.Uncompressed;
-
+            textureImporter.wrapMode = TextureWrapMode.Repeat;
+            textureImporter.filterMode = FilterMode.Bilinear;
 
             EditorUtility.SetDirty(texture);
             textureImporter.SaveAndReimport();

Assets/Live2D/Cubism/Editor/Importers/CubismImporterBase.cs

@@ -42,7 +42,7 @@ public void Save()
             assetImporter.userData = JsonUtility.ToJson(this);
 
 
-            assetImporter.SaveAndReimport();
+            AssetDatabase.WriteImportSettingsIfDirty(AssetPath);
         }
 
 #region ICubismImporter