mixedreality/com.microsoft.mixedreality.toolkit.foundation/SDK/Experimental/Dock/Dock.cs

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System;
using System.Collections.ObjectModel;
using UnityEngine;
using UnityEngine.Assertions;

namespace Microsoft.MixedReality.Toolkit.Experimental.UI
{
    /// <summary>
    /// This control enables moving objects in and out of predetermined positions, 
    /// to create palettes, shelves and navigation bars.
    /// </summary>
    /// <seealso cref="Dockable"/>
    /// <seealso cref="DockPosition"/>
    [AddComponentMenu("Scripts/MRTK/Experimental/Dock/Dock")]
    public class Dock : MonoBehaviour
    {
        /// <summary>
        /// A read-only list of possible positions in this dock.
        /// </summary>
        [Experimental]
        [SerializeField]
        [Tooltip("A read-only list of possible positions in this dock.")]
        private ReadOnlyCollection<DockPosition> dockPositions;

        /// <summary>
        /// A read-only list of possible positions in this dock.
        /// </summary>
        public ReadOnlyCollection<DockPosition> DockPositions => dockPositions;

        /// <summary>
        /// Initializes the list of positions in this dock.
        /// </summary>
        private void OnEnable()
        {
            UpdatePositions();
        }

        /// <summary>
        /// Updates the list of positions in this dock when its children change.
        /// </summary>
        private void OnTransformChildrenChanged()
        {
            UpdatePositions();
        }

        /// <summary>
        /// Updates the list of positions in this dock.
        /// </summary>
        private void UpdatePositions()
        {
            dockPositions = gameObject.GetComponentsInChildren<DockPosition>().ToReadOnlyCollection();
        }

        /// <summary>
        /// Moves elements near the desired position to make space for a new element,
        /// if possible.
        /// </summary>
        /// <param name="position">The desired position where an object wants to be docked.</param>
        /// <returns>Returns true if the desired position is now available, false otherwise.</returns>
        public bool TryMoveToFreeSpace(DockPosition position)
        {
            if (dockPositions == null)
            {
                UpdatePositions();
            }

            if (!dockPositions.Contains(position))
            {
                Debug.LogError("Looking for a DockPosition in the wrong Dock.");
                return false;
            }

            var index = dockPositions.IndexOf(position);

            if (!dockPositions[index].IsOccupied)
            {
                // Already free
                return true;
            }

            // Where is the closest free space? (on a tie, favor left)
            int? closestFreeSpace = null;
            int distanceToClosestFreeSpace = int.MaxValue;
            for (int i = 0; i < dockPositions.Count; i++)
            {
                var distance = Math.Abs(index - i);
                if (!dockPositions[i].IsOccupied && distance < distanceToClosestFreeSpace)
                {
                    closestFreeSpace = i;
                    distanceToClosestFreeSpace = distance;
                }
            }

            if (closestFreeSpace == null)
            {
                // No free space
                return false;
            }

            if (closestFreeSpace < index)
            {
                // Move left

                // Check if we can undock all of them
                for (int i = closestFreeSpace.Value + 1; i <= index; i++)
                {
                    if (!dockPositions[i].DockedObject.CanUndock)
                    {
                        return false;
                    }
                }

                for (int i = closestFreeSpace.Value + 1; i <= index; i++)
                {
                    MoveDockedObject(i, i - 1);
                }
            }
            else
            {
                // Move right

                // Check if we can undock all of them
                for (int i = closestFreeSpace.Value - 1; i >= index; i--)
                {
                    if (!dockPositions[i].DockedObject.CanUndock)
                    {
                        return false;
                    }
                }

                for (int i = closestFreeSpace.Value - 1; i >= index; i--)
                {
                    MoveDockedObject(i, i + 1);
                }
            }

            return true;
        }

        /// <summary>
        /// Moves a docked object from a position to another, by undocking it 
        /// and docking it in the new position.
        /// </summary>
        /// <param name="from">The position we're moving the object from.</param>
        /// <param name="to">The position we're moving the object to.</param>
        private void MoveDockedObject(int from, int to)
        {
            var objectToMove = dockPositions[from].DockedObject;
            objectToMove.Undock();
            objectToMove.Dock(dockPositions[to]);
            Assert.AreEqual(dockPositions[to].DockedObject, objectToMove, "The object we just moved needs to match the object docked in the new position.");
        }
    }
}