Merge pull request #269 from Unity-Technologies/tooltips_for_randomizers

Added tooltips to sample randomizers

Author: mkamalza

com.unity.perception/Runtime/Randomization/Randomizers/RandomizerExamples/Randomizers/BackgroundObjectPlacementRandomizer.cs

@@ -16,26 +16,31 @@ public class BackgroundObjectPlacementRandomizer : Randomizer
         /// <summary>
         /// The Z offset component applied to all generated background layers
         /// </summary>
+        [Tooltip("The Z offset applied to positions of all placed objects.")]
         public float depth;
 
         /// <summary>
         /// The number of background layers to generate
         /// </summary>
+        [Tooltip("The number of background layers to generate.")]
         public int layerCount = 2;
 
         /// <summary>
         /// The minimum distance between placed background objects
         /// </summary>
+        [Tooltip("The minimum distance between the centers of the placed objects.")]
         public float separationDistance = 2f;
 
         /// <summary>
         /// The 2D size of the generated background layers
         /// </summary>
+        [Tooltip("The width and height of the area in which objects will be placed. These should be positive numbers and sufficiently large in relation with the Separation Distance specified.")]
         public Vector2 placementArea;
 
         /// <summary>
         /// A categorical parameter for sampling random prefabs to place
         /// </summary>
+        [Tooltip("The list of Prefabs to be placed by this Randomizer.")]
         public GameObjectParameter prefabs;
 
         GameObject m_Container;

com.unity.perception/Runtime/Randomization/Randomizers/RandomizerExamples/Randomizers/ColorRandomizer.cs

@@ -14,8 +14,9 @@ public class ColorRandomizer : Randomizer
         static readonly int k_BaseColor = Shader.PropertyToID("_BaseColor");
 
         /// <summary>
-        /// Describes the range of random colors to assign to tagged objects
+        /// The range of random colors to assign to target objects
         /// </summary>
+        [Tooltip("The range of random colors to assign to target objects.")]
         public ColorHsvaParameter colorParameter;
 
         /// <summary>

com.unity.perception/Runtime/Randomization/Randomizers/RandomizerExamples/Randomizers/ForegroundObjectPlacementRandomizer.cs

@@ -16,21 +16,25 @@ public class ForegroundObjectPlacementRandomizer : Randomizer
         /// <summary>
         /// The Z offset component applied to the generated layer of GameObjects
         /// </summary>
+        [Tooltip("The Z offset applied to positions of all placed objects.")]
         public float depth;
 
         /// <summary>
         /// The minimum distance between all placed objects
         /// </summary>
+        [Tooltip("The minimum distance between the centers of the placed objects.")]
         public float separationDistance = 2f;
 
         /// <summary>
         /// The size of the 2D area designated for object placement
         /// </summary>
+        [Tooltip("The width and height of the area in which objects will be placed. These should be positive numbers and sufficiently large in relation with the Separation Distance specified.")]
         public Vector2 placementArea;
 
         /// <summary>
         /// The list of prefabs sample and randomly place
         /// </summary>
+        [Tooltip("The list of Prefabs to be placed by this Randomizer.")]
         public GameObjectParameter prefabs;
 
         GameObject m_Container;

com.unity.perception/Runtime/Randomization/Randomizers/RandomizerExamples/Randomizers/HueOffsetRandomizer.cs

@@ -15,8 +15,9 @@ public class HueOffsetRandomizer : Randomizer
         static readonly int k_HueOffsetShaderProperty = Shader.PropertyToID("_HueOffset");
 
         /// <summary>
-        /// The range of hue offsets to assign to tagged objects
+        /// The range of random hue offsets to assign to target objects
         /// </summary>
+        [Tooltip("The range of random hue offsets to assign to target objects.")]
         public FloatParameter hueOffset = new FloatParameter { value = new UniformSampler(-180f, 180f) };
 
         /// <summary>

com.unity.perception/Runtime/Randomization/Randomizers/RandomizerExamples/Randomizers/RotationRandomizer.cs

@@ -13,8 +13,9 @@ namespace UnityEngine.Perception.Randomization.Randomizers.SampleRandomizers
     public class RotationRandomizer : Randomizer
     {
         /// <summary>
-        /// Defines the range of random rotations that can be assigned to tagged objects
+        /// The range of random rotations to assign to target objects
         /// </summary>
+        [Tooltip("The range of random rotations to assign to target objects.")]
         public Vector3Parameter rotation = new Vector3Parameter
         {
             x = new UniformSampler(0, 360),

com.unity.perception/Runtime/Randomization/Randomizers/RandomizerExamples/Randomizers/SunAngleRandomizer.cs

@@ -13,18 +13,21 @@ namespace UnityEngine.Perception.Randomization.Randomizers.SampleRandomizers
     public class SunAngleRandomizer : Randomizer
     {
         /// <summary>
-        /// The hour of the day (0 to 24)
+        /// The range of hours in a day (default is 0 to 24)
         /// </summary>
+        [Tooltip("The range of hours in a day (default is 0 to 24).")]
         public FloatParameter hour = new FloatParameter { value = new UniformSampler(0, 24)};
 
         /// <summary>
-        /// The day of the year (0 being Jan 1st and 364 being December 31st)
+        /// The range of days in a year with 0 being Jan 1st and 364 being December 31st (default is 0 to 364)
         /// </summary>
-        public FloatParameter dayOfTheYear = new FloatParameter { value = new UniformSampler(0, 365)};
+        [Tooltip("The range of days in a year with 0 being Jan 1st and 364 being December 31st (default is 0 to 364).")]
+        public FloatParameter dayOfTheYear = new FloatParameter { value = new UniformSampler(0, 364)};
 
         /// <summary>
-        /// The earth's latitude (-90 is the south pole, 0 is the equator, and +90 is the north pole)
+        /// The range of latitudes. A latitude of -90 is the south pole, 0 is the equator, and +90 is the north pole (default is -90 to 90).
         /// </summary>
+        [Tooltip("The range of latitudes. A latitude of -90 is the south pole, 0 is the equator, and +90 is the north pole (default is -90 to 90).")]
         public FloatParameter latitude = new FloatParameter { value = new UniformSampler(-90, 90)};
 
         /// <summary>

com.unity.perception/Runtime/Randomization/Randomizers/RandomizerExamples/Randomizers/TextureRandomizer.cs

@@ -18,8 +18,9 @@ public class TextureRandomizer : Randomizer
 #endif
 
         /// <summary>
-        /// The list of textures to sample and apply to tagged objects
+        /// The list of textures to sample and apply to target objects
         /// </summary>
+        [Tooltip("The list of textures to sample and apply to target objects.")]
         public Texture2DParameter texture;
 
         /// <summary>