No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

SelectableTests.cs 19KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498
  1. using System.Reflection;
  2. using System.Collections;
  3. using NUnit.Framework;
  4. using UnityEngine.EventSystems;
  5. using UnityEngine.TestTools;
  6. namespace UnityEngine.UI.Tests
  7. {
  8. [TestFixture]
  9. class SelectableTests
  10. {
  11. private class SelectableTest : Selectable
  12. {
  13. public bool isStateNormal { get { return currentSelectionState == SelectionState.Normal; } }
  14. public bool isStateHighlighted { get { return currentSelectionState == SelectionState.Highlighted; } }
  15. public bool isStateSelected { get { return currentSelectionState == SelectionState.Selected; } }
  16. public bool isStatePressed { get { return currentSelectionState == SelectionState.Pressed; } }
  17. public bool isStateDisabled { get { return currentSelectionState == SelectionState.Disabled; } }
  18. public Selectable GetSelectableAtIndex(int index)
  19. {
  20. return s_Selectables[index];
  21. }
  22. public int GetSelectableCurrentIndex()
  23. {
  24. return m_CurrentIndex;
  25. }
  26. }
  27. private SelectableTest selectable;
  28. private GameObject m_CanvasRoot;
  29. private GameObject m_EventSystemGO;
  30. private CanvasGroup CreateAndParentGroupTo(string name, GameObject child)
  31. {
  32. GameObject canvasRoot = new GameObject("Canvas", typeof(RectTransform), typeof(Canvas));
  33. GameObject groupGO = new GameObject(name, typeof(RectTransform), typeof(CanvasGroup));
  34. groupGO.transform.SetParent(canvasRoot.transform);
  35. child.transform.SetParent(groupGO.transform);
  36. return groupGO.GetComponent<CanvasGroup>();
  37. }
  38. [SetUp]
  39. public void TestSetup()
  40. {
  41. m_EventSystemGO = new GameObject("EventSystem", typeof(EventSystem));
  42. EventSystem.current = m_EventSystemGO.GetComponent<EventSystem>();
  43. m_CanvasRoot = new GameObject("Canvas", typeof(RectTransform), typeof(Canvas));
  44. GameObject SelectableGO = new GameObject("Selectable", typeof(RectTransform), typeof(CanvasRenderer));
  45. SelectableGO.transform.SetParent(m_CanvasRoot.transform);
  46. selectable = SelectableGO.AddComponent<SelectableTest>();
  47. selectable.targetGraphic = selectable.gameObject.AddComponent<ConcreteGraphic>();
  48. }
  49. [TearDown]
  50. public void TearDown()
  51. {
  52. GameObject.DestroyImmediate(m_CanvasRoot);
  53. GameObject.DestroyImmediate(m_EventSystemGO);
  54. }
  55. [Test] // regression test 1160054
  56. public void SelectableArrayRemovesReferenceUponDisable()
  57. {
  58. int originalSelectableCount = Selectable.allSelectableCount;
  59. selectable.enabled = false;
  60. Assert.AreEqual(originalSelectableCount - 1, Selectable.allSelectableCount, "We have more then originalSelectableCount - 1 selectable objects.");
  61. //ensure the item as the last index is nulled out as it replaced the item that was disabled.
  62. Assert.IsNull(selectable.GetSelectableAtIndex(Selectable.allSelectableCount));
  63. selectable.enabled = true;
  64. }
  65. #region Selected object
  66. [Test]
  67. public void SettingCurrentSelectedSelectableNonInteractableShouldNullifyCurrentSelected()
  68. {
  69. EventSystem.current.SetSelectedGameObject(selectable.gameObject);
  70. selectable.interactable = false;
  71. // it should be unselected now that it is not interactable anymore
  72. Assert.IsNull(EventSystem.current.currentSelectedGameObject);
  73. }
  74. [Test]
  75. public void PointerEnterDownShouldMakeItSelectedGameObject()
  76. {
  77. Assert.IsNull(EventSystem.current.currentSelectedGameObject);
  78. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current));
  79. selectable.InvokeOnPointerDown(new PointerEventData(EventSystem.current));
  80. Assert.AreEqual(selectable.gameObject, EventSystem.current.currentSelectedGameObject);
  81. }
  82. [Test]
  83. public void OnSelectShouldSetSelectedState()
  84. {
  85. Assert.True(selectable.isStateNormal);
  86. selectable.OnSelect(new BaseEventData(EventSystem.current));
  87. Assert.True(selectable.isStateSelected);
  88. }
  89. [Test]
  90. public void OnDeselectShouldUnsetSelectedState()
  91. {
  92. Assert.True(selectable.isStateNormal);
  93. selectable.OnSelect(new BaseEventData(EventSystem.current));
  94. Assert.True(selectable.isStateSelected);
  95. selectable.OnDeselect(new BaseEventData(EventSystem.current));
  96. Assert.True(selectable.isStateNormal);
  97. }
  98. #endregion
  99. #region Interactable
  100. [Test]
  101. public void SettingCanvasGroupNotInteractableShouldMakeSelectableNotInteractable()
  102. {
  103. // Canvas Group on same object
  104. var group = selectable.gameObject.AddComponent<CanvasGroup>();
  105. Assert.IsTrue(selectable.IsInteractable());
  106. group.interactable = false;
  107. // actual call happens on the native side, cause by interactable = false
  108. selectable.InvokeOnCanvasGroupChanged();
  109. Assert.IsFalse(selectable.IsInteractable());
  110. }
  111. [Test]
  112. public void DisablingCanvasGroupShouldMakeSelectableAsInteractable()
  113. {
  114. var group = selectable.gameObject.AddComponent<CanvasGroup>();
  115. Assert.IsTrue(selectable.IsInteractable());
  116. group.enabled = false;
  117. group.interactable = false;
  118. selectable.InvokeOnCanvasGroupChanged();
  119. Assert.IsTrue(selectable.IsInteractable());
  120. }
  121. [Test]
  122. public void SettingParentCanvasGroupNotInteractableShouldMakeSelectableNotInteractable()
  123. {
  124. var canvasGroup = CreateAndParentGroupTo("CanvasGroup", selectable.gameObject);
  125. Assert.IsTrue(selectable.IsInteractable());
  126. canvasGroup.interactable = false;
  127. // actual call happens on the native side, cause by interactable = false
  128. selectable.InvokeOnCanvasGroupChanged();
  129. Assert.IsFalse(selectable.IsInteractable());
  130. }
  131. [Test]
  132. public void SettingParentParentCanvasGroupNotInteractableShouldMakeSelectableNotInteractable()
  133. {
  134. var canvasGroup1 = CreateAndParentGroupTo("CanvasGroup1", selectable.gameObject);
  135. var canvasGroup2 = CreateAndParentGroupTo("CanvasGroup2", canvasGroup1.gameObject);
  136. Assert.IsTrue(selectable.IsInteractable());
  137. canvasGroup2.interactable = false;
  138. // actual call happens on the native side, cause by interactable = false
  139. selectable.InvokeOnCanvasGroupChanged();
  140. Assert.IsFalse(selectable.IsInteractable());
  141. }
  142. [Test]
  143. public void SettingParentParentCanvasGroupInteractableShouldMakeSelectableInteractable()
  144. {
  145. var canvasGroup1 = CreateAndParentGroupTo("CanvasGroup1", selectable.gameObject);
  146. CreateAndParentGroupTo("CanvasGroup2", canvasGroup1.gameObject);
  147. Assert.IsTrue(selectable.IsInteractable());
  148. // actual call happens on the native side, cause by interactable
  149. selectable.InvokeOnCanvasGroupChanged();
  150. Assert.IsTrue(selectable.IsInteractable());
  151. }
  152. [Test]
  153. public void SettingParentParentCanvasGroupNotInteractableShouldNotMakeSelectableNotInteractableIfIgnoreParentGroups()
  154. {
  155. var canvasGroup1 = CreateAndParentGroupTo("CanvasGroup1", selectable.gameObject);
  156. canvasGroup1.ignoreParentGroups = true;
  157. var canvasGroup2 = CreateAndParentGroupTo("CanvasGroup2", canvasGroup1.gameObject);
  158. Assert.IsTrue(selectable.IsInteractable());
  159. canvasGroup2.interactable = false;
  160. // actual call happens on the native side, cause by interactable = false
  161. selectable.InvokeOnCanvasGroupChanged();
  162. Assert.IsTrue(selectable.IsInteractable());
  163. }
  164. [Test]// regression test 861736
  165. public void PointerEnterThenSetNotInteractableThenExitThenSetInteractableShouldSetStateToDefault()
  166. {
  167. Assert.True(selectable.isStateNormal);
  168. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  169. {
  170. pointerEnter = selectable.gameObject
  171. });
  172. Assert.True(selectable.isStateHighlighted);
  173. selectable.interactable = false;
  174. selectable.InvokeOnPointerExit(new PointerEventData(EventSystem.current)
  175. {
  176. pointerEnter = selectable.gameObject
  177. });
  178. selectable.interactable = true;
  179. Assert.False(selectable.isStateHighlighted);
  180. Assert.True(selectable.isStateNormal);
  181. }
  182. [Test]// regression test 861736
  183. public void PointerEnterThenSetNotInteractableThenSetInteractableShouldStayHighlighted()
  184. {
  185. Assert.True(selectable.isStateNormal);
  186. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  187. {
  188. pointerEnter = selectable.gameObject
  189. });
  190. Assert.True(selectable.isStateHighlighted);
  191. selectable.interactable = false;
  192. selectable.interactable = true;
  193. Assert.True(selectable.isStateHighlighted);
  194. }
  195. [Test]
  196. public void InstantiatingSelectableUnderNotInteractableCanvasGroupShouldAlsoNotBeInteractable()
  197. {
  198. var canvasGroup = CreateAndParentGroupTo("ParentGroup", selectable.gameObject);
  199. canvasGroup.interactable = false;
  200. Assert.False(canvasGroup.interactable);
  201. var newSelectable = Object.Instantiate(selectable.gameObject, canvasGroup.transform).GetComponent<SelectableTest>();
  202. Assert.False(newSelectable.IsInteractable());
  203. }
  204. #endregion
  205. #region Tweening
  206. [UnityTest]
  207. public IEnumerator SettingNotInteractableShouldTweenToDisabledColor()
  208. {
  209. var canvasRenderer = selectable.gameObject.GetComponent<CanvasRenderer>();
  210. selectable.InvokeOnEnable();
  211. canvasRenderer.SetColor(selectable.colors.normalColor);
  212. selectable.interactable = false;
  213. yield return new WaitForSeconds(1);
  214. Assert.AreEqual(selectable.colors.disabledColor, canvasRenderer.GetColor());
  215. selectable.interactable = true;
  216. yield return new WaitForSeconds(1);
  217. Assert.AreEqual(selectable.colors.normalColor, canvasRenderer.GetColor());
  218. }
  219. [UnityTest][Ignore("Fails")] // regression test 742140
  220. public IEnumerator SettingNotInteractableThenInteractableShouldNotTweenToDisabledColor()
  221. {
  222. var canvasRenderer = selectable.gameObject.GetComponent<CanvasRenderer>();
  223. selectable.enabled = false;
  224. selectable.enabled = true;
  225. canvasRenderer.SetColor(selectable.colors.normalColor);
  226. selectable.interactable = false;
  227. selectable.interactable = true;
  228. Color c = canvasRenderer.GetColor();
  229. for (int i = 0; i < 30; i++)
  230. {
  231. yield return null;
  232. Color c2 = canvasRenderer.GetColor();
  233. Assert.AreNotEqual(c2, c);
  234. }
  235. Assert.AreEqual(selectable.colors.normalColor, canvasRenderer.GetColor());
  236. }
  237. [UnityTest]
  238. public IEnumerator SettingInteractableToFalseTrueFalseShouldTweenToDisabledColor()
  239. {
  240. var canvasRenderer = selectable.gameObject.GetComponent<CanvasRenderer>();
  241. selectable.InvokeOnEnable();
  242. canvasRenderer.SetColor(selectable.colors.normalColor);
  243. selectable.interactable = false;
  244. selectable.interactable = true;
  245. selectable.interactable = false;
  246. yield return new WaitForSeconds(1);
  247. Assert.AreEqual(selectable.colors.disabledColor, canvasRenderer.GetColor());
  248. }
  249. #if PACKAGE_ANIMATION
  250. [Test]
  251. public void TriggerAnimationWithNoAnimator()
  252. {
  253. Assert.Null(selectable.animator);
  254. Assert.DoesNotThrow(() => selectable.InvokeTriggerAnimation("asdasd"));
  255. }
  256. [Test]
  257. public void TriggerAnimationWithDisabledAnimator()
  258. {
  259. var an = selectable.gameObject.AddComponent<Animator>();
  260. an.enabled = false;
  261. Assert.NotNull(selectable.animator);
  262. Assert.DoesNotThrow(() => selectable.InvokeTriggerAnimation("asdasd"));
  263. }
  264. [Test]
  265. public void TriggerAnimationAnimatorWithNoRuntimeController()
  266. {
  267. var an = selectable.gameObject.AddComponent<Animator>();
  268. an.runtimeAnimatorController = null;
  269. Assert.NotNull(selectable.animator);
  270. Assert.DoesNotThrow(() => selectable.InvokeTriggerAnimation("asdasd"));
  271. }
  272. #endif
  273. #endregion
  274. #region Selection state and pointer
  275. [Test]
  276. public void SelectShouldSetSelectedObject()
  277. {
  278. Assert.Null(EventSystem.current.currentSelectedGameObject);
  279. selectable.Select();
  280. Assert.AreEqual(selectable.gameObject, EventSystem.current.currentSelectedGameObject);
  281. }
  282. [Test]
  283. public void SelectWhenAlreadySelectingShouldNotSetSelectedObject()
  284. {
  285. Assert.Null(EventSystem.current.currentSelectedGameObject);
  286. var fieldInfo = typeof(EventSystem).GetField("m_SelectionGuard", BindingFlags.NonPublic | BindingFlags.Instance);
  287. fieldInfo
  288. .SetValue(EventSystem.current, true);
  289. selectable.Select();
  290. Assert.Null(EventSystem.current.currentSelectedGameObject);
  291. }
  292. [Test]
  293. public void PointerEnterShouldHighlight()
  294. {
  295. Assert.True(selectable.isStateNormal);
  296. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  297. {
  298. pointerEnter = selectable.gameObject
  299. });
  300. Assert.True(selectable.isStateHighlighted);
  301. }
  302. [Test]
  303. public void PointerEnterOnSelectedObjectShouldStaySelected()
  304. {
  305. selectable.InvokeOnSelect(null);
  306. Assert.True(selectable.isStateSelected);
  307. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  308. {
  309. pointerEnter = selectable.gameObject
  310. });
  311. Assert.True(selectable.isStateSelected);
  312. }
  313. [Test]
  314. public void PointerEnterAndRightClickShouldHighlightNotPress()
  315. {
  316. Assert.True(selectable.isStateNormal);
  317. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  318. {
  319. pointerEnter = selectable.gameObject
  320. });
  321. selectable.InvokeOnPointerDown(new PointerEventData(EventSystem.current)
  322. {
  323. button = PointerEventData.InputButton.Right
  324. });
  325. Assert.True(selectable.isStateHighlighted);
  326. }
  327. [Test]
  328. public void PointerEnterAndRightClickShouldPress()
  329. {
  330. Assert.True(selectable.isStateNormal);
  331. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  332. {
  333. pointerEnter = selectable.gameObject
  334. });
  335. selectable.InvokeOnPointerDown(new PointerEventData(EventSystem.current));
  336. Assert.True(selectable.isStatePressed);
  337. }
  338. [Test]
  339. public void PointerEnterLeftClickExitShouldPress()
  340. {
  341. Assert.True(selectable.isStateNormal);
  342. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  343. {
  344. pointerEnter = selectable.gameObject
  345. });
  346. selectable.InvokeOnPointerDown(new PointerEventData(EventSystem.current));
  347. selectable.InvokeOnPointerExit(new PointerEventData(EventSystem.current)
  348. {
  349. pointerEnter = selectable.gameObject
  350. });
  351. Assert.True(selectable.isStatePressed);
  352. }
  353. [Test]
  354. public void PointerEnterLeftClickExitReleaseShouldSelect()
  355. {
  356. Assert.True(selectable.isStateNormal);
  357. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  358. {
  359. pointerEnter = selectable.gameObject
  360. });
  361. selectable.InvokeOnPointerDown(new PointerEventData(EventSystem.current));
  362. selectable.InvokeOnPointerExit(new PointerEventData(EventSystem.current)
  363. {
  364. pointerEnter = selectable.gameObject
  365. });
  366. selectable.InvokeOnPointerUp(new PointerEventData(EventSystem.current));
  367. Assert.True(selectable.isStateSelected);
  368. }
  369. [Test]
  370. public void PointerDownShouldSetSelectedObject()
  371. {
  372. Assert.Null(EventSystem.current.currentSelectedGameObject);
  373. selectable.InvokeOnPointerDown(new PointerEventData(EventSystem.current));
  374. Assert.AreEqual(selectable.gameObject, EventSystem.current.currentSelectedGameObject);
  375. }
  376. [Test]
  377. public void PointerLeftDownRightDownRightUpShouldNotChangeState()
  378. {
  379. Assert.True(selectable.isStateNormal);
  380. selectable.InvokeOnPointerEnter(new PointerEventData(EventSystem.current)
  381. {
  382. pointerEnter = selectable.gameObject
  383. });
  384. selectable.InvokeOnPointerDown(new PointerEventData(EventSystem.current) { button = PointerEventData.InputButton.Left });
  385. selectable.InvokeOnPointerDown(new PointerEventData(EventSystem.current) { button = PointerEventData.InputButton.Right });
  386. selectable.InvokeOnPointerUp(new PointerEventData(EventSystem.current) { button = PointerEventData.InputButton.Right });
  387. Assert.True(selectable.isStatePressed);
  388. }
  389. [Test, Ignore("No disabled state assigned ? Investigate")]
  390. public void SettingNotInteractableShouldDisable()
  391. {
  392. Assert.True(selectable.isStateNormal);
  393. selectable.interactable = false;
  394. selectable.InvokeOnCanvasGroupChanged();
  395. Assert.True(selectable.isStateDisabled);
  396. }
  397. #endregion
  398. #region No event system
  399. [Test] // regression test 787563
  400. public void SettingInteractableWithNoEventSystemShouldNotCrash()
  401. {
  402. EventSystem.current.enabled = false;
  403. selectable.interactable = false;
  404. }
  405. [Test] // regression test 787563
  406. public void OnPointerDownWithNoEventSystemShouldNotCrash()
  407. {
  408. EventSystem.current.enabled = false;
  409. selectable.OnPointerDown(new PointerEventData(EventSystem.current) {button = PointerEventData.InputButton.Left});
  410. }
  411. [Test] // regression test 787563
  412. public void SelectWithNoEventSystemShouldNotCrash()
  413. {
  414. EventSystem.current.enabled = false;
  415. selectable.Select();
  416. }
  417. #endregion
  418. }
  419. }