Merge pull request #8127 from Unity-Technologies/internal/master

Internal/master

Author: UnityAljosha

Packages/com.unity.render-pipelines.core/Editor/CoreEditorUtils.cs

@@ -863,7 +863,7 @@ static bool HandleEvent(bool state, Rect activationRect, Action<Vector2> context
             return state;
         }
 
-        static void ShowHelpButton(Rect contextMenuRect, string documentationURL, GUIContent title)
+        internal static void ShowHelpButton(Rect contextMenuRect, string documentationURL, GUIContent title)
         {
             if (string.IsNullOrEmpty(documentationURL))
                 return;

Packages/com.unity.render-pipelines.core/Editor/Debugging/DebugWindow.cs

@@ -11,7 +11,6 @@
 using UnityEngine;
 using UnityEngine.Assertions;
 using UnityEngine.Rendering;
-using PackageInfo = UnityEditor.PackageManager.PackageInfo;
 
 namespace UnityEditor.Rendering
 {
@@ -44,7 +43,8 @@ void OnEnable()
             hideFlags = HideFlags.HideAndDontSave;
         }
     }
-
+    
+    [CoreRPHelpURL("Rendering-Debugger")]
     sealed class DebugWindow : EditorWindowWithHelpButton, IHasCustomMenu
     {
         static Styles s_Styles;
@@ -76,37 +76,6 @@ public static bool open
             private set => DebugManager.instance.displayEditorUI = value;
         }
 
-        protected override void OnHelpButtonClicked()
-        {
-            //Deduce documentation url and open it in browser
-            var url = GetSpecificURL() ?? GetDefaultURL();
-            Application.OpenURL(url);
-        }
-
-        string GetDefaultURL()
-        {
-            //Find package info of the current CoreRP package
-            return $"https://docs.unity3d.com/Packages/com.unity.render-pipelines.core@{DocumentationInfo.version}/manual/Rendering-Debugger.html";
-        }
-
-        string GetSpecificURL()
-        {
-            //Find package info of the current RenderPipeline
-            var currentPipeline = GraphicsSettings.currentRenderPipeline;
-            if (currentPipeline == null)
-                return null;
-
-            if (!DocumentationUtils.TryGetPackageInfoForType(currentPipeline.GetType(), out var packageName, out var version))
-                return null;
-
-            return packageName switch
-            {
-                "com.unity.render-pipelines.universal" => $"https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@{version}/manual/features/rendering-debugger.html",
-                "com.unity.render-pipelines.high-definition" => $"https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@{version}/manual/Render-Pipeline-Debug-Window.html",
-                _ => null
-            };
-        }
-
         [DidReloadScripts]
         static void OnEditorReload()
         {
@@ -508,10 +477,23 @@ void OnGUI()
                 {
                     using (new EditorGUILayout.VerticalScope())
                     {
-                        const float leftMargin = 4f;
-                        GUILayout.Space(leftMargin);
                         var selectedPanel = panels[m_Settings.selectedPanel];
+                        
+                        using (new EditorGUILayout.HorizontalScope())
+                        {
+                            var style = new GUIStyle(CoreEditorStyles.sectionHeaderStyle) { fontStyle = FontStyle.Bold };
+                            EditorGUILayout.LabelField(new GUIContent(selectedPanel.displayName), style);
+                            
+                            // Context menu
+                            var rect = GUILayoutUtility.GetLastRect();
+                            var contextMenuRect = new Rect(rect.xMax, rect.y + 4f, 16f, 16f);
+                            
+                            CoreEditorUtils.ShowHelpButton(contextMenuRect, selectedPanel.documentationUrl, new GUIContent($"{selectedPanel.displayName} panel."));
+                        }
 
+                        const float leftMargin = 4f;
+                        GUILayout.Space(leftMargin);
+                        
                         using (var scrollScope = new EditorGUILayout.ScrollViewScope(m_ContentScroll))
                         {
                             TraverseContainerGUI(selectedPanel);

Packages/com.unity.render-pipelines.core/Editor/Lighting/ProbeVolume/ProbeVolumeEditor.cs

@@ -123,7 +123,7 @@ internal static void FrameSettingDisabledHelpBox()
                 var k_EnsureFrameSetting = Type.GetType("UnityEditor.Rendering.HighDefinition.HDEditorUtils,Unity.RenderPipelines.HighDefinition.Editor")
                     .GetMethod("EnsureFrameSetting", BindingFlags.Static | BindingFlags.NonPublic);
 
-                k_EnsureFrameSetting.Invoke(null, new object[] { k_APVFrameSetting, "Adaptive Probe Volumes" });
+                k_EnsureFrameSetting.Invoke(null, new object[] { k_APVFrameSetting});
             }
         }
 

Packages/com.unity.render-pipelines.core/Editor/LookDev/EnvironmentLibrary.cs

@@ -12,7 +12,7 @@ namespace UnityEditor.Rendering.LookDev
     /// <summary>
     /// Class containing a collection of Environment
     /// </summary>
-    [CoreRPHelpURL("Environment-Library")]
+    [CoreRPHelpURL("Look-Dev-Environment-Library")]
     public class EnvironmentLibrary : ScriptableObject
     {
         [field: SerializeField]

Packages/com.unity.render-pipelines.core/Editor/RenderGraph/RenderGraphViewer.cs

@@ -3,6 +3,7 @@
 using UnityEditor.Rendering.Analytics;
 using UnityEditor.UIElements;
 using UnityEngine;
+using UnityEngine.Rendering;
 using UnityEngine.Rendering.RenderGraphModule;
 using UnityEngine.Scripting.APIUpdating;
 using UnityEngine.UIElements;
@@ -13,7 +14,8 @@ namespace UnityEditor.Rendering
     /// Editor window class for the Render Graph Viewer
     /// </summary>
     [MovedFrom("")]
-    public partial class RenderGraphViewer : EditorWindow
+    [CoreRPHelpURL(packageName: "com.unity.render-pipelines.universal", pageName: "render-graph-view")]
+    public partial class RenderGraphViewer : EditorWindowWithHelpButton
     {
         static partial class Names
         {

Packages/com.unity.render-pipelines.core/Runtime/Common/ObservableList.cs

@@ -45,7 +45,8 @@ public ListChangedEventArgs(int index, T item)
     /// <typeparam name="T">Type of the list.</typeparam>
     public class ObservableList<T> : IList<T>
     {
-        IList<T> m_List;
+        List<T> m_List;
+        private readonly Comparison<T> m_Comparison;
 
         /// <summary>
         /// Added item event.
@@ -98,18 +99,23 @@ public ObservableList()
         /// Constructor.
         /// </summary>
         /// <param name="capacity">Allocation size.</param>
-        public ObservableList(int capacity)
+        /// <param name="comparison">The comparision if you want the list to be sorted</param>
+        public ObservableList(int capacity, Comparison<T> comparison = null)
         {
             m_List = new List<T>(capacity);
+            m_Comparison = comparison;
         }
 
         /// <summary>
         /// Constructor.
         /// </summary>
         /// <param name="collection">Input list.</param>
-        public ObservableList(IEnumerable<T> collection)
+        /// <param name="comparison">The comparision if you want the list to be sorted</param>
+        public ObservableList(IEnumerable<T> collection, Comparison<T> comparison = null)
         {
             m_List = new List<T>(collection);
+            m_Comparison = comparison;
+            Sort(); // Make sure the given list is sorted
         }
 
         void OnEvent(ListChangedEventHandler<T> e, int index, T item)
@@ -145,6 +151,7 @@ public int IndexOf(T item)
         public void Add(T item)
         {
             m_List.Add(item);
+            Sort();
             OnEvent(ItemAdded, m_List.IndexOf(item), item);
         }
 
@@ -166,6 +173,7 @@ public void Add(params T[] items)
         public void Insert(int index, T item)
         {
             m_List.Insert(index, item);
+            Sort();
             OnEvent(ItemAdded, index, item);
         }
 
@@ -248,5 +256,13 @@ IEnumerator IEnumerable.GetEnumerator()
         {
             return GetEnumerator();
         }
+
+        private void Sort()
+        {
+            if (m_Comparison != null)
+            {
+                m_List.Sort(m_Comparison);
+            }
+        }
     }
 }

Packages/com.unity.render-pipelines.core/Runtime/Debugging/DebugDisplaySettingsUI.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Reflection;
 using UnityEngine.Rendering.RenderGraphModule;
 
 namespace UnityEngine.Rendering
@@ -51,6 +52,9 @@ public void RegisterDebug(IDebugDisplaySettings settings)
                     displayName: disposableSettingsPanel.PanelName,
                     createIfNull: true,
                     groupIndex: (disposableSettingsPanel is DebugDisplaySettingsPanel debugDisplaySettingsPanel) ? debugDisplaySettingsPanel.Order : 0);
+#if UNITY_EDITOR
+                panel.documentationUrl = disposableSettingsPanel.GetType().GetCustomAttribute<HelpURLAttribute>()?.URL;
+#endif
 
                 ObservableList<DebugUI.Widget> panelChildren = panel.children;
 

Packages/com.unity.render-pipelines.core/Runtime/Debugging/DebugUI.Panel.cs

@@ -53,13 +53,17 @@ public class Panel : IContainer, IComparable<Panel>
             /// Callback used when the panel is set dirty.
             /// </summary>
             public event Action<Panel> onSetDirty = delegate { };
+            
+#if UNITY_EDITOR
+            public string documentationUrl { get; set; }
+#endif
 
             /// <summary>
             /// Constructor.
             /// </summary>
             public Panel()
             {
-                children = new ObservableList<Widget>();
+                children = new ObservableList<Widget>(0, (widget, widget1) => widget.order.CompareTo(widget1.order));
                 children.ItemAdded += OnItemAdded;
                 children.ItemRemoved += OnItemRemoved;
             }

Packages/com.unity.render-pipelines.core/Runtime/Debugging/DebugUI.cs

@@ -18,7 +18,7 @@ namespace UnityEngine.Rendering
     ///   state (e.g., whether it is in the editor or playing at runtime).
     /// - `DebugUI` also includes helper methods for widget initialization, such as compact initialization using the `NameAndTooltip` struct.
     ///
-    /// This API lets you do the following: 
+    /// This API lets you do the following:
     /// - Specify widget behavior such as "EditorOnly", "RuntimeOnly", "EditorForceUpdate", and "FrequentlyUsed".
     /// - Show dynamic data with optional formatting.
     /// - Specify delegate functions to show or hide widgets
@@ -53,10 +53,10 @@ namespace UnityEngine.Rendering
     ///         {
     ///             // Set the display label
     ///             displayName = "Current Time",
-    ///             
+    ///
     ///             // Set the format for the time
     ///             getter = () => System.DateTime.Now.ToString("HH:mm:ss"),
-    ///             
+    ///
     ///             // Set the value to refresh every second
     ///             refreshRate = 1f
     ///         };
@@ -103,6 +103,11 @@ public enum Flags
         /// </summary>
         public abstract class Widget
         {
+            /// <summary>
+            /// The order of the widget
+            /// </summary>
+            public int order { get; set; } = 0;
+
             // Set to null until it's added to a panel, be careful
             /// <summary>
             /// Panels containing the widget.