fix(SDK): remove erroneous parameter from boundary methods

thestonefox · thestonefox · commit 77a667db8de7 · 2017-05-11T10:41:39.000+01:00
A few of the SDK Boundary methods required a playArea GameObject to
be passed into them, however many of the internal methods didn't
use this GameObject as they can access the cached version of the
play area or simply make the same `GetPlayArea()` call which was
being used to pass the playArea object into the method in the first
place.
diff --git a/Assets/VRTK/SDK/Base/SDK_BaseBoundaries.cs b/Assets/VRTK/SDK/Base/SDK_BaseBoundaries.cs
@@ -27,23 +27,20 @@ public abstract class SDK_BaseBoundaries : SDK_Base
         /// <summary>
         /// The GetPlayAreaVertices method returns the points of the play area boundaries.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>
-        public abstract Vector3[] GetPlayAreaVertices(GameObject playArea);
+        public abstract Vector3[] GetPlayAreaVertices();
 
         /// <summary>
         /// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>The thickness of the drawn border.</returns>
-        public abstract float GetPlayAreaBorderThickness(GameObject playArea);
+        public abstract float GetPlayAreaBorderThickness();
 
         /// <summary>
         /// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>
-        public abstract bool IsPlayAreaSizeCalibrated(GameObject playArea);
+        public abstract bool IsPlayAreaSizeCalibrated();
 
         /// <summary>
         /// The GetDrawAtRuntime method returns whether the given play area drawn border is being displayed.
diff --git a/Assets/VRTK/SDK/Daydream/SDK_DaydreamBoundaries.cs b/Assets/VRTK/SDK/Daydream/SDK_DaydreamBoundaries.cs
@@ -51,29 +51,26 @@ public override Transform GetPlayArea()
         /// <summary>
         /// The GetPlayAreaVertices method returns the points of the play area boundaries.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>
-        public override Vector3[] GetPlayAreaVertices(GameObject playArea)
+        public override Vector3[] GetPlayAreaVertices()
         {
             return null;
         }
 
         /// <summary>
         /// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>The thickness of the drawn border.</returns>
-        public override float GetPlayAreaBorderThickness(GameObject playArea)
+        public override float GetPlayAreaBorderThickness()
         {
             return 0.1f;
         }
 
         /// <summary>
         /// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>
-        public override bool IsPlayAreaSizeCalibrated(GameObject playArea)
+        public override bool IsPlayAreaSizeCalibrated()
         {
             return true;
         }
diff --git a/Assets/VRTK/SDK/Fallback/SDK_FallbackBoundaries.cs b/Assets/VRTK/SDK/Fallback/SDK_FallbackBoundaries.cs
@@ -31,29 +31,26 @@ public override Transform GetPlayArea()
         /// <summary>
         /// The GetPlayAreaVertices method returns the points of the play area boundaries.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>
-        public override Vector3[] GetPlayAreaVertices(GameObject playArea)
+        public override Vector3[] GetPlayAreaVertices()
         {
             return null;
         }
 
         /// <summary>
         /// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>The thickness of the drawn border.</returns>
-        public override float GetPlayAreaBorderThickness(GameObject playArea)
+        public override float GetPlayAreaBorderThickness()
         {
             return 0f;
         }
 
         /// <summary>
         /// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>
-        public override bool IsPlayAreaSizeCalibrated(GameObject playArea)
+        public override bool IsPlayAreaSizeCalibrated()
         {
             return false;
         }
diff --git a/Assets/VRTK/SDK/Oculus/SDK_OculusBoundaries.cs b/Assets/VRTK/SDK/Oculus/SDK_OculusBoundaries.cs
@@ -49,9 +49,8 @@ public override Transform GetPlayArea()
         /// <summary>
         /// The GetPlayAreaVertices method returns the points of the play area boundaries.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>
-        public override Vector3[] GetPlayAreaVertices(GameObject playArea)
+        public override Vector3[] GetPlayAreaVertices()
         {
             var area = new OVRBoundary();
             if (area.GetConfigured())
@@ -79,19 +78,17 @@ public override Vector3[] GetPlayAreaVertices(GameObject playArea)
         /// <summary>
         /// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>The thickness of the drawn border.</returns>
-        public override float GetPlayAreaBorderThickness(GameObject playArea)
+        public override float GetPlayAreaBorderThickness()
         {
             return 0.1f;
         }
 
         /// <summary>
         /// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>
-        public override bool IsPlayAreaSizeCalibrated(GameObject playArea)
+        public override bool IsPlayAreaSizeCalibrated()
         {
             return true;
         }
diff --git a/Assets/VRTK/SDK/Simulator/SDK_SimBoundaries.cs b/Assets/VRTK/SDK/Simulator/SDK_SimBoundaries.cs
@@ -39,9 +39,8 @@ public override Transform GetPlayArea()
         /// <summary>
         /// The GetPlayAreaVertices method returns the points of the play area boundaries.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>
-        public override Vector3[] GetPlayAreaVertices(GameObject playArea)
+        public override Vector3[] GetPlayAreaVertices()
         {
             float inner = 0.9f;
             float outer = 1f;
@@ -63,19 +62,17 @@ public override Vector3[] GetPlayAreaVertices(GameObject playArea)
         /// <summary>
         /// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>The thickness of the drawn border.</returns>
-        public override float GetPlayAreaBorderThickness(GameObject playArea)
+        public override float GetPlayAreaBorderThickness()
         {
             return 0.1f;
         }
 
         /// <summary>
         /// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>
-        public override bool IsPlayAreaSizeCalibrated(GameObject playArea)
+        public override bool IsPlayAreaSizeCalibrated()
         {
             return true;
         }
diff --git a/Assets/VRTK/SDK/SteamVR/SDK_SteamVRBoundaries.cs b/Assets/VRTK/SDK/SteamVR/SDK_SteamVRBoundaries.cs
@@ -60,9 +60,8 @@ public override Transform GetPlayArea()
         /// <summary>
         /// The GetPlayAreaVertices method returns the points of the play area boundaries.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>
-        public override Vector3[] GetPlayAreaVertices(GameObject playArea)
+        public override Vector3[] GetPlayAreaVertices()
         {
             SteamVR_PlayArea area = GetCachedSteamVRPlayArea();
             if (area != null)
@@ -75,9 +74,8 @@ public override Vector3[] GetPlayAreaVertices(GameObject playArea)
         /// <summary>
         /// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>The thickness of the drawn border.</returns>
-        public override float GetPlayAreaBorderThickness(GameObject playArea)
+        public override float GetPlayAreaBorderThickness()
         {
             SteamVR_PlayArea area = GetCachedSteamVRPlayArea();
             if (area != null)
@@ -90,9 +88,8 @@ public override float GetPlayAreaBorderThickness(GameObject playArea)
         /// <summary>
         /// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>
-        public override bool IsPlayAreaSizeCalibrated(GameObject playArea)
+        public override bool IsPlayAreaSizeCalibrated()
         {
             SteamVR_PlayArea area = GetCachedSteamVRPlayArea();
             return (area != null && area.size == SteamVR_PlayArea.Size.Calibrated);
@@ -139,7 +136,7 @@ protected virtual SteamVR_PlayArea GetCachedSteamVRPlayArea()
         protected virtual Vector3[] ProcessVertices(Vector3[] vertices)
         {
             //If there aren't enough vertices or the play area is calibrated then just return
-            if (vertices.Length < 8 || IsPlayAreaSizeCalibrated(null))
+            if (vertices.Length < 8 || IsPlayAreaSizeCalibrated())
             {
                 return vertices;
             }
diff --git a/Assets/VRTK/SDK/VRTK_SDK_Bridge.cs b/Assets/VRTK/SDK/VRTK_SDK_Bridge.cs
@@ -527,19 +527,19 @@ public static Transform GetPlayArea()
             return GetBoundariesSDK().GetPlayArea();
         }
 
-        public static Vector3[] GetPlayAreaVertices(GameObject playArea)
+        public static Vector3[] GetPlayAreaVertices()
         {
-            return GetBoundariesSDK().GetPlayAreaVertices(playArea);
+            return GetBoundariesSDK().GetPlayAreaVertices();
         }
 
-        public static float GetPlayAreaBorderThickness(GameObject playArea)
+        public static float GetPlayAreaBorderThickness()
         {
-            return GetBoundariesSDK().GetPlayAreaBorderThickness(playArea);
+            return GetBoundariesSDK().GetPlayAreaBorderThickness();
         }
 
-        public static bool IsPlayAreaSizeCalibrated(GameObject playArea)
+        public static bool IsPlayAreaSizeCalibrated()
         {
-            return GetBoundariesSDK().IsPlayAreaSizeCalibrated(playArea);
+            return GetBoundariesSDK().IsPlayAreaSizeCalibrated();
         }
 
         public static bool GetDrawAtRuntime()
diff --git a/Assets/VRTK/SDK/Ximmerse/SDK_XimmerseBoundaries.cs b/Assets/VRTK/SDK/Ximmerse/SDK_XimmerseBoundaries.cs
@@ -48,11 +48,10 @@ public override Transform GetPlayArea()
         /// <summary>
         /// The GetPlayAreaVertices method returns the points of the play area boundaries.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>
-        public override Vector3[] GetPlayAreaVertices(GameObject playArea)
+        public override Vector3[] GetPlayAreaVertices()
         {
-            var area = playArea.GetComponentInChildren<PlayAreaRenderer>();
+            var area = GetPlayArea().GetComponentInChildren<PlayAreaRenderer>();
             if (area)
             {
                 return area.corners;
@@ -63,11 +62,10 @@ public override Vector3[] GetPlayAreaVertices(GameObject playArea)
         /// <summary>
         /// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>The thickness of the drawn border.</returns>
-        public override float GetPlayAreaBorderThickness(GameObject playArea)
+        public override float GetPlayAreaBorderThickness()
         {
-            var area = playArea.GetComponentInChildren<PlayAreaRenderer>();
+            var area = GetPlayArea().GetComponentInChildren<PlayAreaRenderer>();
             if (area)
             {
                 return area.borderThickness;
@@ -78,9 +76,8 @@ public override float GetPlayAreaBorderThickness(GameObject playArea)
         /// <summary>
         /// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
         /// </summary>
-        /// <param name="playArea">The GameObject containing the play area representation.</param>
         /// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>
-        public override bool IsPlayAreaSizeCalibrated(GameObject playArea)
+        public override bool IsPlayAreaSizeCalibrated()
         {
             return true;
         }
diff --git a/Assets/VRTK/Scripts/Internal/VRTK_RoomExtender_PlayAreaGizmo.cs b/Assets/VRTK/Scripts/Internal/VRTK_RoomExtender_PlayAreaGizmo.cs
@@ -56,7 +56,7 @@ protected virtual void DrawWireframe()
                 return;
             }
 
-            var vertices = VRTK_SDK_Bridge.GetPlayAreaVertices(playArea.gameObject);
+            var vertices = VRTK_SDK_Bridge.GetPlayAreaVertices();
             if (vertices == null || vertices.Length == 0)
             {
                 return;
diff --git a/Assets/VRTK/Scripts/Pointers/VRTK_PlayAreaCursor.cs b/Assets/VRTK/Scripts/Pointers/VRTK_PlayAreaCursor.cs
@@ -232,7 +232,7 @@ protected virtual void InitPlayAreaCursor()
                 return;
             }
 
-            Vector3[] cursorDrawVertices = VRTK_SDK_Bridge.GetPlayAreaVertices(playArea.gameObject);
+            Vector3[] cursorDrawVertices = VRTK_SDK_Bridge.GetPlayAreaVertices();
             if (validLocationObject != null)
             {
                 GeneratePlayAreaCursorFromPrefab(cursorDrawVertices);
@@ -323,7 +323,7 @@ protected virtual void GeneratePlayAreaCursor(Vector3[] cursorDrawVertices)
         {
             if (playAreaCursorDimensions != Vector2.zero)
             {
-                var customAreaPadding = VRTK_SDK_Bridge.GetPlayAreaBorderThickness(playArea.gameObject);
+                var customAreaPadding = VRTK_SDK_Bridge.GetPlayAreaBorderThickness();
 
                 cursorDrawVertices[btmRightOuter] = new Vector3(playAreaCursorDimensions.x / 2, 0f, (playAreaCursorDimensions.y / 2) * -1);
                 cursorDrawVertices[btmLeftOuter] = new Vector3((playAreaCursorDimensions.x / 2) * -1, 0f, (playAreaCursorDimensions.y / 2) * -1);
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md

Original file line number	Diff line number	Diff line change
`@@ -51,29 +51,26 @@ public override Transform GetPlayArea()`
`51`	`51`	`/// <summary>`
`52`	`52`	`/// The GetPlayAreaVertices method returns the points of the play area boundaries.`
`53`	`53`	`/// </summary>`
`54`		`- /// <param name="playArea">The GameObject containing the play area representation.</param>`
`55`	`54`	`/// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>`
`56`		`- public override Vector3[] GetPlayAreaVertices(GameObject playArea)`
	`55`	`+ public override Vector3[] GetPlayAreaVertices()`
`57`	`56`	`{`
`58`	`57`	`return null;`
`59`	`58`	`}`
`60`	`59`
`61`	`60`	`/// <summary>`
`62`	`61`	`/// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.`
`63`	`62`	`/// </summary>`
`64`		`- /// <param name="playArea">The GameObject containing the play area representation.</param>`
`65`	`63`	`/// <returns>The thickness of the drawn border.</returns>`
`66`		`- public override float GetPlayAreaBorderThickness(GameObject playArea)`
	`64`	`+ public override float GetPlayAreaBorderThickness()`
`67`	`65`	`{`
`68`	`66`	`return 0.1f;`
`69`	`67`	`}`
`70`	`68`
`71`	`69`	`/// <summary>`
`72`	`70`	`/// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.`
`73`	`71`	`/// </summary>`
`74`		`- /// <param name="playArea">The GameObject containing the play area representation.</param>`
`75`	`72`	`/// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>`
`76`		`- public override bool IsPlayAreaSizeCalibrated(GameObject playArea)`
	`73`	`+ public override bool IsPlayAreaSizeCalibrated()`
`77`	`74`	`{`
`78`	`75`	`return true;`
`79`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,29 +31,26 @@ public override Transform GetPlayArea()`
`31`	`31`	`/// <summary>`
`32`	`32`	`/// The GetPlayAreaVertices method returns the points of the play area boundaries.`
`33`	`33`	`/// </summary>`
`34`		`- /// <param name="playArea">The GameObject containing the play area representation.</param>`
`35`	`34`	`/// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>`
`36`		`- public override Vector3[] GetPlayAreaVertices(GameObject playArea)`
	`35`	`+ public override Vector3[] GetPlayAreaVertices()`
`37`	`36`	`{`
`38`	`37`	`return null;`
`39`	`38`	`}`
`40`	`39`
`41`	`40`	`/// <summary>`
`42`	`41`	`/// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.`
`43`	`42`	`/// </summary>`
`44`		`- /// <param name="playArea">The GameObject containing the play area representation.</param>`
`45`	`43`	`/// <returns>The thickness of the drawn border.</returns>`
`46`		`- public override float GetPlayAreaBorderThickness(GameObject playArea)`
	`44`	`+ public override float GetPlayAreaBorderThickness()`
`47`	`45`	`{`
`48`	`46`	`return 0f;`
`49`	`47`	`}`
`50`	`48`
`51`	`49`	`/// <summary>`
`52`	`50`	`/// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.`
`53`	`51`	`/// </summary>`
`54`		`- /// <param name="playArea">The GameObject containing the play area representation.</param>`
`55`	`52`	`/// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>`
`56`		`- public override bool IsPlayAreaSizeCalibrated(GameObject playArea)`
	`53`	`+ public override bool IsPlayAreaSizeCalibrated()`
`57`	`54`	`{`
`58`	`55`	`return false;`
`59`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -527,19 +527,19 @@ public static Transform GetPlayArea()`
`527`	`527`	`return GetBoundariesSDK().GetPlayArea();`
`528`	`528`	`}`
`529`	`529`
`530`		`- public static Vector3[] GetPlayAreaVertices(GameObject playArea)`
	`530`	`+ public static Vector3[] GetPlayAreaVertices()`
`531`	`531`	`{`
`532`		`- return GetBoundariesSDK().GetPlayAreaVertices(playArea);`
	`532`	`+ return GetBoundariesSDK().GetPlayAreaVertices();`
`533`	`533`	`}`
`534`	`534`
`535`		`- public static float GetPlayAreaBorderThickness(GameObject playArea)`
	`535`	`+ public static float GetPlayAreaBorderThickness()`
`536`	`536`	`{`
`537`		`- return GetBoundariesSDK().GetPlayAreaBorderThickness(playArea);`
	`537`	`+ return GetBoundariesSDK().GetPlayAreaBorderThickness();`
`538`	`538`	`}`
`539`	`539`
`540`		`- public static bool IsPlayAreaSizeCalibrated(GameObject playArea)`
	`540`	`+ public static bool IsPlayAreaSizeCalibrated()`
`541`	`541`	`{`
`542`		`- return GetBoundariesSDK().IsPlayAreaSizeCalibrated(playArea);`
	`542`	`+ return GetBoundariesSDK().IsPlayAreaSizeCalibrated();`
`543`	`543`	`}`
`544`	`544`
`545`	`545`	`public static bool GetDrawAtRuntime()`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ protected virtual void DrawWireframe()`
`56`	`56`	`return;`
`57`	`57`	`}`
`58`	`58`
`59`		`- var vertices = VRTK_SDK_Bridge.GetPlayAreaVertices(playArea.gameObject);`
	`59`	`+ var vertices = VRTK_SDK_Bridge.GetPlayAreaVertices();`
`60`	`60`	`if (vertices == null \|\| vertices.Length == 0)`
`61`	`61`	`{`
`62`	`62`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -232,7 +232,7 @@ protected virtual void InitPlayAreaCursor()`
`232`	`232`	`return;`
`233`	`233`	`}`
`234`	`234`
`235`		`- Vector3[] cursorDrawVertices = VRTK_SDK_Bridge.GetPlayAreaVertices(playArea.gameObject);`
	`235`	`+ Vector3[] cursorDrawVertices = VRTK_SDK_Bridge.GetPlayAreaVertices();`
`236`	`236`	`if (validLocationObject != null)`
`237`	`237`	`{`
`238`	`238`	`GeneratePlayAreaCursorFromPrefab(cursorDrawVertices);`
`@@ -323,7 +323,7 @@ protected virtual void GeneratePlayAreaCursor(Vector3[] cursorDrawVertices)`
`323`	`323`	`{`
`324`	`324`	`if (playAreaCursorDimensions != Vector2.zero)`
`325`	`325`	`{`
`326`		`- var customAreaPadding = VRTK_SDK_Bridge.GetPlayAreaBorderThickness(playArea.gameObject);`
	`326`	`+ var customAreaPadding = VRTK_SDK_Bridge.GetPlayAreaBorderThickness();`
`327`	`327`
`328`	`328`	`cursorDrawVertices[btmRightOuter] = new Vector3(playAreaCursorDimensions.x / 2, 0f, (playAreaCursorDimensions.y / 2) * -1);`
`329`	`329`	`cursorDrawVertices[btmLeftOuter] = new Vector3((playAreaCursorDimensions.x / 2) * -1, 0f, (playAreaCursorDimensions.y / 2) * -1);`