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.

TilePaletteElement.cs 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367
  1. using System;
  2. using UnityEditor.ShortcutManagement;
  3. using UnityEditor.Toolbars;
  4. using UnityEngine.UIElements;
  5. namespace UnityEditor.Tilemaps
  6. {
  7. /// <summary>
  8. /// A Visual Element which handles and displays a Tile Palette Clipboard
  9. /// and its associated tools.
  10. /// </summary>
  11. /// <description>
  12. /// This Visual Element includes other Visual Elements that help with managing
  13. /// the Tile Palette Clipboard, which includes a popup dropdown for selecting
  14. /// the active Palette and a toolbar for enabling edits and showing visual aids
  15. /// in the Tile Palette Clipboard.
  16. /// </description>
  17. public class TilePaletteElement : VisualElement
  18. {
  19. /// <summary>
  20. /// Factory for TilePaletteElement.
  21. /// </summary>
  22. public class TilePaletteElementFactory : UxmlFactory<TilePaletteElement, TilePaletteElementUxmlTraits> {}
  23. /// <summary>
  24. /// UxmlTraits for TilePaletteElement.
  25. /// </summary>
  26. public class TilePaletteElementUxmlTraits : UxmlTraits {}
  27. private static readonly string ussClassName = "unity-tilepalette-element";
  28. private static readonly string toolbarUssClassName = ussClassName + "-toolbar";
  29. private static readonly string rightToolbarUssClassName = toolbarUssClassName + "-right";
  30. private static readonly string buttonStripClassName = "unity-editor-toolbar__button-strip";
  31. private static readonly string stripElementClassName = buttonStripClassName + "-element";
  32. private static readonly string leftStripElementClassName = stripElementClassName + "--left";
  33. private static readonly string middleStripElementClassName = stripElementClassName + "--middle";
  34. private static readonly string rightStripElementClassName = stripElementClassName + "--right";
  35. private static readonly string aloneStripElementClassName = stripElementClassName + "--alone";
  36. private static readonly string k_Name = L10n.Tr("Tile Palette Element");
  37. private TilePaletteClipboardElement m_ClipboardElement;
  38. private TilePaletteEditToggle m_EditToggle;
  39. /// <summary>
  40. /// Whether the clipboard is unlocked for editing.
  41. /// </summary>
  42. public bool clipboardUnlocked
  43. {
  44. get => m_ClipboardElement.clipboardUnlocked;
  45. set
  46. {
  47. m_ClipboardElement.clipboardUnlocked = value;
  48. m_EditToggle.SetValueWithoutNotify(value);
  49. }
  50. }
  51. internal GridPaintPaletteClipboard clipboardView => m_ClipboardElement.clipboardView;
  52. /// <summary>
  53. /// Initializes and returns an instance of TilePaletteElement.
  54. /// </summary>
  55. public TilePaletteElement()
  56. {
  57. AddToClassList(ussClassName);
  58. name = k_Name;
  59. TilePaletteOverlayUtility.SetStyleSheet(this);
  60. var toolbarElement = new VisualElement();
  61. toolbarElement.AddToClassList(toolbarUssClassName);
  62. Add(toolbarElement);
  63. m_ClipboardElement = new TilePaletteClipboardElement();
  64. Add(m_ClipboardElement);
  65. string[] leftToolbarElements = new[] { TilePaletteActivePalettePopupIcon.k_ToolbarId, TilePaletteActivePalettePopup.k_ToolbarId };
  66. var leftToolbar = EditorToolbar.CreateOverlay(leftToolbarElements);
  67. toolbarElement.Add(leftToolbar);
  68. var rightToolbarElement = new VisualElement();
  69. rightToolbarElement.AddToClassList(rightToolbarUssClassName);
  70. toolbarElement.Add(rightToolbarElement);
  71. string[] rightToolbarElements = new[] {
  72. TilePaletteEditToggle.k_ToolbarId
  73. , TilePaletteGridToggle.k_ToolbarId
  74. , TilePaletteGizmoToggle.k_ToolbarId
  75. , TilePaletteBrushElementToggle.k_ToolbarId
  76. };
  77. var rightToolbar = EditorToolbar.CreateOverlay(rightToolbarElements);
  78. SetupChildrenAsButtonStripForVisible(rightToolbar);
  79. rightToolbarElement.Add(rightToolbar);
  80. m_EditToggle = this.Q<TilePaletteEditToggle>();
  81. m_EditToggle.SetValueWithoutNotify(false);
  82. m_EditToggle.ToggleChanged += OnEditToggleChanged;
  83. var gridToggle = this.Q<TilePaletteGridToggle>();
  84. gridToggle.SetValueWithoutNotify(GridPaintingState.drawGridGizmo);
  85. gridToggle.ToggleChanged += OnGridToggleChanged;
  86. var gizmoToggle = this.Q<TilePaletteGizmoToggle>();
  87. gizmoToggle.SetValueWithoutNotify(GridPaintingState.drawGizmos);
  88. gizmoToggle.ToggleChanged += OnGizmoToggleChanged;
  89. RegisterCallback<AttachToPanelEvent>(OnAttachedToPanel);
  90. RegisterCallback<DetachFromPanelEvent>(OnDetachedToPanel);
  91. }
  92. private void OnAttachedToPanel(AttachToPanelEvent evt)
  93. {
  94. m_ClipboardElement.clipboardUnlockedChanged += OnUnlockedChanged;
  95. }
  96. private void OnDetachedToPanel(DetachFromPanelEvent evt)
  97. {
  98. m_ClipboardElement.clipboardUnlockedChanged -= OnUnlockedChanged;
  99. }
  100. private static void SetupChildrenAsButtonStripForVisible(VisualElement root)
  101. {
  102. root.AddToClassList(buttonStripClassName);
  103. int count = root.hierarchy.childCount;
  104. if (count == 1)
  105. {
  106. var element = root.hierarchy.ElementAt(0);
  107. bool visible = element.style.display != DisplayStyle.None && element.visible;
  108. element.EnableInClassList(aloneStripElementClassName, visible);
  109. }
  110. else
  111. {
  112. bool firstVisible = false;
  113. int lastVisible = 0;
  114. for (var i = 0; i < count; ++i)
  115. {
  116. var element = root.hierarchy.ElementAt(i);
  117. //Skip if element not visible
  118. bool visible = element.style.display != DisplayStyle.None && element.visible;
  119. element.AddToClassList(stripElementClassName);
  120. if (firstVisible)
  121. {
  122. element.EnableInClassList(middleStripElementClassName, visible);
  123. }
  124. if (!firstVisible)
  125. {
  126. element.EnableInClassList(leftStripElementClassName, visible);
  127. firstVisible = true;
  128. }
  129. if (visible)
  130. lastVisible = i;
  131. }
  132. var lastElement = root.hierarchy.ElementAt(lastVisible);
  133. if (lastElement.ClassListContains(leftStripElementClassName))
  134. {
  135. lastElement.RemoveFromClassList(leftStripElementClassName);
  136. lastElement.AddToClassList(aloneStripElementClassName);
  137. }
  138. else
  139. {
  140. lastElement.RemoveFromClassList(middleStripElementClassName);
  141. lastElement.AddToClassList(rightStripElementClassName);
  142. }
  143. }
  144. }
  145. private void OnEditToggleChanged(bool unlock)
  146. {
  147. clipboardUnlocked = unlock;
  148. }
  149. private void OnUnlockedChanged(bool unlock)
  150. {
  151. m_EditToggle.SetValueWithoutNotify(unlock);
  152. }
  153. private void OnGridToggleChanged(bool drawGridGizmo)
  154. {
  155. GridPaintingState.drawGridGizmo = drawGridGizmo;
  156. }
  157. private void OnGizmoToggleChanged(bool drawGizmo)
  158. {
  159. GridPaintingState.drawGizmos = drawGizmo;
  160. }
  161. }
  162. [EditorToolbarElement(k_ToolbarId)]
  163. internal sealed class TilePaletteEditToggle : EditorToolbarToggle
  164. {
  165. internal const string k_ToolbarId = "Tile Palette/Tile Palette Edit";
  166. private static readonly string k_ToolSettingsClass = "unity-tool-settings";
  167. private static readonly string k_ElementClass = "unity-tilepalette-element-tilepaletteedit";
  168. private static readonly string k_IconPath = "Packages/com.unity.2d.tilemap/Editor/Icons/Tilemap.EditPalette.png";
  169. private static readonly string k_TooltipText = L10n.Tr("Toggles Tile Palette Edit");
  170. public Action<bool> ToggleChanged;
  171. public TilePaletteEditToggle()
  172. {
  173. name = "Tile Palette Edit";
  174. AddToClassList(k_ToolSettingsClass);
  175. AddToClassList(k_ElementClass);
  176. TilePaletteOverlayUtility.SetStyleSheet(this);
  177. icon = EditorGUIUtility.LoadIcon(k_IconPath);
  178. tooltip = k_TooltipText;
  179. }
  180. protected override void ToggleValue()
  181. {
  182. base.ToggleValue();
  183. ToggleChanged?.Invoke(value);
  184. }
  185. }
  186. [EditorToolbarElement(k_ToolbarId)]
  187. internal sealed class TilePaletteGridToggle : EditorToolbarToggle
  188. {
  189. internal const string k_ToolbarId = "Tile Palette/Tile Palette Grid";
  190. private static readonly string k_ToolSettingsClass = "unity-tool-settings";
  191. private static readonly string k_ElementClass = "unity-tilepalette-element-gridtoggle";
  192. private static readonly string k_IconPath = "Packages/com.unity.2d.tilemap/Editor/Icons/Tilemap.ShowGrid.png";
  193. private static readonly string k_TooltipText = L10n.Tr("Toggle visibility of the Grid in the Tile Palette");
  194. public Action<bool> ToggleChanged;
  195. public TilePaletteGridToggle()
  196. {
  197. name = "Tile Palette Grid";
  198. AddToClassList(k_ToolSettingsClass);
  199. AddToClassList(k_ElementClass);
  200. TilePaletteOverlayUtility.SetStyleSheet(this);
  201. icon = EditorGUIUtility.LoadIcon(k_IconPath);
  202. tooltip = k_TooltipText;
  203. }
  204. protected override void ToggleValue()
  205. {
  206. base.ToggleValue();
  207. ToggleChanged?.Invoke(value);
  208. }
  209. }
  210. [EditorToolbarElement(k_ToolbarId)]
  211. internal sealed class TilePaletteBrushElementToggle : EditorToolbarToggle
  212. {
  213. internal const string k_ToolbarId = "Tile Palette/Tile Palette Brush Element";
  214. private static readonly string k_ToolSettingsClass = "unity-tool-settings";
  215. private static readonly string k_ElementClass = "unity-tilepalette-element-brushelement";
  216. private static readonly string k_IconPath = "Packages/com.unity.2d.tilemap/Editor/Icons/Tilemap.BrushSettings.png";
  217. private static readonly string k_TooltipText = L10n.Tr("Toggle visibility of the Brush Inspector in the Tile Palette");
  218. public Action<bool> ToggleChanged;
  219. public TilePaletteBrushElementToggle()
  220. {
  221. name = "Tile Palette Grid";
  222. AddToClassList(k_ToolSettingsClass);
  223. AddToClassList(k_ElementClass);
  224. TilePaletteOverlayUtility.SetStyleSheet(this);
  225. icon = EditorGUIUtility.LoadIcon(k_IconPath);
  226. tooltip = k_TooltipText;
  227. }
  228. protected override void ToggleValue()
  229. {
  230. base.ToggleValue();
  231. ToggleChanged?.Invoke(value);
  232. }
  233. }
  234. [EditorToolbarElement(k_ToolbarId)]
  235. internal sealed class TilePaletteGizmoToggle : EditorToolbarToggle
  236. {
  237. internal const string k_ToolbarId = "Tile Palette/Tile Palette Gizmo";
  238. private static readonly string k_ToolSettingsClass = "unity-tool-settings";
  239. private static readonly string k_ElementClass = "unity-tilepalette-element-gizmotoggle";
  240. private static readonly string k_IconPath = "GizmosToggle";
  241. private static readonly string k_TooltipText = L10n.Tr("Toggle visibility of Gizmos in the Tile Palette");
  242. public Action<bool> ToggleChanged;
  243. public TilePaletteGizmoToggle()
  244. {
  245. name = "Tile Palette Gizmo";
  246. AddToClassList(k_ToolSettingsClass);
  247. AddToClassList(k_ElementClass);
  248. TilePaletteOverlayUtility.SetStyleSheet(this);
  249. icon = EditorGUIUtility.LoadIcon(k_IconPath);
  250. tooltip = k_TooltipText;
  251. }
  252. protected override void ToggleValue()
  253. {
  254. base.ToggleValue();
  255. ToggleChanged?.Invoke(value);
  256. }
  257. }
  258. [EditorToolbarElement(k_ToolbarId)]
  259. internal sealed class TilePaletteHideClipboardToggle : EditorToolbarToggle
  260. {
  261. internal const string k_ToolbarId = "Tile Palette/Tile Palette Hide Clipboard";
  262. private static readonly string k_ToolSettingsClass = "unity-tool-settings";
  263. private static readonly string k_ElementClass = "unity-tilepalette-element-hideclipboard";
  264. private static readonly string k_IconPath = "Packages/com.unity.2d.tilemap/Editor/Icons/Tilemap.ShowTilePalette.png";
  265. private static readonly string k_TooltipFormatText = L10n.Tr("Hides Tile Palette on Pick. ( {0} ) to show/hide Tile Palette.");
  266. private static readonly string k_ShortcutId = "Grid Painting/Toggle SceneView Palette";
  267. public Action<bool> ToggleChanged;
  268. public TilePaletteHideClipboardToggle()
  269. {
  270. name = "Tile Palette Hide Clipboard";
  271. AddToClassList(k_ToolSettingsClass);
  272. AddToClassList(k_ElementClass);
  273. TilePaletteOverlayUtility.SetStyleSheet(this);
  274. icon = EditorGUIUtility.LoadIcon(k_IconPath);
  275. RegisterCallback<AttachToPanelEvent>(OnAttachedToPanel);
  276. RegisterCallback<DetachFromPanelEvent>(OnDetachFromPanel);
  277. }
  278. private void OnAttachedToPanel(AttachToPanelEvent evt)
  279. {
  280. ShortcutIntegration.instance.profileManager.shortcutBindingChanged += OnShortcutBindingChanged;
  281. UpdateTooltip();
  282. }
  283. private void OnDetachFromPanel(DetachFromPanelEvent evt)
  284. {
  285. ShortcutIntegration.instance.profileManager.shortcutBindingChanged -= OnShortcutBindingChanged;
  286. }
  287. private void OnShortcutBindingChanged(IShortcutProfileManager arg1, Identifier arg2, ShortcutBinding arg3, ShortcutBinding arg4)
  288. {
  289. UpdateTooltip();
  290. }
  291. private void UpdateTooltip()
  292. {
  293. tooltip = String.Format(k_TooltipFormatText, ShortcutManager.instance.GetShortcutBinding(k_ShortcutId));
  294. }
  295. protected override void ToggleValue()
  296. {
  297. base.ToggleValue();
  298. ToggleChanged?.Invoke(value);
  299. }
  300. }
  301. }