Merge branch 'main' into avatar_root_utils

CHANGELOG.md

@@ -8,10 +8,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [unreleased]
 
 ### Added
+- Added toplevel menu for manual bake avatar, even when MA is also installed (#35)
+- Added support for multiple ExportsPlugin declarations (#40)
+- Added additional convenience overloads for BeforePlugin and AfterPlugin
 
 ### Fixed
+- Create ApplyOnPlayGlobalActivator correctly when creating and opening scenes (#31)
+- Time resolution on the plugin sequence display is milliseconds, not 0.01 ms (#43)
+- BeforePlugin/AfterPlugin declarations don't work (#44)
 
 ### Changed
+- Position of the Plugin sequence display window is now preserved after restarting the Unity Editor (#42)
 
 ### Removed
 

Editor/API/Attributes/ExportsPlugin.cs

@@ -17,7 +17,7 @@ namespace nadena.dev.ndmf
     /// }
     /// </code>
     /// </summary>
-    [AttributeUsage(AttributeTargets.Assembly)]
+    [AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
     public sealed class ExportsPlugin : Attribute
     {
         public Type PluginType { get; }

Editor/API/BuildContext.cs

@@ -252,7 +252,7 @@ internal void RunPass(ConcretePass pass)
                 Stopwatch sw2 = new Stopwatch();
                 sw2.Start();
                 DeactivateExtensionContext(ty);
-                deactivationTimes = deactivationTimes.Add(ty, sw2.ElapsedMilliseconds);
+                deactivationTimes = deactivationTimes.Add(ty, sw2.Elapsed.TotalMilliseconds);
             }
 
             ImmutableDictionary<Type, double> activationTimes = ImmutableDictionary<Type, double>.Empty;
@@ -261,7 +261,7 @@ internal void RunPass(ConcretePass pass)
                 Stopwatch sw2 = new Stopwatch();
                 sw2.Start();
                 ActivateExtensionContext(ty);
-                activationTimes = activationTimes.Add(ty, sw2.ElapsedMilliseconds);
+                activationTimes = activationTimes.Add(ty, sw2.Elapsed.TotalMilliseconds);
             }
 
             Stopwatch passTimer = new Stopwatch();
@@ -283,7 +283,7 @@ internal void RunPass(ConcretePass pass)
 
             BuildEvent.Dispatch(new BuildEvent.PassExecuted(
                 pass.InstantiatedPass.QualifiedName,
-                passTimer.ElapsedMilliseconds,
+                passTimer.Elapsed.TotalMilliseconds,
                 activationTimes,
                 deactivationTimes
             ));

Editor/API/Fluent/PluginInfo.cs

@@ -1,5 +1,6 @@
 #region
 
+using System.Collections.Generic;
 using nadena.dev.ndmf.fluent;
 using nadena.dev.ndmf.model;
 
@@ -12,6 +13,7 @@ internal class PluginInfo
         private readonly SolverContext _solverContext;
         private readonly IPlugin _plugin;
         private int sequenceIndex = 0;
+        private HashSet<BuildPhase> _createdInnatePhases = new HashSet<BuildPhase>();
 
         public PluginInfo(SolverContext solverContext, IPlugin plugin)
         {

Editor/API/Fluent/Sequence/Constraints.cs

@@ -43,6 +43,12 @@ public Sequence BeforePlugin<T>(T plugin, [CallerFilePath] string sourceFile = "
         {
             return BeforePlugin(plugin.QualifiedName, sourceFile, sourceLine);
         }
+
+        public Sequence BeforePlugin<T>([CallerFilePath] string sourceFile = "",
+            [CallerLineNumber] int sourceLine = 0) where T : Plugin<T>, new()
+        {
+            return BeforePlugin(Plugin<T>.Instance.QualifiedName, sourceFile, sourceLine);
+        }
 
         public Sequence AfterPlugin(string qualifiedName, [CallerFilePath] string sourceFile = "",
             [CallerLineNumber] int sourceLine = 0)
@@ -64,6 +70,12 @@ public Sequence AfterPlugin<T>(T plugin, [CallerFilePath] string sourceFile = ""
         {
             return AfterPlugin(plugin.QualifiedName, sourceFile, sourceLine);
         }
+
+        public Sequence AfterPlugin<T>([CallerFilePath] string sourceFile = "",
+            [CallerLineNumber] int sourceLine = 0) where T : Plugin<T>, new()
+        {
+            return AfterPlugin(Plugin<T>.Instance.QualifiedName, sourceFile, sourceLine);
+        }
 
         public Sequence WaitFor<T>(T pass, [CallerFilePath] string sourceFile = "",
             [CallerLineNumber] int sourceLine = 0) where T : Pass<T>, new()

Editor/API/Fluent/Sequence/Sequence.cs

@@ -167,7 +167,7 @@ internal Sequence(BuildPhase phase, SolverContext solverContext, IPlugin plugin,
         private SolverPass CreateSequencingPass(string displayName, InlinePass callback, string sourceFile,
             int sourceLine)
         {
-            var anonPass = new AnonymousPass(_sequenceBaseName + "/anonymous#" + inlinePassIndex++, displayName,
+            var anonPass = new AnonymousPass(_sequenceBaseName + "/" + displayName + "#" + inlinePassIndex++, displayName,
                 callback);
             var pass = new SolverPass(_plugin, anonPass, _phase, _compatibleExtensions, _requiredExtensions);
             anonPass.IsPhantom = true;

Editor/API/Model/Constraint.cs

@@ -13,5 +13,10 @@ internal struct Constraint
         public int DeclaredLine;
         public PassKey First, Second;
         public ConstraintType Type;
+
+        public override string ToString()
+        {
+            return $"{First} {Type} {Second}";
+        }
     }
 }

Editor/API/Model/SolverContext.cs

@@ -45,6 +45,8 @@ public InnatePhases GetPluginPhases(BuildPhase phase, string pluginQualifiedName
             {
                 phases = new InnatePhases(phase, pluginQualifiedName);
                 _innatePhases[(pluginQualifiedName, phase)] = phases;
+                Passes.Add(phases.PluginStart);
+                Passes.Add(phases.PluginEnd);
             }
 
             return phases;

Editor/API/Model/SolverPass.cs

@@ -37,5 +37,10 @@ internal SolverPass(IPlugin plugin, IPass pass, BuildPhase phase, IImmutableSet<
             RequiredExtensions = requiredExtensions;
             CompatibleExtensions = compatibleExtensions;
         }
+
+        public override string ToString()
+        {
+            return Pass.DisplayName;
+        }
     }
 }

Editor/API/Solver/PluginResolver.cs

@@ -5,6 +5,7 @@
 using System.Collections.Immutable;
 using System.Linq;
 using nadena.dev.ndmf.model;
+using UnityEngine;
 
 #endregion
 
@@ -142,7 +143,15 @@ public PluginResolver(IEnumerable<IPlugin> pluginTemplates)
                     constraintsByPhase.TryGetValue(phase, out var constraintList)
                         ? constraintList
                         : new List<(SolverPass, SolverPass, ConstraintType)>();
-
+#if NDMF_INTERNAL_DEBUG
+                var dumpString = "";
+                foreach (var constraint in constraints)
+                {
+                    dumpString += $"\"{constraint.Item1.PassKey.QualifiedName}\" -> \"{constraint.Item2.PassKey.QualifiedName}\" [label=\"{constraint.Item3}\"];\n";
+                }
+                Debug.Log(dumpString);
+#endif
+
                 var sorted = TopoSort.DoSort(passes, constraints);
 
                 var concrete = ToConcretePasses(phase, sorted);

Editor/UI/Menus.cs

@@ -11,7 +11,9 @@ namespace nadena.dev.ndmf.ui
     internal static class Menus
     {
         private const string APPLY_ON_PLAY_MENU_NAME = "Tools/NDM Framework/Apply on Play";
+        private const string TOPLEVEL_MANUAL_BAKE_MENU_NAME = "Tools/NDM Framework/Manual bake avatar";
         private const int APPLY_ON_PLAY_PRIO = 1;
+        private const int TOPLEVEL_MANUAL_BAKE_PRIO = 2;
 
         [InitializeOnLoadMethod]
         static void Init()
@@ -24,18 +26,30 @@ static void Init()
         // so we'll keep that entry.
 #if !MODULAR_AVATAR
         [MenuItem("GameObject/[NDMF] Manual bake avatar", true, 49)]
-        internal static bool ValidateApplyToCurrentAvatarGameobject()
+        private static bool ValidateManualBakeGameObject()
         {
             return AvatarProcessor.CanProcessObject(Selection.activeGameObject);
         }
 
         [MenuItem("GameObject/[NDMF] Manual bake avatar", false, 49)]
-        public static void ApplyToCurrentAvatarGameobject()
+        private static void ManualBakeGameObject()
         {
             AvatarProcessor.ProcessAvatarUI(Selection.activeGameObject);
         }
 #endif
 
+        [MenuItem(TOPLEVEL_MANUAL_BAKE_MENU_NAME, true, TOPLEVEL_MANUAL_BAKE_PRIO)]
+        private static bool ValidateManualBakeToplevel()
+        {
+            return AvatarProcessor.CanProcessObject(Selection.activeGameObject);
+        }
+
+        [MenuItem(TOPLEVEL_MANUAL_BAKE_MENU_NAME, false, TOPLEVEL_MANUAL_BAKE_PRIO)]
+        private static void ManualBakeToplevel()
+        {
+            AvatarProcessor.ProcessAvatarUI(Selection.activeGameObject);
+        }
+
         [MenuItem(APPLY_ON_PLAY_MENU_NAME, false, APPLY_ON_PLAY_PRIO)]
         private static void ApplyOnPlay()
         {

README.md

@@ -15,7 +15,7 @@ Future plans include:
 
 ## Project status
 
-This project is currently in a pre-alpha state. Expect large-scale refactoring, including renaming of the project itself, in the coming weeks. The framework is however functional, and you can take a look at the draft PRs for [Modular Avatar](https://github.com/bdunderscore/modular-avatar/pull/406) and [AAO](https://github.com/anatawa12/AvatarOptimizer/pull/375) to see examples of usage.
+This project is currently considered API-stable, but is still very new. Please report any bugs you run into! 
 
 ## Getting started
 

Runtime/ApplyOnPlayGlobalActivator.cs

@@ -26,13 +26,9 @@ class ApplyOnPlayGlobalActivator : MonoBehaviour
 
         static ApplyOnPlayGlobalActivator()
         {
-            SceneManager.sceneLoaded += (scene, mode) =>
-            {
-                if (scene.IsValid())
-                {
-                    EditorApplication.delayCall += () => CreateIfNotPresent(scene);
-                }
-            };
+            void DelayCreateIfNotPresent(Scene scene) => EditorApplication.delayCall += () => CreateIfNotPresent(scene);
+            EditorSceneManager.newSceneCreated += (scene, setup, mode) => DelayCreateIfNotPresent(scene);
+            EditorSceneManager.sceneOpened += (scene, mode) => DelayCreateIfNotPresent(scene);
 
             EditorApplication.delayCall += () => CreateIfNotPresent(SceneManager.GetActiveScene());
         }

UnitTests~/PluginResolverTests/BeforeAfterPlugin.cs

@@ -0,0 +1,56 @@
+using System.Collections.Immutable;
+using System.Linq;
+using nadena.dev.ndmf;
+using NUnit.Framework;
+using PlasticPipe.PlasticProtocol.Messages;
+
+namespace UnitTests.PluginResolverTests
+{
+    class PluginA : Plugin<PluginA>
+    {
+        protected override void Configure()
+        {
+            InPhase(BuildPhase.Generating)
+                .AfterPlugin<PluginB>()
+                .Run("PluginA", _ctx => { });
+        }
+    }
+
+    class PluginB : Plugin<PluginB>
+    {
+        protected override void Configure()
+        {
+            InPhase(BuildPhase.Generating)
+                .Run("PluginB", _ctx => { });
+        }
+    }
+
+    class PluginC : Plugin<PluginC>
+    {
+        protected override void Configure()
+        {
+            InPhase(BuildPhase.Generating)
+                .BeforePlugin<PluginB>()
+                .Run("PluginC", _ctx => { });
+        }
+    }
+
+    public class BeforeAfterPlugin
+    {
+        [Test]
+        public void TestBeforeAfterPluginConstraints()
+        {
+            var resolver = new PluginResolver(new IPlugin[]
+            {
+                PluginA.Instance, PluginB.Instance, PluginC.Instance
+            });
+            var passNames = resolver.Passes.SelectMany(kv => kv.Item2)
+                .Select(pass => pass.Description)
+                .ToImmutableList();
+
+            var wantedPassNames = ImmutableList.Create("PluginC", "PluginB", "PluginA");
+
+            Assert.That(passNames, Is.EqualTo(wantedPassNames));
+        }
+    }
+}

UnitTests~/PluginResolverTests/SupportsMultipleDeclarations.cs

@@ -0,0 +1,43 @@
+using System.Collections.Immutable;
+using System.Linq;
+using nadena.dev.ndmf;
+using NUnit.Framework;
+using UnitTests.ExportsPluginTest;
+
+[assembly: ExportsPlugin(typeof(PluginA))]
+[assembly: ExportsPlugin(typeof(PluginB))]
+
+namespace UnitTests.ExportsPluginTest
+{
+    internal class PluginA : Plugin<PluginA>
+    {
+        protected override void Configure()
+        {
+            InPhase(BuildPhase.Transforming).Run("test", _ctx => { });
+        }
+    }
+
+    internal class PluginB : Plugin<PluginB>
+    {
+        protected override void Configure()
+        {
+            InPhase(BuildPhase.Transforming).Run("test", _ctx => { });
+        }
+    }
+
+    public class SupportsMultipleDeclarations
+    {
+        [Test]
+        public void TestSupportsMultipleDeclarations()
+        {
+            var resolver = new PluginResolver();
+            var plugins =
+                resolver.Passes.SelectMany(kv => kv.Item2) // passes per phase
+                    .Select(pass => pass.Plugin.GetType())
+                    .ToImmutableHashSet();
+
+            Assert.IsTrue(plugins.Contains(typeof(PluginA)));
+            Assert.IsTrue(plugins.Contains(typeof(PluginB)));
+        }
+    }
+}

docfx~/index.md

@@ -1,6 +1,6 @@
 # NDM Framework
 
-NFM Framework ("Nademof" for short) is a framework for running non-destructive build plugins when building avatars for
+NDM Framework ("Nademof" for short) is a framework for running non-destructive build plugins when building avatars for
 VRChat (and, eventually, for other VRSNS platforms).
 
 ## Why is this needed?
@@ -41,4 +41,4 @@ For more information, see the [API documentation](api/index.html) or the other a
 
 ## Support model
 
-NDMF is currently in an alpha state. The API is not fully stable yet - hopefully soon, though!
+See the [Versioning policy](versioning-policy.html) for more information.

docfx~/versioning-policy.md

@@ -16,6 +16,3 @@ are declared, the order of execution of the two passes is not fully determined.
 to determine the order of execution. NDMF will strive not to change this heuristic between patch releases, but it may
 change on minor releases. If you run into problems with changes in a heuristic, please constrain the order of execution
 of your passes explicitly.
-
-**Versions before 1.0.0**: Versions starting with 0.x.y are considered to be unstable and do not guarantee API stability.
-We will make a best-effort attempt to increment the "x" version when making incompatible changes.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "nadena.dev.ndmf",
   "displayName": "Non-Destructive Modular Framework",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "unity": "2019.4",
   "description": "A framework for building non-destructive plugins for VRChat Avatar 3.0",
   "vrchatVersion": "2022.1.1",