videocontext
Version:
A WebGL & HTML5 graph based video composition library
944 lines (196 loc) • 10.9 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: GraphNode</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: GraphNode</h1>
<section>
<header>
<h2>GraphNode</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="GraphNode"><span class="type-signature"></span>new GraphNode<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Base class from which all processing and source nodes are derrived.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="destroyed"><span class="type-signature"></span>destroyed<span class="type-signature"></span></h4>
<div class="description">
<p>Get whether the node has been destroyed or not.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line72">line 72</a>
</li></ul></dd>
</dl>
<h4 class="name" id="displayName"><span class="type-signature"></span>displayName<span class="type-signature"></span></h4>
<div class="description">
<p>Get a string representation of the class name.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line24">line 24</a>
</li></ul></dd>
</dl>
<h4 class="name" id="inputNames"><span class="type-signature"></span>inputNames<span class="type-signature"></span></h4>
<div class="description">
<p>Get the names of the inputs to this node.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
<h4 class="name" id="inputs"><span class="type-signature"></span>inputs<span class="type-signature"></span></h4>
<div class="description">
<p>Get an array of all the nodes which connect to this node.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id="maximumConnections"><span class="type-signature"></span>maximumConnections<span class="type-signature"></span></h4>
<div class="description">
<p>The maximum number of connections that can be made to this node. If there is not limit this will return Infinity.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line42">line 42</a>
</li></ul></dd>
</dl>
<h4 class="name" id="outputs"><span class="type-signature"></span>outputs<span class="type-signature"></span></h4>
<div class="description">
<p>Get an array of all the nodes which this node outputs to.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line63">line 63</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(targetNode, targetPort<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Connect this node to the targetNode</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>targetNode</code></td>
<td class="type">
<span class="param-type"><a href="GraphNode.html">GraphNode</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>the node to connect.</p></td>
</tr>
<tr>
<td class="name"><code>targetPort</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>the port on the targetNode to connect to, this can be an index, a string identifier, or undefined (in which case the next available port will be connected to).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line84">line 84</a>
</li></ul></dd>
</dl>
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Destory this node, removing it from the graph.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line107">line 107</a>
</li></ul></dd>
</dl>
<h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">(targetNode<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Disconnect this node from the targetNode. If targetNode is undefind remove all out-bound connections.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>targetNode</code></td>
<td class="type">
<span class="param-type"><a href="GraphNode.html">GraphNode</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last"><p>the node to disconnect from. If undefined, disconnect from all nodes.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="graphnode.js.html">graphnode.js</a>, <a href="graphnode.js.html#line94">line 94</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-VideoContext.html">VideoContext</a></li></ul><h3>Classes</h3><ul><li><a href="CanvasNode.html">CanvasNode</a></li><li><a href="CompositingNode.html">CompositingNode</a></li><li><a href="DestinationNode.html">DestinationNode</a></li><li><a href="EffectNode.html">EffectNode</a></li><li><a href="GraphNode.html">GraphNode</a></li><li><a href="ImageNode.html">ImageNode</a></li><li><a href="module-VideoContext.html">VideoContext</a></li><li><a href="ProcessingNode.html">ProcessingNode</a></li><li><a href="RenderGraph.html">RenderGraph</a></li><li><a href="SourceNode.html">SourceNode</a></li><li><a href="TransitionNode.html">TransitionNode</a></li><li><a href="VideoNode.html">VideoNode</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>