Informative tooltips and ui labels (#75)

* Merge branch 'dr-test3' of https://github.com/Unity-Technologies/com.unity.perception into dr-test3

Add some tooltips and UI labels to perception camera, labelers, randomization scenarios, and parameter configurations

* making requested change

variable name case change

* added ///<inheritdoc/> to description overrides

* two more xmldoc additions to fix warnings

Author: mkamalza

com.unity.perception/Editor/GroundTruth/CameraLabelerDrawer.cs

@@ -116,7 +116,7 @@ void DoHeaderGUI(ref Rect rect)
             enabledRect.x = rect.xMax - enabledSize.x;
             enabledRect.width = enabledSize.x;
 
-            EditorGUI.LabelField(headerRect, $"{cameraLabeler.GetType().Name}", EditorStyles.boldLabel);
+            EditorGUI.LabelField(headerRect, new GUIContent($"{cameraLabeler.GetType().Name}", $"{cameraLabeler.description}"), EditorStyles.boldLabel);
             EditorGUIUtility.labelWidth = enabledRect.width - 14;
             m_Enabled.boolValue = EditorGUI.Toggle(enabledRect, Styles.enabled, m_Enabled.boolValue);
             EditorGUIUtility.labelWidth = 0;

com.unity.perception/Editor/GroundTruth/PerceptionCameraEditor.cs

@@ -80,11 +80,11 @@ public override void OnInspectorGUI()
         {
             using(new EditorGUI.DisabledScope(EditorApplication.isPlaying))
             {
-                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.description)));
-                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.period)));
-                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.startTime)));
-                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.showVisualizations)));
-                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.captureRgbImages)));
+                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.description)), new GUIContent("Description", "Provide a description for this perception camera (optional)."));
+                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.period)), new GUIContent("Capture Interval", "The interval at which the perception camera should render and capture (seconds)."));
+                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.startTime)), new GUIContent("Start Time","Time at which this perception camera starts rendering and capturing (seconds)."));
+                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.showVisualizations)), new GUIContent("Show Labeler Visualizations", "Display realtime visualizations for labelers that are currently active on this perception camera."));
+                EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(perceptionCamera.captureRgbImages)),new GUIContent("Save Camera Output to Disk", "For each captured frame, save an RGB image of the perception camera's output to disk."));
                 serializedObject.ApplyModifiedProperties();
 
                 //EditorGUILayout.PropertyField(serializedObject.FindProperty(nameof(PerceptionCamera.labelers)));
@@ -98,7 +98,7 @@ public override void OnInspectorGUI()
 #if HDRP_PRESENT
             var hdRenderPipelineAsset = UnityEngine.Rendering.GraphicsSettings.renderPipelineAsset as UnityEngine.Rendering.HighDefinition.HDRenderPipelineAsset;
             if (hdRenderPipelineAsset != null &&
-                hdRenderPipelineAsset.currentPlatformRenderPipelineSettings.supportedLitShaderMode == 
+                hdRenderPipelineAsset.currentPlatformRenderPipelineSettings.supportedLitShaderMode ==
                 UnityEngine.Rendering.HighDefinition.RenderPipelineSettings.SupportedLitShaderMode.DeferredOnly)
             {
                 EditorGUILayout.HelpBox("Deferred Only shader mode is not supported by rendering-based labelers. " +

com.unity.perception/Editor/Randomization/Uxml/ParameterConfiguration.uxml

@@ -1,12 +1,14 @@
 <UXML xmlns="UnityEngine.UIElements" xmlns:editor="UnityEditor.UIElements">
     <VisualElement>
         <Style src="../Uss/Styles.uss"/>
-
+        <Label style="white-space: normal; margin-bottom: 2px; margin-top: 2px;" text="Use this component to define a list of parameters for randomizing various aspects of your scene throughout the simulation (e.g. object size and placement, lighting, etc.) and assign them to properties of GameObjects present in your scene."/>
+        <Label style="white-space: normal; margin-bottom: 2px; margin-top: 10px" text ="Search parameter names:"/>
         <VisualElement style="flex-direction: row; align-items: center; margin-bottom: 2px; margin-top: 2px;">
             <VisualElement class="search-icon" style="margin-left: 3px; margin-right: 2px;"/>
             <TextField name="filter-parameters" style="flex-grow: 1; flex-shrink: 1;"/>
         </VisualElement>
-        <ScrollView name="parameter-scroll-view" class="dark-viewport" style="min-height: 100px; max-height: 600px;">
+        <Label style="white-space: normal; margin-bottom: 2px; margin-top: 10px" text ="Parameter list:"/>
+        <ScrollView name="parameter-scroll-view" class="dark-viewport" style="min-height: 100px; max-height: 600px; margin-top: 2px">
             <VisualElement name="parameters-container" style="flex-shrink: 0;"/>
         </ScrollView>
 

com.unity.perception/Editor/Randomization/Uxml/ScenarioBaseElement.uxml

@@ -1,13 +1,13 @@
 <UXML xmlns="UnityEngine.UIElements" xmlns:editor="UnityEditor.UIElements">
     <VisualElement>
         <Style src="../Uss/Styles.uss"/>
-
+        <Label style="white-space: normal; margin-bottom: 5px; margin-top: 2px" text="Scenarios control the execution flow of your simulation by applying randomization parameters. Make sure to always have only one scenario active within your scene."/>
         <VisualElement name="inspector-properties" style="margin-bottom: 20px;"/>
 
         <VisualElement name="configuration-container" class="dark-viewport">
             <Toggle label="Quit On Complete" tooltip="Quit the application when the scenario completes" binding-path="quitOnComplete" style="margin-left: 3px"/>
             <VisualElement name="constants-container">
-                <editor:PropertyField binding-path="constants"/>
+                <editor:PropertyField binding-path="constants" tooltip="A custom list of parameters for this scenario that will be JSON serialized. You can add or remove constants by modifying the code for this scenario class. Only these properties of the simulation can be changed externally from a built player."/>
                 <editor:PropertyField name="configuration-file-name" label="Constants File Name" binding-path="serializedConstantsFileName"/>
                 <editor:PropertyField tooltip="Read constants from JSON when the application starts" name="deserialize-on-start" label="Deserialize On Start" binding-path="deserializeOnStart" style="padding-left: 4px;"/>
                 <VisualElement style="flex-direction: row;">

com.unity.perception/Runtime/GroundTruth/Labelers/BoundingBoxLabeler.cs

@@ -15,6 +15,13 @@ namespace UnityEngine.Perception.GroundTruth
     [Serializable]
     public sealed class BoundingBox2DLabeler : CameraLabeler
     {
+        ///<inheritdoc/>
+        public override string description
+        {
+            get => "Produces 2D bounding box annotations for all visible objects that bear a label defined in this labeler's associated label configuration.";
+            protected set {}
+        }
+
         [SuppressMessage("ReSharper", "InconsistentNaming")]
         [SuppressMessage("ReSharper", "NotAccessedField.Local")]
         struct BoundingBoxValue

com.unity.perception/Runtime/GroundTruth/Labelers/CameraLabeler.cs

@@ -14,6 +14,11 @@ namespace UnityEngine.Perception.GroundTruth
     [Serializable]
     public abstract class CameraLabeler
     {
+        /// <summary>
+        /// A human-readable description of the labeler
+        /// </summary>
+        public abstract string description { get; protected set; }
+
         /// <summary>
         /// Whether the CameraLabeler should be set up and called each frame.
         /// </summary>

com.unity.perception/Runtime/GroundTruth/Labelers/ObjectCountLabeler.cs

@@ -13,6 +13,13 @@ namespace UnityEngine.Perception.GroundTruth
     [Serializable]
     public sealed class ObjectCountLabeler : CameraLabeler
     {
+        ///<inheritdoc/>
+        public override string description
+        {
+            get => "Produces object counts for each label defined in this labeler's associated label configuration.";
+            protected set {}
+        }
+
         /// <summary>
         /// The ID to use for object count annotations in the resulting dataset
         /// </summary>

com.unity.perception/Runtime/GroundTruth/Labelers/RenderedObjectInfoLabeler.cs

@@ -15,6 +15,13 @@ namespace UnityEngine.Perception.GroundTruth
     [Serializable]
     public sealed class RenderedObjectInfoLabeler : CameraLabeler
     {
+        ///<inheritdoc/>
+        public override string description
+        {
+            get => "Produces label id, instance id, and visible pixel count in a single metric each frame for each object which takes up one or more pixels in the camera's frame, based on this labeler's associated label configuration.";
+            protected set {}
+        }
+
         // ReSharper disable InconsistentNaming
         struct RenderedObjectInfoValue
         {

com.unity.perception/Runtime/GroundTruth/Labelers/SemanticSegmentationLabeler.cs

@@ -27,6 +27,15 @@ namespace UnityEngine.Perception.GroundTruth
     [Serializable]
     public sealed class SemanticSegmentationLabeler : CameraLabeler
     {
+        ///<inheritdoc/>
+        public override string description
+        {
+            get => "Generates a semantic segmentation image for each captured frame. Each object is rendered to the semantic segmentation image using the color associated with it based on this labeler's associated semantic segmentation label configuration. " +
+                   "Semantic segmentation images are saved to the dataset in PNG format. " +
+                   "Please note that only one " + this.GetType().Name + " can render at once across all cameras.";
+            protected set {}
+        }
+
         const string k_SemanticSegmentationDirectory = "SemanticSegmentation";
         const string k_SegmentationFilePrefix = "segmentation_";
 

com.unity.perception/Runtime/GroundTruth/Labelers/Visualization/HUDPanel.cs

@@ -25,6 +25,10 @@ public class HUDPanel : MonoBehaviour
         const int k_BoxWidth = 200;
         const int k_YLineSpacing = 4;
 
+
+        /// <summary>
+        /// The number of labelers currently displaying real-time information on the visualization HUD
+        /// </summary>
         public int entryCount => m_Entries.Keys.Count();
 
         void Awake()