TimelineContextMenu.cs 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using UnityEngine;
  5. using UnityEngine.Playables;
  6. using UnityEngine.Timeline;
  7. using Object = UnityEngine.Object;
  8. namespace UnityEditor.Timeline
  9. {
  10. static class SequencerContextMenu
  11. {
  12. static readonly TimelineAction[] MarkerHeaderCommonOperations =
  13. {
  14. new PasteAction()
  15. };
  16. public static readonly TimelineAction[] MarkerHeaderMenuItems =
  17. TimelineAction.AllActions.OfType<MarkerHeaderAction>().
  18. Where(a => a.showInMenu).
  19. Union(MarkerHeaderCommonOperations).
  20. ToArray();
  21. static class Styles
  22. {
  23. public static readonly string addItemFromAssetTemplate = L10n.Tr("Add {0} From {1}");
  24. public static readonly string addSingleItemFromAssetTemplate = L10n.Tr("Add From {1}");
  25. public static readonly string addItemTemplate = L10n.Tr("Add {0}");
  26. public static readonly string typeSelectorTemplate = L10n.Tr("Select {0}");
  27. public static readonly string trackGroup = L10n.Tr("Track Group");
  28. public static readonly string trackSubGroup = L10n.Tr("Track Sub-Group");
  29. public static readonly string addTrackLayer = L10n.Tr("Add Layer");
  30. public static readonly string layerName = L10n.Tr("Layer {0}");
  31. }
  32. public static void ShowMarkerHeaderContextMenu(Vector2? mousePosition, WindowState state)
  33. {
  34. var menu = new GenericMenu();
  35. List<MenuActionItem> items = new List<MenuActionItem>(100);
  36. BuildMarkerHeaderContextMenu(items, mousePosition, state);
  37. MenuItemActionBase.BuildMenu(menu, items);
  38. menu.ShowAsContext();
  39. }
  40. public static void ShowNewTracksContextMenu(ICollection<TrackAsset> tracks, WindowState state)
  41. {
  42. var menu = new GenericMenu();
  43. List<MenuActionItem> items = new List<MenuActionItem>(100);
  44. BuildNewTracksContextMenu(items, tracks, state);
  45. MenuItemActionBase.BuildMenu(menu, items);
  46. menu.ShowAsContext();
  47. }
  48. public static void ShowNewTracksContextMenu(ICollection<TrackAsset> tracks, WindowState state, Rect rect)
  49. {
  50. var menu = new GenericMenu();
  51. List<MenuActionItem> items = new List<MenuActionItem>(100);
  52. BuildNewTracksContextMenu(items, tracks, state);
  53. MenuItemActionBase.BuildMenu(menu, items);
  54. menu.DropDown(rect);
  55. }
  56. public static void ShowTrackContextMenu(TrackAsset[] tracks, Vector2? mousePosition)
  57. {
  58. if (tracks == null || tracks.Length == 0)
  59. return;
  60. var items = new List<MenuActionItem>();
  61. var menu = new GenericMenu();
  62. BuildTrackContextMenu(items, tracks, mousePosition);
  63. MenuItemActionBase.BuildMenu(menu, items);
  64. menu.ShowAsContext();
  65. }
  66. public static void ShowItemContextMenu(Vector2 mousePosition, TimelineClip[] clips, IMarker[] markers)
  67. {
  68. var menu = new GenericMenu();
  69. var items = new List<MenuActionItem>();
  70. BuildItemContextMenu(items, mousePosition, clips, markers);
  71. MenuItemActionBase.BuildMenu(menu, items);
  72. menu.ShowAsContext();
  73. }
  74. internal static void BuildItemContextMenu(List<MenuActionItem> items, Vector2 mousePosition, TimelineClip[] clips, IMarker[] markers)
  75. {
  76. var state = TimelineWindow.instance.state;
  77. TimelineAction.GetMenuEntries(TimelineAction.MenuActions, mousePosition, items);
  78. ItemAction<TimelineClip>.GetMenuEntries(clips, items);
  79. ItemAction<IMarker>.GetMenuEntries(markers, items);
  80. if (clips.Length > 0)
  81. AddMarkerMenuCommands(items, clips.Select(c => c.parentTrack).Distinct().ToList(), TimelineHelpers.GetCandidateTime(state, mousePosition));
  82. }
  83. internal static void BuildNewTracksContextMenu(List<MenuActionItem> menuItems, ICollection<TrackAsset> parentTracks, WindowState state, string format = null)
  84. {
  85. if (parentTracks == null)
  86. parentTracks = new TrackAsset[0];
  87. if (string.IsNullOrEmpty(format))
  88. format = "{0}";
  89. // Add Group or SubGroup
  90. var title = string.Format(format, parentTracks.Any(t => t != null) ? Styles.trackSubGroup : Styles.trackGroup);
  91. var menuState = MenuActionDisplayState.Visible;
  92. if (state.editSequence.isReadOnly)
  93. menuState = MenuActionDisplayState.Disabled;
  94. if (parentTracks.Any() && parentTracks.Any(t => t != null && t.lockedInHierarchy))
  95. menuState = MenuActionDisplayState.Disabled;
  96. GenericMenu.MenuFunction command = () =>
  97. {
  98. SelectionManager.Clear();
  99. if (parentTracks.Count == 0)
  100. Selection.Add(TimelineHelpers.CreateTrack<GroupTrack>(null, title));
  101. foreach (var parentTrack in parentTracks)
  102. Selection.Add(TimelineHelpers.CreateTrack<GroupTrack>(parentTrack, title));
  103. TimelineEditor.Refresh(RefreshReason.ContentsAddedOrRemoved);
  104. };
  105. menuItems.Add(
  106. new MenuActionItem()
  107. {
  108. category = string.Empty,
  109. entryName = title,
  110. shortCut = string.Empty,
  111. isActiveInMode = true,
  112. isChecked = false,
  113. priority = MenuOrder.AddGroupItemStart,
  114. state = menuState,
  115. callback = command
  116. }
  117. );
  118. var allTypes = TypeUtility.AllTrackTypes().Where(x => x != typeof(GroupTrack) && !TypeUtility.IsHiddenInMenu(x)).ToList();
  119. int builtInPriority = MenuOrder.AddTrackItemStart;
  120. int customPriority = MenuOrder.AddCustomTrackItemStart;
  121. foreach (var trackType in allTypes)
  122. {
  123. var trackItemType = trackType;
  124. command = () =>
  125. {
  126. SelectionManager.Clear();
  127. if (parentTracks.Count == 0)
  128. SelectionManager.Add(TimelineHelpers.CreateTrack((Type)trackItemType, null));
  129. foreach (var parentTrack in parentTracks)
  130. SelectionManager.Add(TimelineHelpers.CreateTrack((Type)trackItemType, parentTrack));
  131. };
  132. menuItems.Add(
  133. new MenuActionItem()
  134. {
  135. category = TimelineHelpers.GetTrackCategoryName(trackType),
  136. entryName = string.Format(format, TimelineHelpers.GetTrackMenuName(trackItemType)),
  137. shortCut = string.Empty,
  138. isActiveInMode = true,
  139. isChecked = false,
  140. priority = TypeUtility.IsBuiltIn(trackType) ? builtInPriority++ : customPriority++,
  141. state = menuState,
  142. callback = command
  143. }
  144. );
  145. }
  146. }
  147. internal static void BuildMarkerHeaderContextMenu(List<MenuActionItem> menu, Vector2? mousePosition, WindowState state)
  148. {
  149. TimelineAction.GetMenuEntries(MarkerHeaderMenuItems, null, menu);
  150. var timeline = state.editSequence.asset;
  151. var time = TimelineHelpers.GetCandidateTime(state, mousePosition);
  152. var enabled = timeline.markerTrack == null || !timeline.markerTrack.lockedInHierarchy;
  153. var addMarkerCommand = new Action<Type, Object>
  154. (
  155. (type, obj) => AddSingleMarkerCallback(type, time, timeline, state.editSequence.director, obj)
  156. );
  157. AddMarkerMenuCommands(menu, new TrackAsset[] {timeline.markerTrack}, addMarkerCommand, enabled);
  158. }
  159. internal static void BuildTrackContextMenu(List<MenuActionItem> items, TrackAsset[] tracks, Vector2? mousePosition)
  160. {
  161. if (tracks == null || tracks.Length == 0)
  162. return;
  163. TimelineAction.GetMenuEntries(TimelineAction.MenuActions, mousePosition, items);
  164. TrackAction.GetMenuEntries(TimelineWindow.instance.state, mousePosition, tracks, items);
  165. AddLayeredTrackCommands(items, tracks);
  166. var first = tracks.First().GetType();
  167. var allTheSame = tracks.All(t => t.GetType() == first);
  168. if (allTheSame)
  169. {
  170. if (first != typeof(GroupTrack))
  171. {
  172. var candidateTime = TimelineHelpers.GetCandidateTime(TimelineWindow.instance.state, mousePosition, tracks);
  173. AddClipMenuCommands(items, tracks, candidateTime);
  174. AddMarkerMenuCommands(items, tracks, candidateTime);
  175. }
  176. else
  177. {
  178. BuildNewTracksContextMenu(items, tracks, TimelineWindow.instance.state, Styles.addItemTemplate);
  179. }
  180. }
  181. }
  182. static void AddLayeredTrackCommands(List<MenuActionItem> menuItems, ICollection<TrackAsset> tracks)
  183. {
  184. if (tracks.Count == 0)
  185. return;
  186. var layeredType = tracks.First().GetType();
  187. // animation tracks have a special menu.
  188. if (layeredType == typeof(AnimationTrack))
  189. return;
  190. // must implement ILayerable
  191. if (!typeof(UnityEngine.Timeline.ILayerable).IsAssignableFrom(layeredType))
  192. return;
  193. if (tracks.Any(t => t.GetType() != layeredType))
  194. return;
  195. // only supported on the master track no nesting.
  196. if (tracks.Any(t => t.isSubTrack))
  197. return;
  198. var enabled = tracks.All(t => t != null && !t.lockedInHierarchy) && !TimelineWindow.instance.state.editSequence.isReadOnly;
  199. int priority = MenuOrder.TrackAddMenu.AddLayerTrack;
  200. GenericMenu.MenuFunction menuCallback = () =>
  201. {
  202. foreach (var track in tracks)
  203. TimelineHelpers.CreateTrack(layeredType, track, string.Format(Styles.layerName, track.GetChildTracks().Count() + 1));
  204. };
  205. var entryName = Styles.addTrackLayer;
  206. menuItems.Add(
  207. new MenuActionItem()
  208. {
  209. category = string.Empty,
  210. entryName = entryName,
  211. shortCut = string.Empty,
  212. isActiveInMode = true,
  213. isChecked = false,
  214. priority = priority++,
  215. state = enabled ? MenuActionDisplayState.Visible : MenuActionDisplayState.Disabled,
  216. callback = menuCallback
  217. }
  218. );
  219. }
  220. static void AddClipMenuCommands(List<MenuActionItem> menuItems, ICollection<TrackAsset> tracks, double candidateTime)
  221. {
  222. if (!tracks.Any())
  223. return;
  224. var trackAsset = tracks.First();
  225. var trackType = trackAsset.GetType();
  226. if (tracks.Any(t => t.GetType() != trackType))
  227. return;
  228. var enabled = tracks.All(t => t != null && !t.lockedInHierarchy) && !TimelineWindow.instance.state.editSequence.isReadOnly;
  229. var assetTypes = TypeUtility.GetPlayableAssetsHandledByTrack(trackType);
  230. var visibleAssetTypes = TypeUtility.GetVisiblePlayableAssetsHandledByTrack(trackType);
  231. // skips the name if there is only a single type
  232. var commandNameTemplate = assetTypes.Count() == 1 ? Styles.addSingleItemFromAssetTemplate : Styles.addItemFromAssetTemplate;
  233. int builtInPriority = MenuOrder.AddClipItemStart;
  234. int customPriority = MenuOrder.AddCustomClipItemStart;
  235. foreach (var assetType in assetTypes)
  236. {
  237. var assetItemType = assetType;
  238. var category = TimelineHelpers.GetItemCategoryName(assetType);
  239. Action<Object> onObjectChanged = obj =>
  240. {
  241. if (obj != null)
  242. {
  243. foreach (var t in tracks)
  244. {
  245. TimelineHelpers.CreateClipOnTrack(assetItemType, obj, t, candidateTime);
  246. }
  247. }
  248. };
  249. foreach (var objectReference in TypeUtility.ObjectReferencesForType(assetType))
  250. {
  251. var isSceneReference = objectReference.isSceneReference;
  252. var dataType = objectReference.type;
  253. GenericMenu.MenuFunction menuCallback = () =>
  254. {
  255. ObjectSelector.get.Show(null, dataType, null, isSceneReference, null, (obj) => onObjectChanged(obj), null);
  256. ObjectSelector.get.titleContent = EditorGUIUtility.TrTextContent(string.Format(Styles.typeSelectorTemplate, TypeUtility.GetDisplayName(dataType)));
  257. };
  258. menuItems.Add(
  259. new MenuActionItem()
  260. {
  261. category = category,
  262. entryName = string.Format(commandNameTemplate, TypeUtility.GetDisplayName(assetType), TypeUtility.GetDisplayName(objectReference.type)),
  263. shortCut = string.Empty,
  264. isActiveInMode = true,
  265. isChecked = false,
  266. priority = TypeUtility.IsBuiltIn(assetType) ? builtInPriority++ : customPriority++,
  267. state = enabled ? MenuActionDisplayState.Visible : MenuActionDisplayState.Disabled,
  268. callback = menuCallback
  269. }
  270. );
  271. }
  272. }
  273. foreach (var assetType in visibleAssetTypes)
  274. {
  275. var assetItemType = assetType;
  276. var category = TimelineHelpers.GetItemCategoryName(assetType);
  277. var commandName = string.Format(Styles.addItemTemplate, TypeUtility.GetDisplayName(assetType));
  278. GenericMenu.MenuFunction command = () =>
  279. {
  280. foreach (var t in tracks)
  281. {
  282. TimelineHelpers.CreateClipOnTrack(assetItemType, t, candidateTime);
  283. }
  284. };
  285. menuItems.Add(
  286. new MenuActionItem()
  287. {
  288. category = category,
  289. entryName = commandName,
  290. shortCut = string.Empty,
  291. isActiveInMode = true,
  292. isChecked = false,
  293. priority = TypeUtility.IsBuiltIn(assetItemType) ? builtInPriority++ : customPriority++,
  294. state = enabled ? MenuActionDisplayState.Visible : MenuActionDisplayState.Disabled,
  295. callback = command
  296. }
  297. );
  298. }
  299. }
  300. static void AddMarkerMenuCommands(List<MenuActionItem> menu, IEnumerable<Type> markerTypes, Action<Type, Object> addMarkerCommand, bool enabled)
  301. {
  302. int builtInPriority = MenuOrder.AddMarkerItemStart;
  303. int customPriority = MenuOrder.AddCustomMarkerItemStart;
  304. foreach (var markerType in markerTypes)
  305. {
  306. var markerItemType = markerType;
  307. string category = TimelineHelpers.GetItemCategoryName(markerItemType);
  308. menu.Add(
  309. new MenuActionItem()
  310. {
  311. category = category,
  312. entryName = string.Format(Styles.addItemTemplate, TypeUtility.GetDisplayName(markerType)),
  313. shortCut = string.Empty,
  314. isActiveInMode = true,
  315. isChecked = false,
  316. priority = TypeUtility.IsBuiltIn(markerType) ? builtInPriority++ : customPriority++,
  317. state = enabled ? MenuActionDisplayState.Visible : MenuActionDisplayState.Disabled,
  318. callback = () => addMarkerCommand(markerItemType, null)
  319. }
  320. );
  321. foreach (var objectReference in TypeUtility.ObjectReferencesForType(markerType))
  322. {
  323. var isSceneReference = objectReference.isSceneReference;
  324. GenericMenu.MenuFunction menuCallback = () =>
  325. {
  326. var dataType = markerItemType;
  327. ObjectSelector.get.Show(null, dataType, null, isSceneReference, null, (obj) => addMarkerCommand(markerItemType, obj), null);
  328. ObjectSelector.get.titleContent = EditorGUIUtility.TrTextContent(string.Format(Styles.typeSelectorTemplate, TypeUtility.GetDisplayName(dataType)));
  329. };
  330. menu.Add(
  331. new MenuActionItem()
  332. {
  333. category = TimelineHelpers.GetItemCategoryName(markerItemType),
  334. entryName = string.Format(Styles.addItemFromAssetTemplate, TypeUtility.GetDisplayName(markerType), TypeUtility.GetDisplayName(objectReference.type)),
  335. shortCut = string.Empty,
  336. isActiveInMode = true,
  337. isChecked = false,
  338. priority = TypeUtility.IsBuiltIn(markerType) ? builtInPriority++ : customPriority++,
  339. state = enabled ? MenuActionDisplayState.Visible : MenuActionDisplayState.Disabled,
  340. callback = menuCallback
  341. }
  342. );
  343. }
  344. }
  345. }
  346. static void AddMarkerMenuCommands(List<MenuActionItem> menuItems, ICollection<TrackAsset> tracks, double candidateTime)
  347. {
  348. if (tracks.Count == 0)
  349. return;
  350. var enabled = tracks.All(t => !t.lockedInHierarchy) && !TimelineWindow.instance.state.editSequence.isReadOnly;
  351. var addMarkerCommand = new Action<Type, Object>((type, obj) => AddMarkersCallback(tracks, type, candidateTime, obj));
  352. AddMarkerMenuCommands(menuItems, tracks, addMarkerCommand, enabled);
  353. }
  354. static void AddMarkerMenuCommands(List<MenuActionItem> menuItems, ICollection<TrackAsset> tracks, Action<Type, Object> command, bool enabled)
  355. {
  356. var markerTypes = TypeUtility.GetBuiltInMarkerTypes().Union(TypeUtility.GetUserMarkerTypes());
  357. if (tracks != null)
  358. markerTypes = markerTypes.Where(x => tracks.All(track => (track == null) || TypeUtility.DoesTrackSupportMarkerType(track, x))); // null track indicates marker track to be created
  359. AddMarkerMenuCommands(menuItems, markerTypes, command, enabled);
  360. }
  361. static void AddMarkersCallback(ICollection<TrackAsset> targets, Type markerType, double time, Object obj)
  362. {
  363. SelectionManager.Clear();
  364. foreach (var target in targets)
  365. {
  366. var marker = TimelineHelpers.CreateMarkerOnTrack(markerType, obj, target, time);
  367. SelectionManager.Add(marker);
  368. }
  369. TimelineEditor.Refresh(RefreshReason.ContentsAddedOrRemoved);
  370. }
  371. static void AddSingleMarkerCallback(Type markerType, double time, TimelineAsset timeline, PlayableDirector director, Object assignableObject)
  372. {
  373. timeline.CreateMarkerTrack();
  374. var markerTrack = timeline.markerTrack;
  375. SelectionManager.Clear();
  376. var marker = TimelineHelpers.CreateMarkerOnTrack(markerType, assignableObject, markerTrack, time);
  377. SelectionManager.Add(marker);
  378. if (typeof(INotification).IsAssignableFrom(markerType) && director != null)
  379. {
  380. if (director != null && director.GetGenericBinding(markerTrack) == null)
  381. director.SetGenericBinding(markerTrack, director.gameObject);
  382. }
  383. TimelineEditor.Refresh(RefreshReason.ContentsAddedOrRemoved);
  384. }
  385. }
  386. }