Merge remote-tracking branch 'origin/develop' into feature/taskBundles

# Conflicts:
#	Assets/Virtual Agents Framework/Runtime/Scripts/FundamentalAgentTasks/AgentMovementTask.cs

.gitignore

@@ -85,5 +85,9 @@ crashlytics-build.properties
 
 # Samples from imported packages
 /Assets/Samples/*
+/Assets/Samples.meta
+
+
+# Files generated by documentation tool
 /Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj
-/Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj.meta
+/Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj.meta

Assets/Automation/Automation.asmdef

@@ -0,0 +1,18 @@
+{
+    "name": "Automation",
+    "rootNamespace": "",
+    "references": [
+        "GUID:478a2357cc57436488a56e564b08d223"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Assets/Automation/PackageExporter.cs

@@ -0,0 +1,226 @@
+using System.Collections;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using Unity.EditorCoroutines.Editor;
+using UnityEditor;
+using UnityEditor.Build;
+using UnityEditor.TestTools.TestRunner.Api;
+using UnityEngine;
+
+
+namespace InternalTools
+{
+    /// <summary>
+    /// This class is used to prepare the Virtual Agents Framework for release.
+    /// These methods will not be displayed when the package is used by other projects, as they are not in the Assets folder.
+    /// It uses the C# class System.IO to rename the Samples folder to Samples~ and back.
+    /// The SAMPLES_PACKAGED define is set and removed to enable/disable the tests that run on the samples.
+    /// Based on the define, only the right method (Release/Development) will be displayed in the Unity Editor.
+    /// </summary>
+    public class PackageExporter : EditorWindow
+    {
+        static readonly string path = "Assets/Virtual Agents Framework";
+
+#if !SAMPLES_PACKAGED
+        [MenuItem("Virtual Agents Framework/Prepare for release")]
+        static void RenameForRelease()
+        {
+            bool confirm = EditorUtility.DisplayDialog("Prepare For Release: Save All Changes?",
+                "In the process of preparing the package for release all changes will be saved. Are you sure you want to do that?",
+                "Save All",
+                "Do Not Save");
+            if (!confirm)
+            {
+                Debug.LogWarning("Preparation for release cancelled.");
+                return;
+            }
+            int confirm2 = EditorUtility.DisplayDialogComplex("Prepare For Release: Run Tests Now?",
+                "To make sure that everything works as intended all test cases have to be run once. Are you sure you want to do that now? Please watch out for unrecognized errors in the test runs.",
+                "Run All Tests in Build",
+                "Do Not Run Tests",
+                "Run All Tests in Editor");
+            switch (confirm2)
+            {
+                case 0:
+                    TestRunnerApi api = RunAllTests(BuildTarget.StandaloneWindows);
+                    api.RegisterCallbacks(new RenameForReleaseTestCallbacks());
+                    break;
+                case 1:
+                    UnityEngine.Debug.LogWarning("Preparation for release cancelled.");
+                    return;
+                case 2:
+                    TestRunnerApi api2 = RunAllTests();
+                    api2.RegisterCallbacks(new RenameForReleaseTestCallbacks());
+                    break;
+            }
+        }
+        static IEnumerator AllTestsPassed()
+        {
+            yield return new EditorWaitForSeconds(1.0f);
+
+            bool confirm = EditorUtility.DisplayDialog("Prepare For Release: All Tests Passed, Continue?",
+                "All automatic test runs passed the predefined asserts. If you didn't notice anything unusal, all prepartions can now be completed.",
+                "Continue",
+                "Abort");
+            if (!confirm)
+            {
+                UnityEngine.Debug.LogWarning("Preparation for release cancelled.");
+            }
+            else
+            {
+                yield return new EditorWaitForSeconds(0.25f);
+                // Save all changes so that potential saves in the samples are not lost
+                AssetDatabase.SaveAssets();
+                UnityEngine.Debug.Log("1/3 Renaming \"Samples\" to \"Samples~\"");
+                Directory.Move(path + "/Samples", path + "/Samples~");
+                UnityEngine.Debug.Log("2/3 Deleting old Samples.meta");
+                File.Delete(path + "/Samples.meta");
+
+                UnityEngine.Debug.Log("3/3 Setting \"SAMPLES_PACKAGED\" define.");
+                SetScriptDefine("SAMPLES_PACKAGED");
+                AssetDatabase.Refresh();
+                UnityEngine.Debug.Log("Preparation for release finished. Unity should start to recompile soon...");
+            }
+        }
+
+        private class RenameForReleaseTestCallbacks : ICallbacks
+        {
+            public void RunStarted(ITestAdaptor testsToRun)
+            {
+                Debug.Log("Running all scene validations...");
+            }
+
+            public void RunFinished(ITestResultAdaptor result)
+            {
+                Debug.Log($"Done with scene validation. Overall result: {result.TestStatus}");
+                if (result.TestStatus == TestStatus.Passed)
+                {
+                    EditorCoroutineUtility.StartCoroutineOwnerless(AllTestsPassed());
+                }
+            }
+
+            public void TestStarted(ITestAdaptor test)
+            {
+            }
+
+            public void TestFinished(ITestResultAdaptor result)
+            {
+                if (result.TestStatus == TestStatus.Failed)
+                {
+                    Debug.Log($"Failed {result.Name}: {result.Message}");
+                    UnityEngine.Debug.LogWarning("Preparation for release cancelled.");
+                }
+            }
+        }
+
+#endif
+#if SAMPLES_PACKAGED
+        [MenuItem("Virtual Agents Framework/Prepare for development")]
+        static void RenameForDevelopment()
+        {
+            bool confirm = EditorUtility.DisplayDialog("Prepare For Development: Save All Changes?", "In the process of preparing the package for development all changes will be saved. Are you sure you want to do that?", "Save All", "Do Not Save");
+            if (!confirm)
+            {
+                UnityEngine.Debug.LogWarning("Preparation for release cancelled.");
+                return;
+            }
+            UnityEngine.Debug.Log("1/2 Renaming \"Samples~\" to \"Samples\"");
+            Directory.Move(path + "/Samples~", path + "/Samples");
+            // Unity will automatically create a new Samples.meta file, so we don't need to do that.
+            // Samples~ doesn't have a Samples.meta file, so we don't need to delete it.
+            UnityEngine.Debug.Log("2/2 Removing \"SAMPLES_PACKAGED\" define.");
+            RemoveScriptDefine("SAMPLES_PACKAGED"); // This will also save all assets to save the change in the project settings
+            AssetDatabase.Refresh();
+            UnityEngine.Debug.Log("Preparation for development finished. Unity should start to recompile soon...");
+        }
+#endif
+
+        static void SetScriptDefine(string addDefine)
+        {
+            PlayerSettings.GetScriptingDefineSymbols(NamedBuildTarget.Standalone, out string[] defines);
+            List<string> definesList = defines.ToList();
+            // If the define is already set, remove all occurrences of it and add it again
+            definesList.RemoveAll(o => o == addDefine);
+            //Add new define
+            definesList.Add(addDefine);
+
+            PlayerSettings.SetScriptingDefineSymbols(NamedBuildTarget.Standalone, definesList.ToArray());
+            // Check that everything went correctly
+            PlayerSettings.GetScriptingDefineSymbols(NamedBuildTarget.Standalone, out defines);
+            DebugDefinesArray(defines);
+            AssetDatabase.SaveAssets();
+        }
+
+        static void RemoveScriptDefine(string removeDefine)
+        {
+            PlayerSettings.GetScriptingDefineSymbols(NamedBuildTarget.Standalone, out string[] defines);
+            defines = defines.Where(o => o != removeDefine).ToArray();
+            DebugDefinesArray(defines);
+            PlayerSettings.SetScriptingDefineSymbols(NamedBuildTarget.Standalone, defines);
+            AssetDatabase.SaveAssets();
+        }
+
+        static void DebugDefinesArray(string[] array)
+        {
+            string s = "Currently set Defines:  ";
+            foreach (string d in array)
+            {
+                s = s + d + ", ";
+            }
+            s = s.Substring(0, s.Length - 2);
+            UnityEngine.Debug.Log(s);
+        }
+
+
+        public static TestRunnerApi RunAllTests(BuildTarget? target = null)
+        {
+            var testRunnerApi = ScriptableObject.CreateInstance<TestRunnerApi>();
+            ExecutionSettings settings = new ExecutionSettings(new Filter()
+            {
+                testMode = TestMode.PlayMode,
+                targetPlatform = target
+            });
+
+            testRunnerApi.Execute(settings);
+            return testRunnerApi;
+        }
+
+        [MenuItem("Virtual Agents Framework/Tests/Run all tests in editor")]
+        public static void RunAllTestsFromMenu()
+        {
+            TestRunnerApi api = RunAllTests();
+            api.RegisterCallbacks(new Callbacks());
+        }
+        [MenuItem("Virtual Agents Framework/Tests/Run all tests in build")]
+        public static void RunAllTestsFromMenuBuild()
+        {
+            TestRunnerApi api = RunAllTests(BuildTarget.StandaloneWindows);
+            api.RegisterCallbacks(new Callbacks());
+        }
+        private class Callbacks : ICallbacks
+        {
+            public void RunStarted(ITestAdaptor testsToRun)
+            {
+                Debug.Log("Running all scene validations...");
+            }
+
+            public void RunFinished(ITestResultAdaptor result)
+            {
+                Debug.Log($"Done with scene validation. Overall result: {result.TestStatus}");
+            }
+
+            public void TestStarted(ITestAdaptor test)
+            {
+            }
+
+            public void TestFinished(ITestResultAdaptor result)
+            {
+                if (result.TestStatus == TestStatus.Failed)
+                {
+                    Debug.Log($"Failed {result.Name}: {result.Message}");
+                }
+            }
+        }
+    }
+}

Assets/Virtual Agents Framework/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 This document keeps track of the changes between versions of the framework.
 
+## 1.2.1 (2024-03-18)
+
+### Added
+- Quality of life enhancements regarding the AdaptiveGaze feature
+	- Start and Stop tasks
+	- Autonomous gaze behavior can be overwritten with a specific target object
+- Item pickup system now offers additional generic mesh sockets for less common item storage positions
+- Automatic import feature for humanoid 3D models to turn them into fully functional agents
+- Quick start guide introducing the first concepts and further documentation
+- Documentation example for importing ReadyPlayerMe avatars and converting them to agents
+
+### Changes
+- Streamlined the setup process of a new agent
+- AI navigation package is now correctly defined in the package dependencies
+- Temporarily removed the behavior tree implementation so that compilations for devices work
+- Aiming during animation tasks now considers the animation length
+- Bone presets for aiming are not organized into own classes instead of string comparisons
+- Unit tests now ensure the functionality of the sample scenes
+- Documentation and sample scenes were updated
+
 ## 1.2.0 (2023-11-19)
 
 ### Added

Assets/Virtual Agents Framework/Documentation~/Virtual-Agents-Framework.md

@@ -1,3 +1,3 @@
 # Documentation of the i5 Virtual Agents Framework
 
-Click [here](https://rwth-acis.github.io/Virtual-Agents-Framework/1.2.0/index.html) to go to the documentation pages for version 1.2.0 of the framework.
+Click [here](https://rwth-acis.github.io/Virtual-Agents-Framework/1.2.1/index.html) to go to the documentation pages for version 1.2.1 of the framework.