videocontext
Version:
A WebGL & HTML5 graph based video composition library
3,673 lines (1,024 loc) • 49.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: TransitionNode</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: TransitionNode</h1>
<section>
<header>
<h2>TransitionNode</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="TransitionNode"><span class="type-signature"></span>new TransitionNode<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Initialise an instance of a TransitionNode. You should not instantiate this directly, but use VideoContest.createTransitonNode().</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="clearTransition"><span class="type-signature"></span>clearTransition<span class="signature">(propertyName, time)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Clear a transistion on the passed property that the specified time lies within.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property to clear a transition on.</p></td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A time which lies within the property you're trying to clear.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line98">line 98</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is removed, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="clearTransition"><span class="type-signature"></span>clearTransition<span class="signature">(propertyName, time)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Clear a transistion on the passed property that the specified time lies within.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property to clear a transition on.</p></td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A time which lies within the property you're trying to clear.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line98">line 98</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is removed, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="clearTransitions"><span class="type-signature"></span>clearTransitions<span class="signature">(propertyName)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Clear all transistions on the passed property. If no property is defined clear all transitions on the node.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined clear all transitions on the node.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h4 class="name" id="clearTransitions"><span class="type-signature"></span>clearTransitions<span class="signature">(propertyName)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Clear all transistions on the passed property. If no property is defined clear all transitions on the node.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined clear all transitions on the node.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h4 class="name" id="transition"><span class="type-signature"></span>transition<span class="signature">(startTime, endTime, currentValue, targetValue, propertyName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Create a transition on the timeline.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should start (relative to currentTime of video context).</p></td>
</tr>
<tr>
<td class="name"><code>endTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should be completed by (relative to currentTime of video context).</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to start the transition at.</p></td>
</tr>
<tr>
<td class="name"><code>targetValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to transition to by endTime.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
mix
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined default to "mix".</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is successfully added, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="transition"><span class="type-signature"></span>transition<span class="signature">(startTime, endTime, currentValue, targetValue, propertyName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Create a transition on the timeline.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should start (relative to currentTime of video context).</p></td>
</tr>
<tr>
<td class="name"><code>endTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should be completed by (relative to currentTime of video context).</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to start the transition at.</p></td>
</tr>
<tr>
<td class="name"><code>targetValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to transition to by endTime.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
mix
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined default to "mix".</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is successfully added, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="transitionAt"><span class="type-signature"></span>transitionAt<span class="signature">(startTime, endTime, currentValue, targetValue, propertyName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Create a transition on the timeline at an absolute time.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should start (relative to time 0).</p></td>
</tr>
<tr>
<td class="name"><code>endTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should be completed by (relative to time 0).</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to start the transition at.</p></td>
</tr>
<tr>
<td class="name"><code>targetValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to transition to by endTime.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
mix
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined default to "mix".</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is successfully added, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="transitionAt"><span class="type-signature"></span>transitionAt<span class="signature">(startTime, endTime, currentValue, targetValue, propertyName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Create a transition on the timeline at an absolute time.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should start (relative to time 0).</p></td>
</tr>
<tr>
<td class="name"><code>endTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should be completed by (relative to time 0).</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to start the transition at.</p></td>
</tr>
<tr>
<td class="name"><code>targetValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to transition to by endTime.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
mix
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined default to "mix".</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is successfully added, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
</article>
</section>
<section>
<header>
<h2>TransitionNode</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="TransitionNode"><span class="type-signature"></span>new TransitionNode<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Initialise an instance of a TransitionNode. You should not instantiate this directly, but use VideoContest.createTransitonNode().</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="clearTransition"><span class="type-signature"></span>clearTransition<span class="signature">(propertyName, time)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Clear a transistion on the passed property that the specified time lies within.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property to clear a transition on.</p></td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A time which lies within the property you're trying to clear.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line98">line 98</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is removed, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="clearTransition"><span class="type-signature"></span>clearTransition<span class="signature">(propertyName, time)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Clear a transistion on the passed property that the specified time lies within.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property to clear a transition on.</p></td>
</tr>
<tr>
<td class="name"><code>time</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>A time which lies within the property you're trying to clear.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line98">line 98</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is removed, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="clearTransitions"><span class="type-signature"></span>clearTransitions<span class="signature">(propertyName)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Clear all transistions on the passed property. If no property is defined clear all transitions on the node.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined clear all transitions on the node.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h4 class="name" id="clearTransitions"><span class="type-signature"></span>clearTransitions<span class="signature">(propertyName)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Clear all transistions on the passed property. If no property is defined clear all transitions on the node.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined clear all transitions on the node.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h4 class="name" id="transition"><span class="type-signature"></span>transition<span class="signature">(startTime, endTime, currentValue, targetValue, propertyName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Create a transition on the timeline.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should start (relative to currentTime of video context).</p></td>
</tr>
<tr>
<td class="name"><code>endTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should be completed by (relative to currentTime of video context).</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to start the transition at.</p></td>
</tr>
<tr>
<td class="name"><code>targetValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to transition to by endTime.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
mix
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined default to "mix".</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is successfully added, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="transition"><span class="type-signature"></span>transition<span class="signature">(startTime, endTime, currentValue, targetValue, propertyName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Create a transition on the timeline.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should start (relative to currentTime of video context).</p></td>
</tr>
<tr>
<td class="name"><code>endTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should be completed by (relative to currentTime of video context).</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to start the transition at.</p></td>
</tr>
<tr>
<td class="name"><code>targetValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to transition to by endTime.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
mix
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined default to "mix".</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line51">line 51</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is successfully added, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="transitionAt"><span class="type-signature"></span>transitionAt<span class="signature">(startTime, endTime, currentValue, targetValue, propertyName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Create a transition on the timeline at an absolute time.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should start (relative to time 0).</p></td>
</tr>
<tr>
<td class="name"><code>endTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should be completed by (relative to time 0).</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to start the transition at.</p></td>
</tr>
<tr>
<td class="name"><code>targetValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to transition to by endTime.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
mix
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined default to "mix".</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is successfully added, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="transitionAt"><span class="type-signature"></span>transitionAt<span class="signature">(startTime, endTime, currentValue, targetValue, propertyName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
<p>Create a transition on the timeline at an absolute time.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should start (relative to time 0).</p></td>
</tr>
<tr>
<td class="name"><code>endTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The time at which the transition should be completed by (relative to time 0).</p></td>
</tr>
<tr>
<td class="name"><code>currentValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to start the transition at.</p></td>
</tr>
<tr>
<td class="name"><code>targetValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
</td>
<td class="description last"><p>The value to transition to by endTime.</p></td>
</tr>
<tr>
<td class="name"><code>propertyName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
mix
</td>
<td class="description last"><p>The name of the property to clear transitions on, if undefined default to "mix".</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ProcessingNodes_transitionnode.js.html">ProcessingNodes/transitionnode.js</a>, <a href="ProcessingNodes_transitionnode.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>returns True if a transition is successfully added, false otherwise.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</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>