NodeGraph.html 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: NodeGraph</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: NodeGraph</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>NodeGraph<span class="signature">()</span><span class="type-signature"></span></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="NodeGraph"><span class="type-signature"></span>new NodeGraph<span class="signature">()</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. Node graph object should be used as a container for node elements. The node graph object specifies how the nodes are processed, each individual node can store and process data, the node graph specified how this information is processed. All node elements are stored as children of the node graph.
  26. </div>
  27. <dl class="details">
  28. <dt class="tag-source">Source:</dt>
  29. <dd class="tag-source"><ul class="dummy"><li>
  30. <a href="objects_node_NodeGraph.js.html">objects/node/NodeGraph.js</a>, <a href="objects_node_NodeGraph.js.html#line3">line 3</a>
  31. </li></ul></dd>
  32. </dl>
  33. </div>
  34. <h3 class="subsection-title">Methods</h3>
  35. <h4 class="name" id="addNode"><span class="type-signature"></span>addNode<span class="signature">(node)</span><span class="type-signature"> &rarr; {<a href="Node.html">Node</a>}</span></h4>
  36. <div class="description">
  37. Create and add a new node of specific node type to the graph. Automatically finds an empty space as close as possible to other nodes to add this new node.
  38. </div>
  39. <h5>Parameters:</h5>
  40. <table class="params">
  41. <thead>
  42. <tr>
  43. <th>Name</th>
  44. <th>Type</th>
  45. <th class="last">Description</th>
  46. </tr>
  47. </thead>
  48. <tbody>
  49. <tr>
  50. <td class="name"><code>node</code></td>
  51. <td class="type">
  52. <span class="param-type"><a href="Node.html">Node</a></span>
  53. </td>
  54. <td class="description last">Node object to be added.</td>
  55. </tr>
  56. </tbody>
  57. </table>
  58. <dl class="details">
  59. <dt class="tag-source">Source:</dt>
  60. <dd class="tag-source"><ul class="dummy"><li>
  61. <a href="objects_node_NodeGraph.js.html">objects/node/NodeGraph.js</a>, <a href="objects_node_NodeGraph.js.html#line27">line 27</a>
  62. </li></ul></dd>
  63. </dl>
  64. <h5>Returns:</h5>
  65. <div class="param-desc">
  66. Node created (already added to the graph).
  67. </div>
  68. <dl>
  69. <dt>
  70. Type
  71. </dt>
  72. <dd>
  73. <span class="param-type"><a href="Node.html">Node</a></span>
  74. </dd>
  75. </dl>
  76. </article>
  77. </section>
  78. </div>
  79. <nav>
  80. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BezierCurve.html">BezierCurve</a></li><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="MultiLineText.html">MultiLineText</a></li><li><a href="Node.html">Node</a></li><li><a href="NodeConnector.html">NodeConnector</a></li><li><a href="NodeGraph.html">NodeGraph</a></li><li><a href="NodeSocket.html">NodeSocket</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="QuadraticCurve.html">QuadraticCurve</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="RoundedBox.html">RoundedBox</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ViewportControls.html">ViewportControls</a></li></ul><h3>Global</h3><ul><li><a href="global.html#connector">connector</a></li><li><a href="global.html#direction">direction</a></li><li><a href="global.html#inputs">inputs</a></li><li><a href="global.html#inputSocket">inputSocket</a></li><li><a href="global.html#name">name</a></li><li><a href="global.html#node">node</a></li><li><a href="global.html#outputs">outputs</a></li><li><a href="global.html#outputSocket">outputSocket</a></li><li><a href="global.html#text">text</a></li><li><a href="global.html#type">type</a></li></ul>
  81. </nav>
  82. <br class="clear">
  83. <footer>
  84. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Thu May 14 2020 18:22:31 GMT+0100 (Western European Summer Time)
  85. </footer>
  86. <script> prettyPrint(); </script>
  87. <script src="scripts/linenumber.js"> </script>
  88. </body>
  89. </html>