Migrate from unused bones by reference

.docs/content/docs/reference/trace-and-optimize/index.ja.md

@@ -19,6 +19,8 @@ aliases:
   アニメーションなどで使われていないBlendShapeを自動的に固定・除去します。
 - `使われていないObjectを自動的に削除する`
   アニメーションなどを走査して、使われていないObjectを自動的に削除します。
+  - `endボーンを残す`
+    チェックされている場合、親が削除されていないendボーン[^endbone]を削除しません。
 
 また、以下の設定で自動設定を調節できます。
 - `MMDワールドとの互換性`
@@ -28,3 +30,5 @@ aliases:
 それらの機能については英語のTooltipやソースコード、または開発者の指示を参考にしてください。
 
 ![component.png](component.png)
+
+[^endbone]: AAOは名前が`end`で終わる(大文字小文字区別なし)ボーンをendボーンだとみなします。

.docs/content/docs/reference/trace-and-optimize/index.md

@@ -19,6 +19,8 @@ Currently the following optimizations are applied automatically.
   Automatically freezes unused BlendShapes in animation or else.
 - `Remove unused Objects`
   By scanning animation, etc., Automatically removes unused Objects.
+  - `Preserve EndBone`
+    If checked, this tool does not remove end bones[^endbone] if parent is not removed.
 
 Also, You can adjust optimization with the following settings
 - `MMD World Compatibility`
@@ -28,3 +30,5 @@ In addition, there is `Advanced Settings` which is for workaround bugs but it's
 See tooltips or implementation for more details.
 
 ![component.png](component.png)
+
+[^endbone]: AAO currently assumes any bones with name ends with `end` (ignoring case) are end bone.

.docs/content/docs/reference/unused-bones-by-references-tool/index.ja.md

@@ -9,6 +9,13 @@ EditorOnlyなメッシュからしか参照がないボーンをEditorOnlyにし
 
 このコンポーネントは[Avatar Global Component](../../component-kind/avatar-global-components)であるため、アバターのルートに追加してください。
 
+{{< hint info >}}
+
+このコンポーネントは時代遅れです。[Trace and Optimize](../trace-and-optimize)の`使われていないObjectを自動的に削除する`を使用してください。
+このコンポーネントが改善されることはありません。
+
+{{< /hint >}}
+
 これはNarazakaさんの[UnusedBonesByReferencesTool][UnusedBonesByReferencesTool]を移植したものですが、ビルド時に実行します。
 
 [UnusedBonesByReferencesTool]: https://narazaka.booth.pm/items/3831781

.docs/content/docs/reference/unused-bones-by-references-tool/index.md

@@ -9,6 +9,13 @@ Marks it as EditorOnly that bones referenced only from EditorOnly meshes.
 
 This component is [Avatar Global Component](../../component-kind/avatar-global-components), so this should be added to an avatar root.
 
+{{< hint info >}}
+
+This component is obsolete. You should use `Remove unused Objects` of [Trace and Optimize](../trace-and-optimize) instead.
+This component will never get algorithm improvements.
+
+{{< /hint >}}
+
 This is port of [UnusedBonesByReferencesTool by Narazaka][UnusedBonesByReferencesTool] but run at build time.
 
 [UnusedBonesByReferencesTool]: https://narazaka.booth.pm/items/3831781

CHANGELOG-PRERELEASE.md

@@ -8,10 +8,15 @@ The format is based on [Keep a Changelog].
 
 ## [Unreleased]
 ### Added
+- Preserve end bones in Remove Unused Objects `#430`
+  - This does same thing as `Preserve end bones` in UnusedBonesByReferenceTool.
 
 ### Changed
 
 ### Deprecated
+- UnusedBonesByReferenceTool component is now obsolete `#430`
+  - Newly introduced `Remove Unused Objects` does same thing with more powerful algorithm!
+  - You can migrate to `Remove Unused Objects` only with one click!
 
 ### Removed
 

CHANGELOG.md

@@ -19,9 +19,13 @@ The format is based on [Keep a Changelog].
 - Improved 'Remove Unused Objects' `#401`
   - Remove Unused Objects now removes unnecessary Components & Bones!
   - You may use `Use Legacy GC` to use legacy algotythm for Remove Unused Objects in `Advanced Settings` (`#419`)
+  - With new algorithm, you can preserve end bones (`#430`)
 - Performance: Share MeshInfo2 between SkinnedMesh processing and MergeBone `#421`
 
 ### Deprecated
+- UnusedBonesByReferenceTool component is now obsolete `#430`
+  - Newly introduced `Remove Unused Objects` does same thing with more powerful algorithm!
+  - You can migrate to `Remove Unused Objects` only with one click!
 
 ### Removed
 

Editor/AutomaticConfiguration.cs

@@ -9,6 +9,7 @@ internal class TraceAndOptimizeEditor : AvatarGlobalComponentEditorBase
     {
         private SerializedProperty _freezeBlendShape;
         private SerializedProperty _removeUnusedObjects;
+        private SerializedProperty _preserveEndBone;
         private SerializedProperty _mmdWorldCompatibility;
         private SerializedProperty _advancedAnimatorParser;
         private SerializedProperty _advancedSettings;
@@ -18,6 +19,7 @@ private void OnEnable()
         {
             _freezeBlendShape = serializedObject.FindProperty(nameof(TraceAndOptimize.freezeBlendShape));
             _removeUnusedObjects = serializedObject.FindProperty(nameof(TraceAndOptimize.removeUnusedObjects));
+            _preserveEndBone = serializedObject.FindProperty(nameof(TraceAndOptimize.preserveEndBone));
             _mmdWorldCompatibility = serializedObject.FindProperty(nameof(TraceAndOptimize.mmdWorldCompatibility));
             _advancedAnimatorParser = serializedObject.FindProperty(nameof(TraceAndOptimize.advancedAnimatorParser));
             _advancedSettings = serializedObject.FindProperty(nameof(TraceAndOptimize.advancedSettings));
@@ -33,6 +35,12 @@ protected override void OnInspectorGUIInner()
             GUILayout.Label("Features", EditorStyles.boldLabel);
             EditorGUILayout.PropertyField(_freezeBlendShape);
             EditorGUILayout.PropertyField(_removeUnusedObjects);
+            if (_removeUnusedObjects.boolValue)
+            {
+                EditorGUI.indentLevel++;
+                EditorGUILayout.PropertyField(_preserveEndBone);
+                EditorGUI.indentLevel--;
+            }
 
             _advancedSettingsLabel.text = CL4EE.Tr("TraceAndOptimize:prop:advancedSettings");
             if (EditorGUILayout.PropertyField(_advancedSettings, _advancedSettingsLabel, false))

Editor/Processors/TraceAndOptimize/ComponentDependencyCollector.cs

@@ -28,6 +28,13 @@ static ComponentDependencyCollector()
             InitByTypeParsers();
         }
 
+        private readonly bool _preserveEndBone;
+
+        public ComponentDependencyCollector(bool preserveEndBone)
+        {
+            _preserveEndBone = preserveEndBone;
+        }
+
         private readonly Dictionary<Component, ComponentDependencies> _dependencies =
             new Dictionary<Component, ComponentDependencies>();
 
@@ -221,6 +228,15 @@ private static void InitByTypeParsers()
             AddParser<Transform>((collector, deps, transform) =>
             {
                 deps.AddAlwaysDependency(transform.parent);
+
+                // For compatibility with UnusedBonesByReferenceTool
+                // https://github.com/anatawa12/AvatarOptimizer/issues/429
+                if (collector._preserveEndBone &&
+                    transform.name.EndsWith("end", StringComparison.OrdinalIgnoreCase))
+                {
+                    collector.GetDependencies(transform.parent)
+                        .AddAlwaysDependency(transform);
+                }
             });
             // Animator does not do much for motion, just changes states of other components.
             // All State Changes are collected separately

Editor/Processors/TraceAndOptimize/FindUnusedObjectsProcessor.cs

@@ -14,14 +14,17 @@ class FindUnusedObjectsProcessor
         private readonly ImmutableModificationsContainer _modifications;
         private readonly OptimizerSession _session;
         private readonly HashSet<GameObject> _exclusions;
+        private readonly bool _preserveEndBone;
         private readonly bool _useLegacyGC;
 
         public FindUnusedObjectsProcessor(ImmutableModificationsContainer modifications, OptimizerSession session,
+            bool preserveEndBone,
             bool useLegacyGC,
             HashSet<GameObject> exclusions)
         {
             _modifications = modifications;
             _session = session;
+            _preserveEndBone = preserveEndBone;
             _useLegacyGC = useLegacyGC;
             _exclusions = exclusions;
         }
@@ -78,7 +81,7 @@ private void MarkComponent(Component component, bool ifTargetCanBeEnabled)
         private void ProcessNew()
         {
             // first, collect usages
-            var collector = new ComponentDependencyCollector();
+            var collector = new ComponentDependencyCollector(_preserveEndBone);
             collector.CollectAllUsages(_session);
 
             // then, mark and sweep.

Editor/Processors/TraceAndOptimize/TraceAndOptimizeProcessor.cs

@@ -28,8 +28,10 @@ public void ProcessLater(OptimizerSession session)
             if (_config is null) return;
 
             if (_config.removeUnusedObjects)
-                new FindUnusedObjectsProcessor(_modifications, session, _config.advancedSettings.useLegacyGc,
-                    _exclusions).Process();
+                new FindUnusedObjectsProcessor(_modifications, session, 
+                    preserveEndBone: _config.preserveEndBone,
+                    useLegacyGC: _config.advancedSettings.useLegacyGc,
+                    exclusions: _exclusions).Process();
 
         }
     }

Editor/UnusedBonesByReferencesToolEditor.cs

@@ -0,0 +1,64 @@
+using Anatawa12.AvatarOptimizer.Processors;
+using CustomLocalization4EditorExtension;
+using UnityEditor;
+using UnityEngine;
+
+namespace Anatawa12.AvatarOptimizer
+{
+    [CustomEditor(typeof(UnusedBonesByReferencesTool))]
+    class UnusedBonesByReferencesToolEditor : AvatarGlobalComponentEditorBase
+    {
+        private SerializedProperty _preserveEndBone;
+        private SerializedProperty _detectExtraChild;
+
+        private void OnEnable()
+        {
+            _preserveEndBone = serializedObject.FindProperty(nameof(UnusedBonesByReferencesTool.preserveEndBone));
+            _detectExtraChild = serializedObject.FindProperty(nameof(UnusedBonesByReferencesTool.detectExtraChild));
+        }
+
+        protected override void OnInspectorGUIInner()
+        {
+            EditorGUILayout.PropertyField(_preserveEndBone);
+            EditorGUILayout.PropertyField(_detectExtraChild);
+
+            EditorGUILayout.HelpBox(CL4EE.Tr("UnusedBonesByReferencesTool:suggestMigrate"), MessageType.Info);
+            if (GUILayout.Button(CL4EE.Tr("UnusedBonesByReferencesTool:migrate")))
+            {
+                const string CONTENT_UNDO_NAME = "Migrate UnusedBonesByReferencesTool to Trace and Optimize";
+
+                var component = (UnusedBonesByReferencesTool)target;
+
+                // first, migrate configuration
+                var traceAndOptimize = component.GetComponent<TraceAndOptimize>();
+                if (!traceAndOptimize)
+                    traceAndOptimize = Undo.AddComponent<TraceAndOptimize>(component.gameObject);
+                Undo.RecordObject(traceAndOptimize, CONTENT_UNDO_NAME);
+
+                traceAndOptimize.removeUnusedObjects = true;
+                traceAndOptimize.advancedSettings.useLegacyGc = false;
+                traceAndOptimize.preserveEndBone = component.preserveEndBone;
+                PrefabUtility.RecordPrefabInstancePropertyModifications(traceAndOptimize);
+
+                // then, remove EditorOnly from bones
+                foreach (var boneReference in UnusedBonesByReferencesToolEarlyProcessor.BoneReference
+                             .Make(component.transform))
+                {
+                    if (boneReference.Bone.CompareTag("EditorOnly"))
+                    {
+                        Undo.RecordObject(boneReference.Bone, CONTENT_UNDO_NAME);
+                        boneReference.Bone.tag = "Untagged";
+                        PrefabUtility.RecordPrefabInstancePropertyModifications(boneReference.Bone);
+                    }
+                }
+
+                Undo.DestroyObjectImmediate(component);
+                Undo.SetCurrentGroupName(CONTENT_UNDO_NAME);
+
+                EditorUtility.DisplayDialog(CL4EE.Tr("UnusedBonesByReferencesTool:migrationFinished:title"),
+                    CL4EE.Tr("UnusedBonesByReferencesTool:migrationFinished:description"),
+                    "Ok");
+            }
+        }
+    }
+}

Localization/en.po

@@ -350,6 +350,21 @@ msgstr "Detect Extra Children"
 msgid "UnusedBonesByReferencesTool:tooltip:detectExtraChild"
 msgstr "If checked, this tool does not remove bones with non-bone children."
 
+msgid "UnusedBonesByReferencesTool:suggestMigrate"
+msgstr ""
+"UnusedBonesByReferencesTool is obsoleted by more intelligent Trace and Optimize!\n"
+"Do you want to migrate to Trace and Optimize with clicking the button below?"
+
+msgid "UnusedBonesByReferencesTool:migrate"
+msgstr "Migrate to Trace and Optimize"
+
+msgid "UnusedBonesByReferencesTool:migrationFinished:title"
+msgstr "Migration Finished!"
+
+msgid "UnusedBonesByReferencesTool:migrationFinished:description"
+msgstr "Migrating to Trace and Optimize is finished!"
+
+
 # endregion
 
 # region TraceAndOptimize
@@ -381,6 +396,12 @@ msgid "TraceAndOptimize:warn:unknown-type"
 msgstr "Unknown Component Type '{0}' Found. This will reduce optimization performance and may break your Avatar."
 "If your avatar got broken, Please report this error to AvatarOptimizer!"
 
+msgid "TraceAndOptimize:prop:preserveEndBone"
+msgstr "Preserve EndBone"
+
+msgid "TraceAndOptimize:tooltip:preserveEndBone"
+msgstr "If checked, this tool does not remove end bones with active parent."
+
 # endregion
 
 #region ApplyObjectMapping

Localization/ja.po

@@ -287,6 +287,20 @@ msgstr "他の子オブジェクトを認識する"
 msgid "UnusedBonesByReferencesTool:tooltip:detectExtraChild"
 msgstr "チェックされている場合、子にボーン以外を持つボーンを削除しません。"
 
+msgid "UnusedBonesByReferencesTool:suggestMigrate"
+msgstr ""
+"UnusedBonesByReferencesToolはさらに賢く使用していないなボーンなどを削除するTrace and Optimizeに置き換えられました！\n"
+"下のボタンを押すことでTrace and Optimizeに置き換えませんか"
+
+msgid "UnusedBonesByReferencesTool:migrate"
+msgstr "Trace and Optimizeに変換する"
+
+msgid "UnusedBonesByReferencesTool:migrationFinished:title"
+msgstr "変換完了"
+
+msgid "UnusedBonesByReferencesTool:migrationFinished:description"
+msgstr "Trace and Optimizeへの変換が完了しました！"
+
 # endregion
 
 # region TraceAndOptimize
@@ -318,6 +332,12 @@ msgid "TraceAndOptimize:warn:unknown-type"
 msgstr "未知のコンポーネント'{0}'を検出しました! これにより最適化処理の品質が低下し、処理後のアバターが壊れる可能性があります。(元のアバターには影響しません)"
 "アバターが壊れた場合、これをAvatarOptimizerに報告してください!"
 
+msgid "TraceAndOptimize:prop:preserveEndBone"
+msgstr "endボーンを残す"
+
+msgid "TraceAndOptimize:tooltip:preserveEndBone"
+msgstr "チェックされている場合、親がactiveなendボーンを削除しません。"
+
 # endregion
 
 #region ApplyObjectMapping

Runtime/TraceAndOptimize.cs

@@ -17,6 +17,12 @@ internal class TraceAndOptimize : AvatarGlobalComponent
         [ToggleLeft]
         public bool removeUnusedObjects = true;
 
+        // Remove Unused Objects Options
+        [CL4EELocalized("TraceAndOptimize:prop:preserveEndBone",
+            "TraceAndOptimize:tooltip:preserveEndBone")]
+        [ToggleLeft]
+        public bool preserveEndBone;
+
         // common parsing configuration
         [CL4EELocalized("TraceAndOptimize:prop:mmdWorldCompatibility",
             "TraceAndOptimize:tooltip:mmdWorldCompatibility")]

Runtime/UnusedBonesByReferencesTool.cs

@@ -1,3 +1,4 @@
+using System;
 using CustomLocalization4EditorExtension;
 using UnityEngine;
 
@@ -6,6 +7,7 @@ namespace Anatawa12.AvatarOptimizer
     [AddComponentMenu("Avatar Optimizer/AAO UnusedBonesByReferencesTool")]
     [DisallowMultipleComponent]
     [HelpURL("https://vpm.anatawa12.com/avatar-optimizer/ja/docs/reference/unused-bones-by-references-tool/")]
+    [Obsolete("Obsoleted by Trace and Optimize")]
     internal class UnusedBonesByReferencesTool : AvatarGlobalComponent
     {
         [CL4EELocalized("UnusedBonesByReferencesTool:prop:preserveEndBone",