fix: RC-toggled audio sources are always active when animations are blocked (#1499)

Closes: #1496

CHANGELOG-PRERELEASE-jp.md

@@ -21,6 +21,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 　に対してはWrite Defaultsを調整しないように変更。
 - [#1429] Merge Armature は、特定の場合にPhysBoneに指定されたヒューマノイドボーンをマージできるようになりました。
   - 具体的には、子ヒューマノイドボーンがある場合はPhysBoneから除外される必要があります。
+- [#1499] `Object Toggle`で制御される`Audio Source`がアニメーションブロックされたときに常にアクティブにならないように、
+  アニメーションがブロックされたときにオーディオソースを無効にするように変更。
 - [#1489] `Merge Blend Tree` やリアクティブコンポーネントとMMDワールドの互換性の問題を修正。
   詳細は[ドキュメント](https://modular-avatar.nadena.dev/docs/general-behavior/mmd)を参照してください。
 

CHANGELOG-PRERELEASE.md

@@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   additive layers, or layers with only one state and no transitions.
 - [#1429] Merge Armature will now allow you to merge humanoid bones with PhysBones attached in certain cases.
     - Specifically, child humanoid bones (if there are any) must be excluded from all attached Physbones.
+- [#1499] When an audio source is controlled by an Object Toggle, disable the audio source when animations are blocked
+  to avoid it unintentionally being constantly active.
 
 ### Removed
 

CHANGELOG-jp.md

@@ -25,6 +25,8 @@ Modular Avatarの主な変更点をこのファイルで記録しています。
 　に対してはWrite Defaultsを調整しないように変更。
 - [#1429] Merge Armature は、特定の場合にPhysBoneに指定されたヒューマノイドボーンをマージできるようになりました。
   - 具体的には、子ヒューマノイドボーンがある場合はPhysBoneから除外される必要があります。
+- [#1499] `Object Toggle`で制御される`Audio Source`がアニメーションブロックされたときに常にアクティブにならないように、
+    アニメーションがブロックされたときにオーディオソースを無効にするように変更。
 
 ### Removed
 

CHANGELOG.md

@@ -28,6 +28,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   additive layers, or layers with only one state and no transitions.
 - [#1429] Merge Armature will now allow you to merge humanoid bones with PhysBones attached in certain cases.
   - Specifically, child humanoid bones (if there are any) must be excluded from all attached Physbones. 
+- [#1499] When an audio source is controlled by an Object Toggle, disable the audio source when animations are blocked
+  to avoid it unintentionally being constantly active.
 
 ### Removed
 

Editor/ReactiveObjects/AnimationGeneration/AnimatedProperty.cs

@@ -14,6 +14,8 @@ namespace nadena.dev.modular_avatar.core.editor
         // Objects which trigger deletion of this shape key. 
         public List<ReactionRule> actionGroups = new List<ReactionRule>();
 
+        public object? overrideStaticState = null;
+
         public AnimatedProperty(TargetProp key, float currentState)
         {
             TargetProp = key;

Editor/ReactiveObjects/AnimationGeneration/ReactiveObjectAnalyzer.cs

@@ -1,4 +1,5 @@
 #if MA_VRCSDK3_AVATARS
+using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Linq;
@@ -20,6 +21,9 @@ namespace nadena.dev.modular_avatar.core.editor
         private readonly ndmf.BuildContext _context;
         private readonly AnimatorServicesContext _asc;
         private readonly ReadablePropertyExtension _rpe;
+
+        private static readonly ImmutableHashSet<Type> ActiveObjectTypes =
+            new[] { typeof(AudioSource) }.ToImmutableHashSet();
         
         private Dictionary<string, float> _simulationInitialStates;
 
@@ -115,6 +119,8 @@ namespace nadena.dev.modular_avatar.core.editor
             FindObjectToggles(shapes, root);
             FindMaterialSetters(shapes, root);
 
+            InjectActiveObjectFallbacks(shapes);
+
             ApplyInitialStateOverrides(shapes);
             AnalyzeConstants(shapes); 
             ResolveToggleInitialStates(shapes);
@@ -124,6 +130,48 @@ namespace nadena.dev.modular_avatar.core.editor
             return result;
         }
 
+        private void InjectActiveObjectFallbacks(Dictionary<TargetProp, AnimatedProperty> shapes)
+        {
+            var injectedComponents = new List<Behaviour>();
+
+            foreach (var targetProp in shapes.Keys)
+            {
+                if (targetProp.TargetObject is GameObject go && targetProp.PropertyName == "m_IsActive")
+                {
+                    foreach (var ty in ActiveObjectTypes)
+                    {
+                        foreach (var c in go.GetComponentsInChildren(ty, true))
+                        {
+                            if (c is Behaviour b)
+                            {
+                                injectedComponents.Add(b);
+                            }
+                        }
+                    }
+                }
+            }
+
+            foreach (var component in injectedComponents)
+            {
+                var tp = new TargetProp
+                {
+                    TargetObject = component,
+                    PropertyName = "m_Enabled"
+                };
+                if (!shapes.TryGetValue(tp, out var shape))
+                {
+                    var currentState = component.enabled ? 1f : 0f;
+                    shape = new AnimatedProperty(tp, currentState);
+
+                    // Because we have no action groups, we'll reset current state in the base animation and otherwise
+                    // not touch the state.
+                    shapes[tp] = shape;
+                }
+
+                shape.overrideStaticState = 0f; // Static state is always off
+            }
+        }
+
         private void ApplyInitialStateOverrides(Dictionary<TargetProp, AnimatedProperty> shapes)
         {
             foreach (var prop in shapes.Values)
@@ -182,9 +230,9 @@ namespace nadena.dev.modular_avatar.core.editor
                     group.actionGroups.RemoveRange(0, lastAlwaysOnGroup - 1);
             }
 
-            // Remove shapes with no action groups
+            // Remove shapes with no action groups (unless we need to override static state)
             foreach (var kvp in shapes.ToList())
-                if (kvp.Value.actionGroups.Count == 0)
+                if (kvp.Value.actionGroups.Count == 0 && kvp.Value.overrideStaticState == null)
                     shapes.Remove(kvp.Key);
         }
 
@@ -290,7 +338,7 @@ namespace nadena.dev.modular_avatar.core.editor
             
             foreach (var (key, info) in shapes.ToList())
             {
-                if (info.actionGroups.Count == 0)
+                if (info.actionGroups.Count == 0 && info.overrideStaticState == null)
                 {
                     // never active control; ignore it entirely
                     if (OptimizeShapes) shapes.Remove(key);
@@ -305,9 +353,9 @@ namespace nadena.dev.modular_avatar.core.editor
                 initialStates[key] = initialState;
                 
                 // If we're now constant-on, we can skip animation generation
-                if (info.actionGroups[^1].IsConstant)
+                if (info.actionGroups.Count == 0 || info.actionGroups[^1].IsConstant)
                 {
-                    if (OptimizeShapes) shapes.Remove(key);
+                    if (OptimizeShapes && info.overrideStaticState == null) shapes.Remove(key);
                 }
             }
         }

Editor/ReactiveObjects/AnimationGeneration/ReactiveObjectPass.cs

@@ -145,6 +145,11 @@ namespace nadena.dev.modular_avatar.core.editor
                         applied = true;
                     }
                 }
+                else if (key.TargetObject is Component c)
+                {
+                    componentType = c.GetType();
+                    path = RuntimeUtil.RelativePath(context.AvatarRootObject, c.gameObject);
+                }
                 else
                 {
                     throw new InvalidOperationException("Invalid target object: " + key.TargetObject);
@@ -155,17 +160,19 @@ namespace nadena.dev.modular_avatar.core.editor
                     var serializedObject = new SerializedObject(key.TargetObject);
                     var prop = serializedObject.FindProperty(key.PropertyName);
 
+                    var staticState = shapes.GetValueOrDefault(key)?.overrideStaticState ?? initialState;
+
                     if (prop != null)
                     {
                         switch (prop.propertyType)
                         {
                             case SerializedPropertyType.Boolean:
                                 animBaseState = prop.boolValue ? 1.0f : 0.0f;
-                                prop.boolValue = ((float)initialState) > 0.5f;
+                                prop.boolValue = (float)staticState > 0.5f;
                                 break;
                             case SerializedPropertyType.Float:
                                 animBaseState = prop.floatValue;
-                                prop.floatValue = (float) initialState;
+                                prop.floatValue = (float)staticState;
                                 break;
                             case SerializedPropertyType.ObjectReference:
                                 animBaseState = prop.objectReferenceValue;
@@ -309,6 +316,12 @@ namespace nadena.dev.modular_avatar.core.editor
 
         private void ProcessShapeKey(AnimatedProperty info)
         {
+            if (info.actionGroups.Count == 0)
+            {
+                // This is present only to override the static state; skip animation generation
+                return;
+            }
+            
             // TODO: prune non-animated keys
             var asm = GenerateStateMachine(info);
             ApplyController(asm, "MA Responsive: " + info.TargetProp.TargetObject.name);

UnitTests~/ReactiveComponent/RCDisablesActiveComponentStaticStates.prefab.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 690477515e625a645bcd0977ed0d7f07
+PrefabImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

UnitTests~/ReactiveComponent/StaticStateTests.cs

@@ -0,0 +1,85 @@
+using System;
+using modular_avatar_tests;
+using nadena.dev.modular_avatar.core.editor;
+using NUnit.Framework;
+using UnityEditor;
+using UnityEditor.Animations;
+using UnityEngine;
+using UnityEngine.Animations;
+
+namespace UnitTests.ReactiveComponent
+{
+    public class StaticStateTests : TestBase
+    {
+        [Test]
+        public void DisablesStaticStateForActiveComponents()
+        {
+            var prefab = CreatePrefab("RCDisablesActiveComponentStaticStates.prefab");
+            
+            AvatarProcessor.ProcessAvatar(prefab);
+
+            AssertStaticState(prefab, "AudioSource", typeof(AudioSource), false, true);
+            AssertStaticState(prefab, "ParentConstraint", typeof(ParentConstraint), true, null);
+            AssertStaticState(prefab, "InitiallyDisabled", typeof(AudioSource), false, false);
+        }
+
+        [Test]
+        public void DoesntTouchNonToggled()
+        {
+            var prefab = CreatePrefab("RCDisablesActiveComponentStaticStates.prefab");
+            
+            AvatarProcessor.ProcessAvatar(prefab);
+
+            var fx = FindFxController(prefab);
+            var fxc = (AnimatorController)fx.animatorController;
+            var baseBlend = (BlendTree) fxc.layers[0].stateMachine.defaultState.motion;
+            var subBlend = (BlendTree) baseBlend.children[0].motion;
+            var animStateMotion = (AnimationClip) subBlend.children[0].motion;
+
+            foreach (var key in AnimationUtility.GetCurveBindings(animStateMotion))
+            {
+                Assert.IsFalse(key.path.StartsWith("Uncontrolled"));
+            }
+            
+            foreach (var b in prefab.transform.Find("Uncontrolled").GetComponentsInChildren<Behaviour>())
+            {
+                Assert.IsTrue(b.enabled);
+            }
+        }
+
+        [Test]
+        public void TracksChildComponents()
+        {
+            var prefab = CreatePrefab("RCDisablesActiveComponentStaticStates.prefab");
+            
+            AvatarProcessor.ProcessAvatar(prefab);
+
+            AssertStaticState(prefab, "Parent/Child", typeof(AudioSource), false, true);
+        }
+
+        private void AssertStaticState(GameObject prefab, string name, Type componentType, bool staticState, bool? animState)
+        {
+            var child = prefab.transform.Find(name);
+            
+            var component = (Behaviour) child.GetComponent(componentType);
+            
+            Assert.AreEqual(staticState, component.enabled);
+
+            var fx = FindFxController(prefab);
+            var fxc = (AnimatorController)fx.animatorController;
+            var baseBlend = (BlendTree) fxc.layers[0].stateMachine.defaultState.motion;
+            var subBlend = (BlendTree) baseBlend.children[0].motion;
+            var animStateMotion = (AnimationClip) subBlend.children[0].motion;
+
+            var binding = EditorCurveBinding.FloatCurve(name, componentType, "m_Enabled");
+            var curve = AnimationUtility.GetEditorCurve(animStateMotion, binding);
+            
+            Assert.AreEqual(animState == null, curve == null);
+            if (animState == null) return;
+            
+            var value = curve.keys[0].value;
+            
+            Assert.AreEqual(animState, value > 0.5f);
+        }
+    }
+}

UnitTests~/ReactiveComponent/StaticStateTests.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: bfd3e108cb57436f8bcf47bcc8f896be
+timeCreated: 1742006984