Merge pull request #7010 from Troy-Ferrell/users/trferrel/line-renderer-fix

keveleigh · web-flow · commit f0d65c18aa40 · 2020-01-10T17:53:20.000-08:00
Fix Line Renderer editor error
diff --git a/Assets/MixedRealityToolkit/Utilities/Lines/DataProviders/EllipseLineDataProvider.cs b/Assets/MixedRealityToolkit/Utilities/Lines/DataProviders/EllipseLineDataProvider.cs
@@ -13,21 +13,29 @@ namespace Microsoft.MixedReality.Toolkit.Utilities
     public class EllipseLineDataProvider : BaseMixedRealityLineDataProvider
     {
         [SerializeField]
-        [Range(0, 2048)]
+        [Tooltip("Resolution is the number of points used to define positions for points on the line. Equivalent to PointCount. Clamped at 2048 max")]
+        [Range(0, MaxResolution)]
         private int resolution = 36;
 
+        /// <summary>
+        /// Resolution is the number of points used to define positions for points on the line. Equivalent to PointCount. Clamped at 2048 max
+        /// </summary>
         public int Resolution
         {
-            get { return resolution; }
-            set { resolution = Mathf.Clamp(value, 0, 2048); }
+            get => resolution;
+            set => resolution = Mathf.Clamp(value, 0, MaxResolution);
         }
 
+        [Tooltip("Radius of ellipsis defined by Vector2 where x is half-width and y is half-height")]
         [SerializeField]
         private Vector2 radius = Vector2.one;
 
+        /// <summary>
+        /// Radius of ellipsis defined by Vector2 where x is half-width and y is half-height
+        /// </summary>
         public Vector2 Radius
         {
-            get { return radius; }
+            get => radius;
             set
             {
                 if (value.x < 0)
@@ -44,22 +52,25 @@ public Vector2 Radius
             }
         }
 
+        private const int MaxResolution = 2048;
+
+
         #region BaseMixedRealityLineDataProvider Implementation
 
         /// <inheritdoc />
-        public override int PointCount => resolution;
+        public override int PointCount => Resolution;
 
         /// <inheritdoc />
         protected override Vector3 GetPointInternal(float normalizedDistance)
         {
-            return LineUtility.GetEllipsePoint(radius, normalizedDistance * 2f * Mathf.PI);
+            return LineUtility.GetEllipsePoint(Radius, normalizedDistance * 2f * Mathf.PI);
         }
 
         /// <inheritdoc />
         protected override Vector3 GetPointInternal(int pointIndex)
         {
-            float angle = ((float)pointIndex / resolution) * 2f * Mathf.PI;
-            return LineUtility.GetEllipsePoint(radius, angle);
+            float angle = ((float)pointIndex / Resolution) * 2f * Mathf.PI;
+            return LineUtility.GetEllipsePoint(Radius, angle);
         }
 
         /// <inheritdoc />
diff --git a/Assets/MixedRealityToolkit/Utilities/Lines/DataProviders/SimpleLineDataProvider.cs b/Assets/MixedRealityToolkit/Utilities/Lines/DataProviders/SimpleLineDataProvider.cs
@@ -11,11 +11,12 @@ namespace Microsoft.MixedReality.Toolkit.Utilities
     [AddComponentMenu("Scripts/MRTK/Core/SimpleLineDataProvider")]
     public class SimpleLineDataProvider : BaseMixedRealityLineDataProvider
     {
+        [Tooltip("The starting point of this line.")]
         [SerializeField]
         private MixedRealityPose startPoint = MixedRealityPose.ZeroIdentity;
 
         /// <summary>
-        /// The Starting point of this line.
+        /// The starting point of this line which is always located at the GameObject's transform position
         /// </summary>
         /// <remarks>Always located at this <see href="https://docs.unity3d.com/ScriptReference/GameObject.html">GameObject</see>'s <see href="https://docs.unity3d.com/ScriptReference/Transform-position.html">Transform.position</see></remarks>
         public MixedRealityPose StartPoint => startPoint;
@@ -29,8 +30,8 @@ public class SimpleLineDataProvider : BaseMixedRealityLineDataProvider
         /// </summary>
         public MixedRealityPose EndPoint
         {
-            get { return endPoint; }
-            set { endPoint = value; }
+            get => endPoint;
+            set => endPoint = value;
         }
 
         #region Line Data Provider Implementation
@@ -44,9 +45,9 @@ protected override Vector3 GetPointInternal(int pointIndex)
             switch (pointIndex)
             {
                 case 0:
-                    return startPoint.Position;
+                    return StartPoint.Position;
                 case 1:
-                    return endPoint.Position;
+                    return EndPoint.Position;
                 default:
                     Debug.LogError("Invalid point index");
                     return Vector3.zero;
@@ -73,13 +74,13 @@ protected override void SetPointInternal(int pointIndex, Vector3 point)
         /// <inheritdoc />
         protected override Vector3 GetPointInternal(float normalizedDistance)
         {
-            return Vector3.Lerp(startPoint.Position, endPoint.Position, normalizedDistance);
+            return Vector3.Lerp(StartPoint.Position, EndPoint.Position, normalizedDistance);
         }
 
         /// <inheritdoc />
         protected override float GetUnClampedWorldLengthInternal()
         {
-            return Vector3.Distance(startPoint.Position, endPoint.Position);
+            return Vector3.Distance(StartPoint.Position, EndPoint.Position);
         }
 
         /// <inheritdoc />
diff --git a/Assets/MixedRealityToolkit/Utilities/Lines/DataProviders/SplineDataProvider.cs b/Assets/MixedRealityToolkit/Utilities/Lines/DataProviders/SplineDataProvider.cs
@@ -11,6 +11,7 @@ namespace Microsoft.MixedReality.Toolkit.Utilities
     [AddComponentMenu("Scripts/MRTK/Core/SplineDataProvider")]
     public class SplineDataProvider : BaseMixedRealityLineDataProvider
     {
+        [Tooltip("List of positions and orientations that define control points to generate the spline")]
         [SerializeField]
         private MixedRealityPose[] controlPoints =
         {
@@ -20,14 +21,17 @@ public class SplineDataProvider : BaseMixedRealityLineDataProvider
             new MixedRealityPose(Vector3.right, Quaternion.identity),
         };
 
+        /// <summary>
+        /// List of positions and orientations that define control points to generate the spline
+        /// </summary>
         public MixedRealityPose[] ControlPoints => controlPoints;
 
         [SerializeField]
         private bool alignAllControlPoints = true;
 
         public bool AlignAllControlPoints
         {
-            get { return alignAllControlPoints; }
+            get => alignAllControlPoints;
             set
             {
                 if (alignAllControlPoints != value)
@@ -43,7 +47,7 @@ public bool AlignAllControlPoints
         /// </summary>
         public void ForceUpdateAlignment()
         {
-            if (alignAllControlPoints)
+            if (AlignAllControlPoints)
             {
                 for (int i = 0; i < PointCount; i++)
                 {
@@ -54,7 +58,7 @@ public void ForceUpdateAlignment()
 
         private void UpdatePointAlignment(int pointIndex)
         {
-            if (alignAllControlPoints)
+            if (AlignAllControlPoints)
             {
                 int prevControlPoint;
                 int changedControlPoint;
@@ -187,7 +191,7 @@ protected override void SetPointInternal(int pointIndex, Vector3 point)
                 pointIndex = 0;
             }
 
-            if (alignAllControlPoints)
+            if (AlignAllControlPoints)
             {
                 if (pointIndex % 3 == 0)
                 {
@@ -271,4 +275,4 @@ protected override float GetUnClampedWorldLengthInternal()
 
         #endregion BaseMixedRealityLineDataProvider Implementation
     }
-}
+}
diff --git a/Assets/MixedRealityToolkit/Utilities/Lines/Renderers/BaseMixedRealityLineRenderer.cs b/Assets/MixedRealityToolkit/Utilities/Lines/Renderers/BaseMixedRealityLineRenderer.cs
@@ -16,7 +16,7 @@ public abstract class BaseMixedRealityLineRenderer : MonoBehaviour
         protected BaseMixedRealityLineDataProvider lineDataSource;
 
         /// <summary>
-        /// The line data this component will render
+        /// The data provider component that provides the positioning source information for the LineRenderer.
         /// </summary>
         public BaseMixedRealityLineDataProvider LineDataSource
         {
@@ -192,6 +192,10 @@ protected virtual float GetWidth(float normalizedLength)
             return LineWidth.Evaluate(Mathf.Repeat(normalizedLength + widthOffset, 1f)) * widthMultiplier;
         }
 
+        /// <summary>
+        /// Gets the normalized distance along the line path (range 0 to 1) going the given number of steps provided
+        /// </summary>
+        /// <param name="stepNum">Number of steps to take "walking" along the curve </param>
         protected virtual float GetNormalizedPointAlongLine(int stepNum)
         {
             float normalizedDistance = 0;
@@ -225,9 +229,15 @@ private void LateUpdate()
             UpdateLine();
         }
 
+        /// <summary>
+        /// Executes every Unity LateUpdate(). Any property updates or frame updates should occur here to update the line data source.
+        /// </summary>
         protected abstract void UpdateLine();
 
-#if UNITY_EDITOR
+        #region Gizmos
+
+        #if UNITY_EDITOR
+
         protected virtual void OnDrawGizmos()
         {
             if (UnityEditor.Selection.activeGameObject == gameObject || Application.isPlaying) { return; }
@@ -321,6 +331,8 @@ private void GizmosDrawLineInterpolated()
                 Gizmos.DrawLine(lastPos, firstPos);
             }
         }
-#endif
+
+        #endif
+        #endregion
     }
 }
diff --git a/Assets/MixedRealityToolkit/Utilities/Lines/Renderers/MixedRealityLineRenderer.cs b/Assets/MixedRealityToolkit/Utilities/Lines/Renderers/MixedRealityLineRenderer.cs
@@ -125,7 +125,7 @@ private void OnEnable()
                 enabled = false;
             }
 
-            if (FadeLineBrightnessOnEnable)
+            if (FadeLineBrightnessOnEnable && Application.isPlaying)
             {
                 fadeLine = StartCoroutine(FadeLine(FadeLinePercentage, FadeLineAnimationTime));
             }

Original file line number	Diff line number	Diff line change
`@@ -13,21 +13,29 @@ namespace Microsoft.MixedReality.Toolkit.Utilities`
`13`	`13`	`public class EllipseLineDataProvider : BaseMixedRealityLineDataProvider`
`14`	`14`	`{`
`15`	`15`	`[SerializeField]`
`16`		`- [Range(0, 2048)]`
	`16`	`+ [Tooltip("Resolution is the number of points used to define positions for points on the line. Equivalent to PointCount. Clamped at 2048 max")]`
	`17`	`+ [Range(0, MaxResolution)]`
`17`	`18`	`private int resolution = 36;`
`18`	`19`
	`20`	`+ /// <summary>`
	`21`	`+ /// Resolution is the number of points used to define positions for points on the line. Equivalent to PointCount. Clamped at 2048 max`
	`22`	`+ /// </summary>`
`19`	`23`	`public int Resolution`
`20`	`24`	`{`
`21`		`- get { return resolution; }`
`22`		`- set { resolution = Mathf.Clamp(value, 0, 2048); }`
	`25`	`+ get => resolution;`
	`26`	`+ set => resolution = Mathf.Clamp(value, 0, MaxResolution);`
`23`	`27`	`}`
`24`	`28`
	`29`	`+ [Tooltip("Radius of ellipsis defined by Vector2 where x is half-width and y is half-height")]`
`25`	`30`	`[SerializeField]`
`26`	`31`	`private Vector2 radius = Vector2.one;`
`27`	`32`
	`33`	`+ /// <summary>`
	`34`	`+ /// Radius of ellipsis defined by Vector2 where x is half-width and y is half-height`
	`35`	`+ /// </summary>`
`28`	`36`	`public Vector2 Radius`
`29`	`37`	`{`
`30`		`- get { return radius; }`
	`38`	`+ get => radius;`
`31`	`39`	`set`
`32`	`40`	`{`
`33`	`41`	`if (value.x < 0)`
`@@ -44,22 +52,25 @@ public Vector2 Radius`
`44`	`52`	`}`
`45`	`53`	`}`
`46`	`54`
	`55`	`+ private const int MaxResolution = 2048;`
	`56`	`+`
	`57`	`+`
`47`	`58`	`#region BaseMixedRealityLineDataProvider Implementation`
`48`	`59`
`49`	`60`	`/// <inheritdoc />`
`50`		`- public override int PointCount => resolution;`
	`61`	`+ public override int PointCount => Resolution;`
`51`	`62`
`52`	`63`	`/// <inheritdoc />`
`53`	`64`	`protected override Vector3 GetPointInternal(float normalizedDistance)`
`54`	`65`	`{`
`55`		`- return LineUtility.GetEllipsePoint(radius, normalizedDistance * 2f * Mathf.PI);`
	`66`	`+ return LineUtility.GetEllipsePoint(Radius, normalizedDistance * 2f * Mathf.PI);`
`56`	`67`	`}`
`57`	`68`
`58`	`69`	`/// <inheritdoc />`
`59`	`70`	`protected override Vector3 GetPointInternal(int pointIndex)`
`60`	`71`	`{`
`61`		`- float angle = ((float)pointIndex / resolution) * 2f * Mathf.PI;`
`62`		`- return LineUtility.GetEllipsePoint(radius, angle);`
	`72`	`+ float angle = ((float)pointIndex / Resolution) * 2f * Mathf.PI;`
	`73`	`+ return LineUtility.GetEllipsePoint(Radius, angle);`
`63`	`74`	`}`
`64`	`75`
`65`	`76`	`/// <inheritdoc />`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ namespace Microsoft.MixedReality.Toolkit.Utilities`
`11`	`11`	`[AddComponentMenu("Scripts/MRTK/Core/SplineDataProvider")]`
`12`	`12`	`public class SplineDataProvider : BaseMixedRealityLineDataProvider`
`13`	`13`	`{`
	`14`	`+ [Tooltip("List of positions and orientations that define control points to generate the spline")]`
`14`	`15`	`[SerializeField]`
`15`	`16`	`private MixedRealityPose[] controlPoints =`
`16`	`17`	`{`
`@@ -20,14 +21,17 @@ public class SplineDataProvider : BaseMixedRealityLineDataProvider`
`20`	`21`	`new MixedRealityPose(Vector3.right, Quaternion.identity),`
`21`	`22`	`};`
`22`	`23`
	`24`	`+ /// <summary>`
	`25`	`+ /// List of positions and orientations that define control points to generate the spline`
	`26`	`+ /// </summary>`
`23`	`27`	`public MixedRealityPose[] ControlPoints => controlPoints;`
`24`	`28`
`25`	`29`	`[SerializeField]`
`26`	`30`	`private bool alignAllControlPoints = true;`
`27`	`31`
`28`	`32`	`public bool AlignAllControlPoints`
`29`	`33`	`{`
`30`		`- get { return alignAllControlPoints; }`
	`34`	`+ get => alignAllControlPoints;`
`31`	`35`	`set`
`32`	`36`	`{`
`33`	`37`	`if (alignAllControlPoints != value)`
`@@ -43,7 +47,7 @@ public bool AlignAllControlPoints`
`43`	`47`	`/// </summary>`
`44`	`48`	`public void ForceUpdateAlignment()`
`45`	`49`	`{`
`46`		`- if (alignAllControlPoints)`
	`50`	`+ if (AlignAllControlPoints)`
`47`	`51`	`{`
`48`	`52`	`for (int i = 0; i < PointCount; i++)`
`49`	`53`	`{`
`@@ -54,7 +58,7 @@ public void ForceUpdateAlignment()`
`54`	`58`
`55`	`59`	`private void UpdatePointAlignment(int pointIndex)`
`56`	`60`	`{`
`57`		`- if (alignAllControlPoints)`
	`61`	`+ if (AlignAllControlPoints)`
`58`	`62`	`{`
`59`	`63`	`int prevControlPoint;`
`60`	`64`	`int changedControlPoint;`
`@@ -187,7 +191,7 @@ protected override void SetPointInternal(int pointIndex, Vector3 point)`
`187`	`191`	`pointIndex = 0;`
`188`	`192`	`}`
`189`	`193`
`190`		`- if (alignAllControlPoints)`
	`194`	`+ if (AlignAllControlPoints)`
`191`	`195`	`{`
`192`	`196`	`if (pointIndex % 3 == 0)`
`193`	`197`	`{`
`@@ -271,4 +275,4 @@ protected override float GetUnClampedWorldLengthInternal()`
`271`	`275`
`272`	`276`	`#endregion BaseMixedRealityLineDataProvider Implementation`
`273`	`277`	`}`
`274`		`-}`
	`278`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public abstract class BaseMixedRealityLineRenderer : MonoBehaviour`
`16`	`16`	`protected BaseMixedRealityLineDataProvider lineDataSource;`
`17`	`17`
`18`	`18`	`/// <summary>`
`19`		`- /// The line data this component will render`
	`19`	`+ /// The data provider component that provides the positioning source information for the LineRenderer.`
`20`	`20`	`/// </summary>`
`21`	`21`	`public BaseMixedRealityLineDataProvider LineDataSource`
`22`	`22`	`{`
`@@ -192,6 +192,10 @@ protected virtual float GetWidth(float normalizedLength)`
`192`	`192`	`return LineWidth.Evaluate(Mathf.Repeat(normalizedLength + widthOffset, 1f)) * widthMultiplier;`
`193`	`193`	`}`
`194`	`194`
	`195`	`+ /// <summary>`
	`196`	`+ /// Gets the normalized distance along the line path (range 0 to 1) going the given number of steps provided`
	`197`	`+ /// </summary>`
	`198`	`+ /// <param name="stepNum">Number of steps to take "walking" along the curve </param>`
`195`	`199`	`protected virtual float GetNormalizedPointAlongLine(int stepNum)`
`196`	`200`	`{`
`197`	`201`	`float normalizedDistance = 0;`
`@@ -225,9 +229,15 @@ private void LateUpdate()`
`225`	`229`	`UpdateLine();`
`226`	`230`	`}`
`227`	`231`
	`232`	`+ /// <summary>`
	`233`	`+ /// Executes every Unity LateUpdate(). Any property updates or frame updates should occur here to update the line data source.`
	`234`	`+ /// </summary>`
`228`	`235`	`protected abstract void UpdateLine();`
`229`	`236`
`230`		`-#if UNITY_EDITOR`
	`237`	`+ #region Gizmos`
	`238`	`+`
	`239`	`+ #if UNITY_EDITOR`
	`240`	`+`
`231`	`241`	`protected virtual void OnDrawGizmos()`
`232`	`242`	`{`
`233`	`243`	`if (UnityEditor.Selection.activeGameObject == gameObject \|\| Application.isPlaying) { return; }`
`@@ -321,6 +331,8 @@ private void GizmosDrawLineInterpolated()`
`321`	`331`	`Gizmos.DrawLine(lastPos, firstPos);`
`322`	`332`	`}`
`323`	`333`	`}`
`324`		`-#endif`
	`334`	`+`
	`335`	`+ #endif`
	`336`	`+ #endregion`
`325`	`337`	`}`
`326`	`338`	`}`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ private void OnEnable()`
`125`	`125`	`enabled = false;`
`126`	`126`	`}`
`127`	`127`
`128`		`- if (FadeLineBrightnessOnEnable)`
	`128`	`+ if (FadeLineBrightnessOnEnable && Application.isPlaying)`
`129`	`129`	`{`
`130`	`130`	`fadeLine = StartCoroutine(FadeLine(FadeLinePercentage, FadeLineAnimationTime));`
`131`	`131`	`}`