net.dreditor.ui 0.0.0-stage → 0.1.7

package/UIControls/ControlsUIPanel.cs

@@ -0,0 +1,49 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using UnityEngine;
+using UnityEngine.Serialization;
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [CreateAssetMenu(menuName = "DREditor/Controls UI/Control Panel", fileName = "Control Panel")]
+    public class ControlsUIPanel : ScriptableObject, IControlsUIPanel
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Header("")]
+        [Space]
+        [Tooltip("")]
+        [FormerlySerializedAs("PanelTitle")]
+        [SerializeField] protected string panelTitle;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Space]
+
+        [Tooltip("")]
+        [FormerlySerializedAs("ControlRows")]
+        [SerializeField] protected ControlPanelRow[] controlRows;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Space]
+
+        [Tooltip("")]
+        [FormerlySerializedAs("SystemDescription")]
+        [TextArea(minLines: 30, maxLines: 30)]
+        [SerializeField] protected string systemDescription;
+
+
+        public string Title => panelTitle;
+
+        public IControlRowData[] Rows => controlRows;
+
+        public string SystemDescription => systemDescription;
+    }
+}

package/UIControls/ControlsUIPanel.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 30cfb6c1f7ddded41847c0065d18fb60
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/UIControls/ControlsUIService.cs

@@ -0,0 +1,12 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Services;
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(ServiceHolder<ControlsUIService>) + " for type: " + nameof(ControlsUIService) +
+        "\n\n")]
+    public class ControlsUIService : ServiceHolder<ControlsUIService> { }
+}

package/UIControls/ControlsUIService.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 4eb314ea82fb4594e990af1677315b8b
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/UIControls/ControlsUISlot.cs

@@ -0,0 +1,243 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Input;
+using DREditor.Services;
+using DREditor.Utility;
+using NUnit.Framework;
+using System.Collections.Generic;
+using TMPro;
+using UnityEngine;
+using UnityEngine.InputSystem;
+using UnityEngine.UI;
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(IControlsUIRow) +
+        "\n\n")]
+    public class ControlsUISlot : MonoBehaviour, IControlsUIRow
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected Image left = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Image center = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Image right = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected TextMeshProUGUI controlKey = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected TextMeshProUGUI controlName = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected bool prioritizeImages = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected List<string> filterGroups = new()
+        {
+            "Delta/Mouse",
+            "Press/",
+            "Left Button/Left Click",
+            "Right Button/Right Click"
+        };
+
+
+        /// <summary>
+        /// 
+        /// </summary>
+        protected IControlRowData row;
+
+
+        /// <summary>
+        /// 
+        /// </summary>
+        protected readonly string UnboundName = "Unbound";
+
+
+        /// <inheritdoc/>
+        public virtual void DisplayRow(IControlRowData row)
+        {
+            InitializeRow(row);
+
+            ApplyRowData();
+
+            DisplayActiveSprites();
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="row"></param>
+        protected virtual void InitializeRow(IControlRowData row) => this.row = row;
+        
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void ApplyRowData()
+        {
+            PopulateKey();
+
+            PopulateDescription();
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        protected virtual void PopulateKey()
+        {
+            if (prioritizeImages)
+                PopulateImages();
+            else if (GetControlKey() is string keyName)
+                PopulateText(controlKey, FilterBindingName(keyName));
+            else
+                PopulateText(controlKey, UnboundName);
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <returns></returns>
+        protected virtual string GetControlKey()
+        {
+            if (!string.IsNullOrEmpty(row.ControlKey))
+                return row.ControlKey;
+            else if (row.ActionReference != null &&
+                GetKeyName(row.ActionReference) is string keyName &&
+                keyName != UnboundName)
+                return keyName;
+            else
+                return null;
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="action"></param>
+        /// <returns></returns>
+        protected virtual string GetKeyName(InputAction action)
+        {
+            if (!ServiceLocator.HasService(out IInputManager inputManager))
+                return UnboundName;
+
+            string currentControlScheme = inputManager.GetCurrentScheme();
+
+            int bindingIndex = action.GetBindingIndex(group: currentControlScheme);
+
+            if (bindingIndex == -1)
+                bindingIndex = GetGlobalBindingIndex(action);
+
+            if (bindingIndex == -1)
+                return UnboundName;
+            else if(action.bindings[bindingIndex].isPartOfComposite &&
+                bindingIndex - 1 >= 0)
+                return action.bindings[bindingIndex - 1].name;
+            else 
+                return action.GetBindingDisplayString(bindingIndex, InputBinding.DisplayStringOptions.DontUseShortDisplayNames);
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="action"></param>
+        /// <returns></returns>
+        private int GetGlobalBindingIndex(InputAction action)
+        {
+            for (int i = 0; i < action.bindings.Count; i++)
+                if (action.bindings[i].isComposite)
+                    continue;
+                else if (string.IsNullOrEmpty(action.bindings[i].groups))
+                    return i;
+
+            return -1;
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="keyName"></param>
+        /// <returns></returns>
+        protected virtual string FilterBindingName(string keyName)
+        {
+            foreach(var replaceGroup in filterGroups)
+                if (replaceGroup.Split("/") is string[] replacePair && replacePair.Length > 1)
+                    keyName = keyName.Replace(replacePair[0], replacePair[1]);
+
+            return keyName;
+        }
+
+
+        /// <summary>
+        /// 
+        /// </summary>
+        protected virtual void PopulateDescription() => PopulateText(controlName, row.ControlName);
+
+
+        /// <summary>
+        /// 
+        /// </summary>
+        protected virtual void PopulateImages()
+        {
+            PopulateImage(left, row.Left);
+
+            PopulateImage(center, row.Center);
+
+            PopulateImage(right, row.Right);
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="imageComponent"></param>
+        /// <param name="sprite"></param>
+        protected virtual void PopulateImage(Image imageComponent, Sprite sprite)
+        {
+            if (imageComponent != null)
+                imageComponent.sprite = sprite;
+        }
+
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="textComponent"></param>
+        /// <param name="text"></param>
+        protected virtual void PopulateText(TextMeshProUGUI textComponent, string text)
+        {
+            if (textComponent != null)
+                textComponent.text = text;
+        }
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void DisplayActiveSprites() => ImageUtility.SetActiveBySprite(left, center, right);
+    }
+}

package/UIControls/ControlsUISlot.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 37f0be7c6c7a5f04cb8600665ee6bf71
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/UIControls/ControlsUITab.cs

@@ -0,0 +1,80 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using UnityEngine;
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public abstract class ControlsUITab : MonoBehaviour
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected GameObject[] activeTabObjects;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected GameObject[] inactiveTabObjects;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected IControlsUIPanel activePanel;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="active"></param>
+        public virtual void Display(bool active, IControlsUIPanel activePanel)
+        {
+            this.activePanel = activePanel;
+
+            if (FailedVerification())
+                return;
+
+            SetTabObjectStates(active);
+
+            if (active)
+                DisplayActive();
+            else
+                DisplayInactive();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected abstract bool FailedVerification();
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="active"></param>
+        protected virtual void SetTabObjectStates(bool active)
+        {
+            foreach (var tabObject in activeTabObjects)
+                if (tabObject != null)
+                    tabObject.SetActive(active);
+
+            foreach (var tabObject in inactiveTabObjects)
+                if (tabObject != null)
+                    tabObject.SetActive(!active);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected abstract void DisplayActive();
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected abstract void DisplayInactive();
+    }
+}

package/UIControls/ControlsUITab.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: b3978bdfc98c74a4c83d51b03895537a
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/UIControls/IControlRowData.cs

@@ -0,0 +1,42 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using UnityEngine;
+using UnityEngine.InputSystem;
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public interface IControlRowData
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        Sprite Left { get; }
+
+        /// <summary>
+        ///
+        /// </summary>
+        Sprite Center { get; }
+
+        /// <summary>
+        ///
+        /// </summary>
+        Sprite Right { get; }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        InputActionReference ActionReference { get; }
+
+        /// <summary>
+        ///
+        /// </summary>
+        string ControlKey { get; }
+
+        /// <summary>
+        ///
+        /// </summary>
+        string ControlName { get; }
+    }
+}

package/UIControls/IControlRowData.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: aa5875cb3a36a5e4ab02a793328b83f8
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/UIControls/IControlsUIPanel.cs

@@ -0,0 +1,25 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public interface IControlsUIPanel
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        string Title { get; }
+
+        /// <summary>
+        ///
+        /// </summary>
+        IControlRowData[] Rows { get; }
+
+        /// <summary>
+        ///
+        /// </summary>
+        string SystemDescription { get; }
+    }
+}

package/UIControls/IControlsUIPanel.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: bc6ae6cd26399e64ea593479ab88619a
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/UIControls/IControlsUIRepository.cs

@@ -0,0 +1,17 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public interface IControlsUIRepository
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="id"></param>
+        /// <returns></returns>
+        IControlsUIPanel GetPanel(string id);
+    }
+}

package/UIControls/IControlsUIRepository.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 18c88fd2c4a514c45bf06212e62fe135
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/UIControls/IControlsUIRow.cs

@@ -0,0 +1,16 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public interface IControlsUIRow
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="row"></param>
+        void DisplayRow(IControlRowData row);
+    }
+}

package/UIControls/IControlsUIRow.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: f5bd2c85f0dd51c42aba1d15b60a3d03
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/UIControls/KeysUITab.cs

@@ -0,0 +1,85 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace DREditor.UI.UIControls
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(ControlsUITab) +
+        "\n\n")]
+    public class KeysUITab : ControlsUITab
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Transform rowParent;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected GameObject rowPrefab;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected List<GameObject> controlRows;
+
+
+        /// <inheritdoc/>
+        protected override bool FailedVerification()
+        {
+            bool result = rowPrefab == null && (controlRows.Count == 0 || controlRows[0] == null);
+
+            if (result)
+                UnityEngine.Debug.LogWarning($"ALERT: Could not display: {nameof(KeysUITab)} because it's control rows " +
+                    $"were either empty or the filled out rows are null.");
+
+            return result;
+        }
+
+        /// <inheritdoc/>
+        protected override void DisplayActive() => DisplayRows();
+
+        /// <inheritdoc/>
+        protected override void DisplayInactive() { }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void DisplayRows()
+        {
+            foreach(GameObject row in controlRows)
+                if (row != null)
+                    Destroy(row);
+
+            controlRows.Clear();
+
+            for (int i = 0; i < activePanel.Rows.Length; i++)
+                controlRows.Add(Instantiate(rowPrefab, rowParent));
+
+            for (int i = 0; i < activePanel.Rows.Length; i++)
+                if (i >= activePanel.Rows.Length)
+                    controlRows[i].SetActive(false);
+                else
+                    DisplayRow(controlRows[i].transform, i);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="rowTransform"></param>
+        /// <param name="i"></param>
+        protected virtual void DisplayRow(Transform rowTransform, int i)
+        {
+            rowTransform.gameObject.SetActive(true);
+
+            if (rowTransform.TryGetComponent(out IControlsUIRow row))
+                row.DisplayRow(activePanel.Rows[i]);
+        }
+    }
+}

package/UIControls/KeysUITab.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 210cc34289fdc6942865ef042dbe8efb
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: