Skip to content

Commit 28c5833

Browse files
committed
Fixing documentation problems + removing dead code (old BoundsCorners property)
1 parent 10029df commit 28c5833

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

Assets/MRTK/SDK/Features/UX/Scripts/BoundsControl/BoundsControl.cs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,6 @@ public ElasticsManager ElasticsManager
562562
private static readonly List<Vector3> TotalBoundsCorners = new List<Vector3>();
563563

564564
private Vector3[] boundsCorners = new Vector3[8];
565-
public Vector3[] BoundsCorners { get; private set; }
566565

567566
#endregion
568567

@@ -575,6 +574,14 @@ public ElasticsManager ElasticsManager
575574

576575
// TODO Review this, it feels like we should be using Behaviour.enabled instead.
577576
private bool active = false;
577+
578+
/// <summary>
579+
/// Whether the bounds control is currently active and will respond to input.
580+
/// </summary>
581+
/// <remarks>
582+
/// Setting this property will also set the entire gameObject's active state, as well as
583+
/// resetting the visuals and proximity scale effects.
584+
/// </remarks>
578585
public bool Active
579586
{
580587
get
@@ -621,7 +628,7 @@ private bool IsInitialized
621628
#region Public Methods
622629

623630
/// <summary>
624-
/// Allows to manually enable wire (edge) highlighting (edges) of the bounds control.
631+
/// Allows the manual enabling of the wireframe display of the bounds control.
625632
/// This is useful if connected to the Manipulation events of a
626633
/// <see cref="Microsoft.MixedReality.Toolkit.UI.ObjectManipulator"/>
627634
/// when used in conjunction with this MonoBehavior.
@@ -631,6 +638,9 @@ public void HighlightWires()
631638
SetHighlighted(null);
632639
}
633640

641+
/// <summary>
642+
/// Allows the manual disabling of the wireframe display.
643+
/// </summary>
634644
public void UnhighlightWires()
635645
{
636646
ResetVisuals();

0 commit comments

Comments
 (0)