BaseGraph.cs 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  1. using System.Collections;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using UnityEngine;
  5. using System;
  6. using UnityEngine.Serialization;
  7. using UnityEngine.SceneManagement;
  8. namespace GraphProcessor
  9. {
  10. public class GraphChanges
  11. {
  12. public SerializableEdge removedEdge;
  13. public SerializableEdge addedEdge;
  14. public BaseNode removedNode;
  15. public BaseNode addedNode;
  16. public BaseNode nodeChanged;
  17. public Group addedGroups;
  18. public Group removedGroups;
  19. public BaseStackNode addedStackNode;
  20. public BaseStackNode removedStackNode;
  21. public StickyNote addedStickyNotes;
  22. public StickyNote removedStickyNotes;
  23. }
  24. /// <summary>
  25. /// Compute order type used to determine the compute order integer on the nodes
  26. /// </summary>
  27. public enum ComputeOrderType
  28. {
  29. DepthFirst,
  30. BreadthFirst,
  31. }
  32. [System.Serializable]
  33. public class BaseGraph : ScriptableObject, ISerializationCallbackReceiver
  34. {
  35. static readonly int maxComputeOrderDepth = 1000;
  36. /// <summary>Invalid compute order number of a node when it's inside a loop</summary>
  37. public static readonly int loopComputeOrder = -2;
  38. /// <summary>Invalid compute order number of a node can't process</summary>
  39. public static readonly int invalidComputeOrder = -1;
  40. /// <summary>
  41. /// Json list of serialized nodes only used for copy pasting in the editor. Note that this field isn't serialized
  42. /// </summary>
  43. /// <typeparam name="JsonElement"></typeparam>
  44. /// <returns></returns>
  45. [SerializeField, Obsolete("Use BaseGraph.nodes instead")]
  46. public List< JsonElement > serializedNodes = new List< JsonElement >();
  47. /// <summary>
  48. /// List of all the nodes in the graph.
  49. /// </summary>
  50. /// <typeparam name="BaseNode"></typeparam>
  51. /// <returns></returns>
  52. [SerializeReference]
  53. public List< BaseNode > nodes = new List< BaseNode >();
  54. /// <summary>
  55. /// Dictionary to access node per GUID, faster than a search in a list
  56. /// </summary>
  57. /// <typeparam name="string"></typeparam>
  58. /// <typeparam name="BaseNode"></typeparam>
  59. /// <returns></returns>
  60. [System.NonSerialized]
  61. public Dictionary< string, BaseNode > nodesPerGUID = new Dictionary< string, BaseNode >();
  62. /// <summary>
  63. /// Json list of edges
  64. /// </summary>
  65. /// <typeparam name="SerializableEdge"></typeparam>
  66. /// <returns></returns>
  67. [SerializeField]
  68. public List< SerializableEdge > edges = new List< SerializableEdge >();
  69. /// <summary>
  70. /// Dictionary of edges per GUID, faster than a search in a list
  71. /// </summary>
  72. /// <typeparam name="string"></typeparam>
  73. /// <typeparam name="SerializableEdge"></typeparam>
  74. /// <returns></returns>
  75. [System.NonSerialized]
  76. public Dictionary< string, SerializableEdge > edgesPerGUID = new Dictionary< string, SerializableEdge >();
  77. /// <summary>
  78. /// All groups in the graph
  79. /// </summary>
  80. /// <typeparam name="Group"></typeparam>
  81. /// <returns></returns>
  82. [SerializeField, FormerlySerializedAs("commentBlocks")]
  83. public List< Group > groups = new List< Group >();
  84. /// <summary>
  85. /// All Stack Nodes in the graph
  86. /// </summary>
  87. /// <typeparam name="stackNodes"></typeparam>
  88. /// <returns></returns>
  89. [SerializeField, SerializeReference] // Polymorphic serialization
  90. public List< BaseStackNode > stackNodes = new List< BaseStackNode >();
  91. /// <summary>
  92. /// All pinned elements in the graph
  93. /// </summary>
  94. /// <typeparam name="PinnedElement"></typeparam>
  95. /// <returns></returns>
  96. [SerializeField]
  97. public List< PinnedElement > pinnedElements = new List< PinnedElement >();
  98. /// <summary>
  99. /// All exposed parameters in the graph
  100. /// </summary>
  101. /// <typeparam name="ExposedParameter"></typeparam>
  102. /// <returns></returns>
  103. [SerializeField, SerializeReference]
  104. public List< ExposedParameter > exposedParameters = new List< ExposedParameter >();
  105. [SerializeField, FormerlySerializedAs("exposedParameters")] // We keep this for upgrade
  106. List< ExposedParameter > serializedParameterList = new List<ExposedParameter>();
  107. [SerializeField]
  108. public List< StickyNote > stickyNotes = new List<StickyNote>();
  109. [System.NonSerialized]
  110. Dictionary< BaseNode, int > computeOrderDictionary = new Dictionary< BaseNode, int >();
  111. [NonSerialized]
  112. Scene linkedScene;
  113. // Trick to keep the node inspector alive during the editor session
  114. [SerializeField]
  115. internal UnityEngine.Object nodeInspectorReference;
  116. //graph visual properties
  117. public Vector3 position = Vector3.zero;
  118. public Vector3 scale = Vector3.one;
  119. /// <summary>
  120. /// Triggered when something is changed in the list of exposed parameters
  121. /// </summary>
  122. public event Action onExposedParameterListChanged;
  123. public event Action< ExposedParameter > onExposedParameterModified;
  124. public event Action< ExposedParameter > onExposedParameterValueChanged;
  125. /// <summary>
  126. /// Triggered when the graph is linked to an active scene.
  127. /// </summary>
  128. public event Action< Scene > onSceneLinked;
  129. /// <summary>
  130. /// Triggered when the graph is enabled
  131. /// </summary>
  132. public event Action onEnabled;
  133. /// <summary>
  134. /// Triggered when the graph is changed
  135. /// </summary>
  136. public event Action< GraphChanges > onGraphChanges;
  137. [System.NonSerialized]
  138. bool _isEnabled = false;
  139. public bool isEnabled { get => _isEnabled; private set => _isEnabled = value; }
  140. public HashSet< BaseNode > graphOutputs { get; private set; } = new HashSet<BaseNode>();
  141. protected virtual void OnEnable()
  142. {
  143. if (isEnabled)
  144. OnDisable();
  145. MigrateGraphIfNeeded();
  146. InitializeGraphElements();
  147. DestroyBrokenGraphElements();
  148. UpdateComputeOrder();
  149. isEnabled = true;
  150. onEnabled?.Invoke();
  151. }
  152. void InitializeGraphElements()
  153. {
  154. // Sanitize the element lists (it's possible that nodes are null if their full class name have changed)
  155. // If you rename / change the assembly of a node or parameter, please use the MovedFrom() attribute to avoid breaking the graph.
  156. nodes.RemoveAll(n => n == null);
  157. exposedParameters.RemoveAll(e => e == null);
  158. foreach (var node in nodes.ToList())
  159. {
  160. nodesPerGUID[node.GUID] = node;
  161. node.Initialize(this);
  162. }
  163. foreach (var edge in edges.ToList())
  164. {
  165. edge.Deserialize();
  166. edgesPerGUID[edge.GUID] = edge;
  167. // Sanity check for the edge:
  168. if (edge.inputPort == null || edge.outputPort == null)
  169. {
  170. Disconnect(edge.GUID);
  171. continue;
  172. }
  173. // Add the edge to the non-serialized port data
  174. edge.inputPort.owner.OnEdgeConnected(edge);
  175. edge.outputPort.owner.OnEdgeConnected(edge);
  176. }
  177. }
  178. protected virtual void OnDisable()
  179. {
  180. isEnabled = false;
  181. foreach (var node in nodes)
  182. node.DisableInternal();
  183. }
  184. public virtual void OnAssetDeleted() {}
  185. /// <summary>
  186. /// Adds a node to the graph
  187. /// </summary>
  188. /// <param name="node"></param>
  189. /// <returns></returns>
  190. public BaseNode AddNode(BaseNode node)
  191. {
  192. nodesPerGUID[node.GUID] = node;
  193. nodes.Add(node);
  194. node.Initialize(this);
  195. onGraphChanges?.Invoke(new GraphChanges{ addedNode = node });
  196. return node;
  197. }
  198. /// <summary>
  199. /// Removes a node from the graph
  200. /// </summary>
  201. /// <param name="node"></param>
  202. public void RemoveNode(BaseNode node)
  203. {
  204. node.DisableInternal();
  205. node.DestroyInternal();
  206. nodesPerGUID.Remove(node.GUID);
  207. nodes.Remove(node);
  208. onGraphChanges?.Invoke(new GraphChanges{ removedNode = node });
  209. }
  210. /// <summary>
  211. /// Connect two ports with an edge
  212. /// </summary>
  213. /// <param name="inputPort">input port</param>
  214. /// <param name="outputPort">output port</param>
  215. /// <param name="DisconnectInputs">is the edge allowed to disconnect another edge</param>
  216. /// <returns>the connecting edge</returns>
  217. public SerializableEdge Connect(NodePort inputPort, NodePort outputPort, bool autoDisconnectInputs = true)
  218. {
  219. var edge = SerializableEdge.CreateNewEdge(this, inputPort, outputPort);
  220. //If the input port does not support multi-connection, we remove them
  221. if (autoDisconnectInputs && !inputPort.portData.acceptMultipleEdges)
  222. {
  223. foreach (var e in inputPort.GetEdges().ToList())
  224. {
  225. // TODO: do not disconnect them if the connected port is the same than the old connected
  226. Disconnect(e);
  227. }
  228. }
  229. // same for the output port:
  230. if (autoDisconnectInputs && !outputPort.portData.acceptMultipleEdges)
  231. {
  232. foreach (var e in outputPort.GetEdges().ToList())
  233. {
  234. // TODO: do not disconnect them if the connected port is the same than the old connected
  235. Disconnect(e);
  236. }
  237. }
  238. edges.Add(edge);
  239. // Add the edge to the list of connected edges in the nodes
  240. inputPort.owner.OnEdgeConnected(edge);
  241. outputPort.owner.OnEdgeConnected(edge);
  242. onGraphChanges?.Invoke(new GraphChanges{ addedEdge = edge });
  243. return edge;
  244. }
  245. /// <summary>
  246. /// Disconnect two ports
  247. /// </summary>
  248. /// <param name="inputNode">input node</param>
  249. /// <param name="inputFieldName">input field name</param>
  250. /// <param name="outputNode">output node</param>
  251. /// <param name="outputFieldName">output field name</param>
  252. public void Disconnect(BaseNode inputNode, string inputFieldName, BaseNode outputNode, string outputFieldName)
  253. {
  254. edges.RemoveAll(r => {
  255. bool remove = r.inputNode == inputNode
  256. && r.outputNode == outputNode
  257. && r.outputFieldName == outputFieldName
  258. && r.inputFieldName == inputFieldName;
  259. if (remove)
  260. {
  261. r.inputNode?.OnEdgeDisconnected(r);
  262. r.outputNode?.OnEdgeDisconnected(r);
  263. onGraphChanges?.Invoke(new GraphChanges{ removedEdge = r });
  264. }
  265. return remove;
  266. });
  267. }
  268. /// <summary>
  269. /// Disconnect an edge
  270. /// </summary>
  271. /// <param name="edge"></param>
  272. public void Disconnect(SerializableEdge edge) => Disconnect(edge.GUID);
  273. /// <summary>
  274. /// Disconnect an edge
  275. /// </summary>
  276. /// <param name="edgeGUID"></param>
  277. public void Disconnect(string edgeGUID)
  278. {
  279. List<(BaseNode, SerializableEdge)> disconnectEvents = new List<(BaseNode, SerializableEdge)>();
  280. edges.RemoveAll(r => {
  281. if (r.GUID == edgeGUID)
  282. {
  283. disconnectEvents.Add((r.inputNode, r));
  284. disconnectEvents.Add((r.outputNode, r));
  285. onGraphChanges?.Invoke(new GraphChanges{ removedEdge = r });
  286. }
  287. return r.GUID == edgeGUID;
  288. });
  289. // Delay the edge disconnect event to avoid recursion
  290. foreach (var (node, edge) in disconnectEvents)
  291. node?.OnEdgeDisconnected(edge);
  292. }
  293. /// <summary>
  294. /// Add a group
  295. /// </summary>
  296. /// <param name="block"></param>
  297. public void AddGroup(Group block)
  298. {
  299. groups.Add(block);
  300. onGraphChanges?.Invoke(new GraphChanges{ addedGroups = block });
  301. }
  302. /// <summary>
  303. /// Removes a group
  304. /// </summary>
  305. /// <param name="block"></param>
  306. public void RemoveGroup(Group block)
  307. {
  308. groups.Remove(block);
  309. onGraphChanges?.Invoke(new GraphChanges{ removedGroups = block });
  310. }
  311. /// <summary>
  312. /// Add a StackNode
  313. /// </summary>
  314. /// <param name="stackNode"></param>
  315. public void AddStackNode(BaseStackNode stackNode)
  316. {
  317. stackNodes.Add(stackNode);
  318. onGraphChanges?.Invoke(new GraphChanges{ addedStackNode = stackNode });
  319. }
  320. /// <summary>
  321. /// Remove a StackNode
  322. /// </summary>
  323. /// <param name="stackNode"></param>
  324. public void RemoveStackNode(BaseStackNode stackNode)
  325. {
  326. stackNodes.Remove(stackNode);
  327. onGraphChanges?.Invoke(new GraphChanges{ removedStackNode = stackNode });
  328. }
  329. /// <summary>
  330. /// Add a sticky note
  331. /// </summary>
  332. /// <param name="note"></param>
  333. public void AddStickyNote(StickyNote note)
  334. {
  335. stickyNotes.Add(note);
  336. onGraphChanges?.Invoke(new GraphChanges{ addedStickyNotes = note });
  337. }
  338. /// <summary>
  339. /// Removes a sticky note
  340. /// </summary>
  341. /// <param name="note"></param>
  342. public void RemoveStickyNote(StickyNote note)
  343. {
  344. stickyNotes.Remove(note);
  345. onGraphChanges?.Invoke(new GraphChanges{ removedStickyNotes = note });
  346. }
  347. /// <summary>
  348. /// Invoke the onGraphChanges event, can be used as trigger to execute the graph when the content of a node is changed
  349. /// </summary>
  350. /// <param name="node"></param>
  351. public void NotifyNodeChanged(BaseNode node) => onGraphChanges?.Invoke(new GraphChanges { nodeChanged = node });
  352. /// <summary>
  353. /// Open a pinned element of type viewType
  354. /// </summary>
  355. /// <param name="viewType">type of the pinned element</param>
  356. /// <returns>the pinned element</returns>
  357. public PinnedElement OpenPinned(Type viewType)
  358. {
  359. var pinned = pinnedElements.Find(p => p.editorType.type == viewType);
  360. if (pinned == null)
  361. {
  362. pinned = new PinnedElement(viewType);
  363. pinnedElements.Add(pinned);
  364. }
  365. else
  366. pinned.opened = true;
  367. return pinned;
  368. }
  369. /// <summary>
  370. /// Closes a pinned element of type viewType
  371. /// </summary>
  372. /// <param name="viewType">type of the pinned element</param>
  373. public void ClosePinned(Type viewType)
  374. {
  375. var pinned = pinnedElements.Find(p => p.editorType.type == viewType);
  376. pinned.opened = false;
  377. }
  378. public void OnBeforeSerialize()
  379. {
  380. // Cleanup broken elements
  381. stackNodes.RemoveAll(s => s == null);
  382. nodes.RemoveAll(n => n == null);
  383. }
  384. // We can deserialize data here because it's called in a unity context
  385. // so we can load objects references
  386. public void Deserialize()
  387. {
  388. // Disable nodes correctly before removing them:
  389. if (nodes != null)
  390. {
  391. foreach (var node in nodes)
  392. node.DisableInternal();
  393. }
  394. MigrateGraphIfNeeded();
  395. InitializeGraphElements();
  396. }
  397. public void MigrateGraphIfNeeded()
  398. {
  399. #pragma warning disable CS0618
  400. // Migration step from JSON serialized nodes to [SerializeReference]
  401. if (serializedNodes.Count > 0)
  402. {
  403. nodes.Clear();
  404. foreach (var serializedNode in serializedNodes.ToList())
  405. {
  406. var node = JsonSerializer.DeserializeNode(serializedNode) as BaseNode;
  407. if (node != null)
  408. nodes.Add(node);
  409. }
  410. serializedNodes.Clear();
  411. // we also migrate parameters here:
  412. var paramsToMigrate = serializedParameterList.ToList();
  413. exposedParameters.Clear();
  414. foreach (var param in paramsToMigrate)
  415. {
  416. if (param == null)
  417. continue;
  418. var newParam = param.Migrate();
  419. if (newParam == null)
  420. {
  421. Debug.LogError($"Can't migrate parameter of type {param.type}, please create an Exposed Parameter class that implements this type.");
  422. continue;
  423. }
  424. else
  425. exposedParameters.Add(newParam);
  426. }
  427. }
  428. #pragma warning restore CS0618
  429. }
  430. public void OnAfterDeserialize() {}
  431. /// <summary>
  432. /// Update the compute order of the nodes in the graph
  433. /// </summary>
  434. /// <param name="type">Compute order type</param>
  435. public void UpdateComputeOrder(ComputeOrderType type = ComputeOrderType.DepthFirst)
  436. {
  437. if (nodes.Count == 0)
  438. return ;
  439. // Find graph outputs (end nodes) and reset compute order
  440. graphOutputs.Clear();
  441. foreach (var node in nodes)
  442. {
  443. if (node.GetOutputNodes().Count() == 0)
  444. graphOutputs.Add(node);
  445. node.computeOrder = 0;
  446. }
  447. computeOrderDictionary.Clear();
  448. infiniteLoopTracker.Clear();
  449. switch (type)
  450. {
  451. default:
  452. case ComputeOrderType.DepthFirst:
  453. UpdateComputeOrderDepthFirst();
  454. break;
  455. case ComputeOrderType.BreadthFirst:
  456. foreach (var node in nodes)
  457. UpdateComputeOrderBreadthFirst(0, node);
  458. break;
  459. }
  460. }
  461. /// <summary>
  462. /// Add an exposed parameter
  463. /// </summary>
  464. /// <param name="name">parameter name</param>
  465. /// <param name="type">parameter type (must be a subclass of ExposedParameter)</param>
  466. /// <param name="value">default value</param>
  467. /// <returns>The unique id of the parameter</returns>
  468. public string AddExposedParameter(string name, Type type, object value = null)
  469. {
  470. if (!type.IsSubclassOf(typeof(ExposedParameter)))
  471. {
  472. Debug.LogError($"Can't add parameter of type {type}, the type doesn't inherit from ExposedParameter.");
  473. }
  474. var param = Activator.CreateInstance(type) as ExposedParameter;
  475. // patch value with correct type:
  476. if (param.GetValueType().IsValueType)
  477. value = Activator.CreateInstance(param.GetValueType());
  478. param.Initialize(name, value);
  479. exposedParameters.Add(param);
  480. onExposedParameterListChanged?.Invoke();
  481. return param.guid;
  482. }
  483. /// <summary>
  484. /// Add an already allocated / initialized parameter to the graph
  485. /// </summary>
  486. /// <param name="parameter">The parameter to add</param>
  487. /// <returns>The unique id of the parameter</returns>
  488. public string AddExposedParameter(ExposedParameter parameter)
  489. {
  490. string guid = Guid.NewGuid().ToString(); // Generated once and unique per parameter
  491. parameter.guid = guid;
  492. exposedParameters.Add(parameter);
  493. onExposedParameterListChanged?.Invoke();
  494. return guid;
  495. }
  496. /// <summary>
  497. /// Remove an exposed parameter
  498. /// </summary>
  499. /// <param name="ep">the parameter to remove</param>
  500. public void RemoveExposedParameter(ExposedParameter ep)
  501. {
  502. exposedParameters.Remove(ep);
  503. onExposedParameterListChanged?.Invoke();
  504. }
  505. /// <summary>
  506. /// Remove an exposed parameter
  507. /// </summary>
  508. /// <param name="guid">GUID of the parameter</param>
  509. public void RemoveExposedParameter(string guid)
  510. {
  511. if (exposedParameters.RemoveAll(e => e.guid == guid) != 0)
  512. onExposedParameterListChanged?.Invoke();
  513. }
  514. internal void NotifyExposedParameterListChanged()
  515. => onExposedParameterListChanged?.Invoke();
  516. /// <summary>
  517. /// Update an exposed parameter value
  518. /// </summary>
  519. /// <param name="guid">GUID of the parameter</param>
  520. /// <param name="value">new value</param>
  521. public void UpdateExposedParameter(string guid, object value)
  522. {
  523. var param = exposedParameters.Find(e => e.guid == guid);
  524. if (param == null)
  525. return;
  526. if (value != null && !param.GetValueType().IsAssignableFrom(value.GetType()))
  527. throw new Exception("Type mismatch when updating parameter " + param.name + ": from " + param.GetValueType() + " to " + value.GetType().AssemblyQualifiedName);
  528. param.value = value;
  529. onExposedParameterModified?.Invoke(param);
  530. }
  531. /// <summary>
  532. /// Update the exposed parameter name
  533. /// </summary>
  534. /// <param name="parameter">The parameter</param>
  535. /// <param name="name">new name</param>
  536. public void UpdateExposedParameterName(ExposedParameter parameter, string name)
  537. {
  538. parameter.name = name;
  539. onExposedParameterModified?.Invoke(parameter);
  540. }
  541. /// <summary>
  542. /// Update parameter visibility
  543. /// </summary>
  544. /// <param name="parameter">The parameter</param>
  545. /// <param name="isHidden">is Hidden</param>
  546. public void NotifyExposedParameterChanged(ExposedParameter parameter)
  547. {
  548. onExposedParameterModified?.Invoke(parameter);
  549. }
  550. public void NotifyExposedParameterValueChanged(ExposedParameter parameter)
  551. {
  552. onExposedParameterValueChanged?.Invoke(parameter);
  553. }
  554. /// <summary>
  555. /// Get the exposed parameter from name
  556. /// </summary>
  557. /// <param name="name">name</param>
  558. /// <returns>the parameter or null</returns>
  559. public ExposedParameter GetExposedParameter(string name)
  560. {
  561. return exposedParameters.FirstOrDefault(e => e.name == name);
  562. }
  563. /// <summary>
  564. /// Get exposed parameter from GUID
  565. /// </summary>
  566. /// <param name="guid">GUID of the parameter</param>
  567. /// <returns>The parameter</returns>
  568. public ExposedParameter GetExposedParameterFromGUID(string guid)
  569. {
  570. return exposedParameters.FirstOrDefault(e => e?.guid == guid);
  571. }
  572. /// <summary>
  573. /// Set parameter value from name. (Warning: the parameter name can be changed by the user)
  574. /// </summary>
  575. /// <param name="name">name of the parameter</param>
  576. /// <param name="value">new value</param>
  577. /// <returns>true if the value have been assigned</returns>
  578. public bool SetParameterValue(string name, object value)
  579. {
  580. var e = exposedParameters.FirstOrDefault(p => p.name == name);
  581. if (e == null)
  582. return false;
  583. e.value = value;
  584. return true;
  585. }
  586. /// <summary>
  587. /// Get the parameter value
  588. /// </summary>
  589. /// <param name="name">parameter name</param>
  590. /// <returns>value</returns>
  591. public object GetParameterValue(string name) => exposedParameters.FirstOrDefault(p => p.name == name)?.value;
  592. /// <summary>
  593. /// Get the parameter value template
  594. /// </summary>
  595. /// <param name="name">parameter name</param>
  596. /// <typeparam name="T">type of the parameter</typeparam>
  597. /// <returns>value</returns>
  598. public T GetParameterValue< T >(string name) => (T)GetParameterValue(name);
  599. /// <summary>
  600. /// Link the current graph to the scene in parameter, allowing the graph to pick and serialize objects from the scene.
  601. /// </summary>
  602. /// <param name="scene">Target scene to link</param>
  603. public void LinkToScene(Scene scene)
  604. {
  605. linkedScene = scene;
  606. onSceneLinked?.Invoke(scene);
  607. }
  608. /// <summary>
  609. /// Return true when the graph is linked to a scene, false otherwise.
  610. /// </summary>
  611. public bool IsLinkedToScene() => linkedScene.IsValid();
  612. /// <summary>
  613. /// Get the linked scene. If there is no linked scene, it returns an invalid scene
  614. /// </summary>
  615. public Scene GetLinkedScene() => linkedScene;
  616. HashSet<BaseNode> infiniteLoopTracker = new HashSet<BaseNode>();
  617. int UpdateComputeOrderBreadthFirst(int depth, BaseNode node)
  618. {
  619. int computeOrder = 0;
  620. if (depth > maxComputeOrderDepth)
  621. {
  622. Debug.LogError("Recursion error while updating compute order");
  623. return -1;
  624. }
  625. if (computeOrderDictionary.ContainsKey(node))
  626. return node.computeOrder;
  627. if (!infiniteLoopTracker.Add(node))
  628. return -1;
  629. if (!node.canProcess)
  630. {
  631. node.computeOrder = -1;
  632. computeOrderDictionary[node] = -1;
  633. return -1;
  634. }
  635. foreach (var dep in node.GetInputNodes())
  636. {
  637. int c = UpdateComputeOrderBreadthFirst(depth + 1, dep);
  638. if (c == -1)
  639. {
  640. computeOrder = -1;
  641. break ;
  642. }
  643. computeOrder += c;
  644. }
  645. if (computeOrder != -1)
  646. computeOrder++;
  647. node.computeOrder = computeOrder;
  648. computeOrderDictionary[node] = computeOrder;
  649. return computeOrder;
  650. }
  651. void UpdateComputeOrderDepthFirst()
  652. {
  653. Stack<BaseNode> dfs = new Stack<BaseNode>();
  654. GraphUtils.FindCyclesInGraph(this, (n) => {
  655. PropagateComputeOrder(n, loopComputeOrder);
  656. });
  657. int computeOrder = 0;
  658. foreach (var node in GraphUtils.DepthFirstSort(this))
  659. {
  660. if (node.computeOrder == loopComputeOrder)
  661. continue;
  662. if (!node.canProcess)
  663. node.computeOrder = -1;
  664. else
  665. node.computeOrder = computeOrder++;
  666. }
  667. }
  668. void PropagateComputeOrder(BaseNode node, int computeOrder)
  669. {
  670. Stack<BaseNode> deps = new Stack<BaseNode>();
  671. HashSet<BaseNode> loop = new HashSet<BaseNode>();
  672. deps.Push(node);
  673. while (deps.Count > 0)
  674. {
  675. var n = deps.Pop();
  676. n.computeOrder = computeOrder;
  677. if (!loop.Add(n))
  678. continue;
  679. foreach (var dep in n.GetOutputNodes())
  680. deps.Push(dep);
  681. }
  682. }
  683. void DestroyBrokenGraphElements()
  684. {
  685. edges.RemoveAll(e => e.inputNode == null
  686. || e.outputNode == null
  687. || string.IsNullOrEmpty(e.outputFieldName)
  688. || string.IsNullOrEmpty(e.inputFieldName)
  689. );
  690. nodes.RemoveAll(n => n == null);
  691. }
  692. /// <summary>
  693. /// Tell if two types can be connected in the context of a graph
  694. /// </summary>
  695. /// <param name="t1"></param>
  696. /// <param name="t2"></param>
  697. /// <returns></returns>
  698. public static bool TypesAreConnectable(Type t1, Type t2)
  699. {
  700. if (t1 == null || t2 == null)
  701. return false;
  702. if (TypeAdapter.AreIncompatible(t1, t2))
  703. return false;
  704. //Check if there is custom adapters for this assignation
  705. if (CustomPortIO.IsAssignable(t1, t2))
  706. return true;
  707. //Check for type assignability
  708. if (t2.IsReallyAssignableFrom(t1))
  709. return true;
  710. // User defined type convertions
  711. if (TypeAdapter.AreAssignable(t1, t2))
  712. return true;
  713. return false;
  714. }
  715. }
  716. }