VR4RoboticArm2/VR4RoboticArm/Library/PackageCache/com.meta.xr.sdk.interaction/Runtime/Scripts/Interaction/Visuals/DebugTreeUI.cs

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * Licensed under the Oculus SDK License Agreement (the "License");
 * you may not use the Oculus SDK except in compliance with the License,
 * which is provided at the time of installation or download, or which
 * otherwise accompanies this software in either electronic or hard copy form.
 *
 * You may obtain a copy of the License at
 *
 * https://developer.oculus.com/licenses/oculussdk/
 *
 * Unless required by applicable law or agreed to in writing, the Oculus SDK
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

using System.Collections;
using UnityEngine;
using TMPro;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace Oculus.Interaction.DebugTree
{
    /// <summary>
    /// Interface indicating the inheriting type can be represented as a node in a tree-like UI structure for debugging
    /// and other development purposes.
    /// </summary>
    /// <remarks>
    /// This type is explicitly intended for use alongside <see cref="DebugTreeUI{TLeaf}"/>; for a canonical usage example,
    /// see <see cref="PoseDetection.Debug.ActiveStateDebugTreeUI"/>.
    /// </remarks>
    /// <typeparam name="TLeaf"></typeparam>
    public interface INodeUI<TLeaf>
        where TLeaf : class
    {
        /// <summary>
        /// The region in which children of this node within the UI tree should be displayed.
        /// </summary>
        RectTransform ChildArea { get; }

        /// <summary>
        /// This method should only be called by the <see cref="DebugTreeUI{TLeaf}"/> which contains this node. Associates the
        /// provided <paramref name="node"/> with this UI representation for it.
        /// </summary>
        /// <param name="node">The node which this INodeUI<TLeaf> should be bound to represent</param>
        /// <param name="isRoot">Indicates whether or not <paramref name="node"/> is the root node of the tree</param>
        /// <param name="isDuplicate">Indicates whether <paramref name="node"/> has already been bound to a different INodeUI<TLeaf></param>
        void Bind(ITreeNode<TLeaf> node, bool isRoot, bool isDuplicate);
    }

    public abstract class DebugTreeUI<TLeaf> : MonoBehaviour
        where TLeaf : class
    {
        [Tooltip("Node prefabs will be instantiated inside of this content area.")]
        [SerializeField]
        private RectTransform _contentArea;

        [Tooltip("This title text will display the GameObject name of the IActiveState.")]
        [SerializeField, Optional]
        private TMP_Text _title;

        [Tooltip("If true, the tree UI will be built on Start.")]
        [SerializeField]
        private bool _buildTreeOnStart;

        protected abstract TLeaf Value { get; }
        protected abstract INodeUI<TLeaf> NodePrefab { get; }

        private DebugTree<TLeaf> _tree;

        private Dictionary<ITreeNode<TLeaf>, INodeUI<TLeaf>> _nodeToUI
            = new Dictionary<ITreeNode<TLeaf>, INodeUI<TLeaf>>();

        protected virtual void Start()
        {
            this.AssertField(Value, nameof(Value));
            this.AssertField(NodePrefab, nameof(NodePrefab));
            this.AssertField(_contentArea, nameof(_contentArea));

            if (_buildTreeOnStart)
            {
                StartCoroutine(BuildTree());
            }
        }

        public IEnumerator BuildTree()
        {
            _tree = CreateTree(Value);
            Task task = _tree.RebuildAsync();
            yield return new WaitUntil(() => task.IsCompleted);

            _nodeToUI.Clear();
            ClearContentArea();
            SetTitleText();
            BuildTreeRecursive(_contentArea, _tree.GetRootNode(), true);
        }

        private void BuildTreeRecursive(
            RectTransform parent, ITreeNode<TLeaf> node, bool isRoot)
        {
            INodeUI<TLeaf> nodeUI = Instantiate(NodePrefab as Object, parent) as INodeUI<TLeaf>;

            bool isDuplicate = _nodeToUI.ContainsKey(node);
            nodeUI.Bind(node, isRoot, isDuplicate);

            if (!isDuplicate)
            {
                _nodeToUI.Add(node, nodeUI);
                foreach (var child in node.Children)
                {
                    BuildTreeRecursive(nodeUI.ChildArea, child, false);
                }
            }
        }

        private void ClearContentArea()
        {
            for (int i = 0; i < _contentArea.childCount; ++i)
            {
                Transform child = _contentArea.GetChild(i);
                if (child != null && child.TryGetComponent<INodeUI<TLeaf>>(out _))
                {
                    Destroy(child.gameObject);
                }
            }
        }

        private void SetTitleText()
        {
            if (_title != null)
            {
                _title.text = TitleForValue(Value);
            }
        }

        protected abstract DebugTree<TLeaf> CreateTree(TLeaf value);
        protected abstract string TitleForValue(TLeaf value);

#if UNITY_EDITOR
        private void OnValidate()
        {
            SetTitleText();
        }
#endif
    }
}