Fix eyelids bugs

CHANGELOG-PRERELEASE.md

@@ -10,12 +10,15 @@ The format is based on [Keep a Changelog].
 ### Added
 
 ### Changed
+- Show error with user friendly message if blendshape for eyelids are removed / frozen. `#253` 
 
 ### Deprecated
 
 ### Removed
 
 ### Fixed
+- eyelids BlendShape settings are mapped even if it's disabled `#235`
+  - This fixes error if internally eyelids BlendShape are frozen.
 
 ### Security
 

CHANGELOG.md

@@ -10,12 +10,15 @@ The format is based on [Keep a Changelog].
 ### Added
 
 ### Changed
+- Show error with user friendly message if blendshape for eyelids are removed / frozen. `#253`
 
 ### Deprecated
 
 ### Removed
 
 ### Fixed
+- eyelids BlendShape settings are mapped even if it's disabled `#235`
+  - This fixes error if internally eyelids BlendShape are frozen.
 
 ### Security
 

Editor/Processors/ApplyObjectMapping.cs

@@ -17,10 +17,10 @@ public void Apply(OptimizerSession session)
             var mapping = session.MappingBuilder.BuildObjectMapping();
 
             // replace all objects
-            foreach (var component in session.GetComponents<Component>())
+            BuildReport.ReportingObjects(session.GetComponents<Component>(), component =>
             {
+                if (component is Transform) return;
                 var serialized = new SerializedObject(component);
-                if (component is Transform) continue;
                 AnimatorControllerMapper mapper = null;
                 SpecialMappingApplier.Apply(component.GetType(), serialized, mapping, ref mapper);
                 var p = serialized.GetIterator();
@@ -35,7 +35,8 @@ public void Apply(OptimizerSession session)
                         if (p.objectReferenceValue is AnimatorController controller)
                         {
                             if (mapper == null)
-                                mapper = new AnimatorControllerMapper(mapping.CreateAnimationMapper(component.gameObject),
+                                mapper = new AnimatorControllerMapper(
+                                    mapping.CreateAnimationMapper(component.gameObject),
                                     session.RelativePath(component.transform), session);
 
                             // ReSharper disable once AccessToModifiedClosure
@@ -83,7 +84,7 @@ public void Apply(OptimizerSession session)
                 }
 
                 serialized.ApplyModifiedProperties();
-            }
+            });
         }
     }
 
@@ -100,23 +101,33 @@ public static void Apply(Type type, SerializedObject serialized,
         private static void VRCAvatarDescriptor(SerializedObject serialized,
             ObjectMapping mapping, ref AnimatorControllerMapper mapper)
         {
+            var eyelidsEnabled = serialized.FindProperty("enableEyeLook");
+            var eyelidType = serialized.FindProperty("customEyeLookSettings.eyelidType");
             var eyelidsSkinnedMesh = serialized.FindProperty("customEyeLookSettings.eyelidsSkinnedMesh");
             var eyelidsBlendshapes = serialized.FindProperty("customEyeLookSettings.eyelidsBlendshapes");
-            if (eyelidsSkinnedMesh == null || eyelidsBlendshapes == null) return;
 
-            var info = mapping.GetComponentMapping(eyelidsSkinnedMesh.objectReferenceInstanceIDValue);
-            if (info == null) return;
+            if (eyelidsEnabled.boolValue && 
+                eyelidType.enumValueIndex == (int)VRC.SDK3.Avatars.Components.VRCAvatarDescriptor.EyelidType.Blendshapes)
+            {
+                var info = mapping.GetComponentMapping(eyelidsSkinnedMesh.objectReferenceInstanceIDValue);
+                if (info == null) return;
 
-            eyelidsSkinnedMesh.objectReferenceValue = EditorUtility.InstanceIDToObject(info.MergedInto);
+                eyelidsSkinnedMesh.objectReferenceValue = EditorUtility.InstanceIDToObject(info.MergedInto);
 
-            for (var i = 0; i < eyelidsBlendshapes.arraySize; i++)
-            {
-                var indexProp = eyelidsBlendshapes.GetArrayElementAtIndex(i);
-                if (info.PropertyMapping.TryGetValue(
-                        VProp.BlendShapeIndex(indexProp.intValue),
-                        out var mappedPropName))
+                for (var i = 0; i < eyelidsBlendshapes.arraySize; i++)
                 {
-                    indexProp.intValue = VProp.ParseBlendShapeIndex(mappedPropName);
+                    var indexProp = eyelidsBlendshapes.GetArrayElementAtIndex(i);
+                    if (info.PropertyMapping.TryGetValue(
+                            VProp.BlendShapeIndex(indexProp.intValue),
+                            out var mappedPropName))
+                    {
+                        if (mappedPropName == null)
+                        {
+                            BuildReport.LogFatal("ApplyObjectMapping:VRCAvatarDescriptor:eyelids BlendShape Removed");
+                            return;
+                        }
+                        indexProp.intValue = VProp.ParseBlendShapeIndex(mappedPropName);
+                    }
                 }
             }
         }

Internal/ErrorReporter/Editor/BuildReport.cs

@@ -127,9 +127,11 @@ internal AvatarReport Initialize(VRCAvatarDescriptor descriptor)
         }
 
         [CanBeNull]
-        internal static ErrorLog Log(ReportLevel level, string code, object[] strings)
+        internal static ErrorLog Log(ReportLevel level, string code, params string[] strings)
         {
-            var errorLog = new ErrorLog(level, code, strings: strings.Select(s => s.ToString()).ToArray());
+            for (var i = 0; i < strings.Length; i++)
+                strings[i] = strings[i] ?? "";
+            var errorLog = new ErrorLog(level, code, strings);
 
             var avatarReport = CurrentReport.CurrentAvatar;
             if (avatarReport == null)
@@ -143,7 +145,7 @@ internal static ErrorLog Log(ReportLevel level, string code, object[] strings)
         }
 
         [CanBeNull]
-        internal static ErrorLog LogFatal(string code, object[] strings)
+        public static ErrorLog LogFatal(string code, params string[] strings)
         {
             var log = Log(ReportLevel.Error, code, strings: strings);
             if (CurrentReport.CurrentAvatar != null)

Localization/en.po

@@ -295,6 +295,13 @@ msgstr "If checked, this tool does not remove bones with non-bone children."
 
 # endregion
 
+#region ApplyObjectMapping
+
+msgid "ApplyObjectMapping:VRCAvatarDescriptor:eyelids BlendShape Removed"
+msgstr "BlendShape(s) for eyelids are Removed / frozen."
+
+#endregion
+
 # region ErrorReporter
 
 msgid "ErrorReporter:error.internal_error"

Localization/ja.po

@@ -232,6 +232,13 @@ msgstr "チェックされている場合、子にボーン以外を持つボー
 
 # endregion
 
+#region ApplyObjectMapping
+
+msgid "ApplyObjectMapping:VRCAvatarDescriptor:eyelids BlendShape Removed"
+msgstr "瞬き用のBlendShapeが削除・固定されています"
+
+#endregion
+
 # region ErrorReporter
 
 msgid "ErrorReporter:error.internal_error"