From 878948bd0f1603916907b053cfe2df5b00a0fb69 Mon Sep 17 00:00:00 2001
From: Simon Jackson <darkside@zenithmoon.com>
Date: Wed, 12 Jul 2017 20:04:53 +0100
Subject: [PATCH] Added UIHighlightable control and docs

---
 README.md                                 |   2 +-
 Scripts/Utilities/UIHighlightable.cs      | 119 ++++++++++++++++++++++
 Scripts/Utilities/UIHighlightable.cs.meta |  12 +++
 3 files changed, 132 insertions(+), 1 deletion(-)
 create mode 100644 Scripts/Utilities/UIHighlightable.cs
 create mode 100644 Scripts/Utilities/UIHighlightable.cs.meta

diff --git a/README.md b/README.md
index 2803b58..d53fad6 100644
--- a/README.md
+++ b/README.md
@@ -148,7 +148,7 @@ ReturnKeyTrigger|TabNavigation|uGUITools|ScrollRectTweener|ScrollRectLinker
 ScrollRectEx|UI_InfiniteScroll|UI_ScrollRectOcclusion|UIScrollToSelection|UISelectableExtension
 switchToRectTransform|ScrollConflictManager|CLFZ2 (Encryption)|Serialization|DragCorrector
 PPIViewer|UI_TweenScale|UI_InfiniteScroll|UI_ScrollRectOcclusion|NonDrawingGraphic
-UILineConnector||||
+UILineConnector|UIHighlightable|||
 ||||
 
 *More to come*
diff --git a/Scripts/Utilities/UIHighlightable.cs b/Scripts/Utilities/UIHighlightable.cs
new file mode 100644
index 0000000..09d4798
--- /dev/null
+++ b/Scripts/Utilities/UIHighlightable.cs
@@ -0,0 +1,119 @@
+/// Credit SimonDarksideJ
+/// Sourced from - Issue Proposal #153
+
+using UnityEngine.EventSystems;
+
+namespace UnityEngine.UI.Extensions
+{
+    [AddComponentMenu("UI/Extensions/UI Highlightable Extension")]
+    [RequireComponent(typeof(RectTransform), typeof(Graphic))]
+    public class UIHighlightable : MonoBehaviour, IPointerEnterHandler, IPointerExitHandler, IPointerDownHandler, IPointerUpHandler
+    {
+        private Graphic m_Graphic;
+        private bool m_Highlighted;
+        private bool m_Pressed;
+
+        [System.Serializable]
+        public class InteractableChangedEvent : Events.UnityEvent<bool> { }
+
+        [SerializeField][Tooltip("Can this panel be interacted with or is it disabled? (does not affect child components)")]
+        private bool m_Interactable = true;
+        [SerializeField][Tooltip("Does the panel remain in the pressed state when clicked? (default false)")]
+        private bool m_ClickToHold;
+
+        public bool Interactable
+        {
+            get { return m_Interactable; }
+            set
+            {
+                m_Interactable = value;
+                HighlightInteractable(m_Graphic);
+                OnInteractableChanged.Invoke(m_Interactable);
+            }
+        }
+
+        public bool ClickToHold
+        {
+            get { return m_ClickToHold; }
+            set { m_ClickToHold = value; }
+        }
+
+        [Tooltip("The default color for the panel")]
+        public Color NormalColor = Color.grey;
+        [Tooltip("The color for the panel when a mouse is over it or it is in focus")]
+        public Color HighlightedColor = Color.yellow;
+        [Tooltip("The color for the panel when it is clicked/held")]
+        public Color PressedColor = Color.green;
+        [Tooltip("The color for the panel when it is not interactable (see Interactable)")]
+        public Color DisabledColor = Color.gray;
+
+        [Tooltip("Event for when the panel is enabled / disabled, to enable disabling / enabling of child or other gameobjects")]
+        public InteractableChangedEvent OnInteractableChanged;
+
+        void Awake()
+        {
+            m_Graphic = GetComponent<Graphic>();
+        }
+
+        public void OnPointerEnter(PointerEventData eventData)
+        {
+            if (Interactable && !m_Pressed)
+            {
+                m_Highlighted = true;
+                m_Graphic.color = HighlightedColor;
+            }
+        }
+
+        public void OnPointerExit(PointerEventData eventData)
+        {
+            if (Interactable && !m_Pressed)
+            {
+                m_Highlighted = false;
+                m_Graphic.color = NormalColor;
+            }
+        }
+
+        public void OnPointerDown(PointerEventData eventData)
+        {
+            if (Interactable)
+            {
+                m_Graphic.color = PressedColor;
+                if (ClickToHold)
+                {
+                    m_Pressed = !m_Pressed;
+                }
+            }
+        }
+
+        public void OnPointerUp(PointerEventData eventData)
+        {
+            if(!m_Pressed) HighlightInteractable(m_Graphic);
+        }
+
+        private void HighlightInteractable(Graphic graphic)
+        {
+            if (m_Interactable)
+            {
+                if (m_Highlighted)
+                {
+                    graphic.color = HighlightedColor;
+                }
+                else
+                {
+                    graphic.color = NormalColor;
+                }
+            }
+            else
+            {
+                graphic.color = DisabledColor;
+            }
+        }
+
+#if UNITY_EDITOR
+        private void OnValidate()
+        {
+            HighlightInteractable(GetComponent<Graphic>());
+        }
+#endif
+    }
+}
\ No newline at end of file
diff --git a/Scripts/Utilities/UIHighlightable.cs.meta b/Scripts/Utilities/UIHighlightable.cs.meta
new file mode 100644
index 0000000..31fb1f7
--- /dev/null
+++ b/Scripts/Utilities/UIHighlightable.cs.meta
@@ -0,0 +1,12 @@
+fileFormatVersion: 2
+guid: d51a356e057c54d48abe97aa2cee2291
+timeCreated: 1499808539
+licenseType: Free
+MonoImporter:
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: