<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Animations</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<link rel="stylesheet" type="text/css" href="css/VisDoc.css"/>
<script src="js/doc.js" type="text/javascript">//</script>
</head>
<body pageId="Pagecom_jeroenwijering_utils_Animations">
<div class="VisDoc"><span id="PageTop"><!----></span>
<div class="content"><span class="accessKeysInfo"><span class="label"><a href="#" class="accessKeyInfoToggle" onclick="toggleAccessKeyInfo(); return true;">Access keys</a></span><span class="accessKeyLinks" style="display:none;"><a href="#PageTop" accesskey="t">T</a>op, <a href="#Summary" accesskey="s">S</a>ummary,
Cl<a href="#Classmethods" accesskey="a">a</a>ss methods</span></span><h1>Animations</h1>
<div class="classProperties">
<table cellspacing="0">
<tr>
<th>Kind of class:</th>
<td>class</td>
</tr>
<tr>
<th>Inherits from:</th>
<td>none</td>
</tr>
<tr>
<th class="classDetails">Version:</th>
<td class="classDetails">1.01</td>
</tr>
<tr>
<th class="classDetails">Author:</th>
<td class="classDetails">Jeroen Wijering</td>
</tr>
<tr>
<th class="classDetails">Classpath:</th>
<td class="classDetails">com.jeroenwijering.utils.Animations</td>
</tr>
<tr>
<th class="classDetails">File last modified:</th>
<td class="classDetails">Wednesday, 01 November 2006, 23:01:38</td>
</tr>
</table>
</div>
<div class="classDescription">
<div class="descriptionSummary">A couple of commonly used animation functions</div><div class="classFields">
<div class="boxWithBorder">
<div class="boxedElem">
<div class="contentHolder"><span class="title">Example:</span><div class="item">import com.jeroenwijering.utils.Animations;<br /> Animations.fadeIn('some_clip');<br /> Animations.write('some_title_clip','A sunny day at the beach',2);</div>
</div>
</div>
</div>
</div>
</div>
<div class="summary hasBottomDivider">
<h2 class="hasBottomDivider"><span id="Summary">Summary</span></h2>
<div class="methodList">
<div class="methodSummaryPart"><span class="title">Class methods</span><ul>
<li>
<a href="#fadeIn">fadeIn</a>
</li>
<li>
<a href="#fadeOut">fadeOut</a>
</li>
<li>
<a href="#easeTo">easeTo</a>
</li>
<li>
<a href="#write">write</a>
</li>
<li>
<a href="#jump">jump</a>
</li>
<li>
<a href="#setColor">setColor</a>
</li>
</ul>
</div>
</div>
</div>
<div class="methodSection">
<h2 class="hasBottomDivider"><span id="Classmethods">Class methods</span></h2>
<div class="method hasBottomDivider">
<h3 id="easeTo">easeTo</h3>
<div class="fullMemberString">
<div class="clearfix floatholder">
<div class="floatbox code">static function <b>easeTo</b> (
</div>
<div><span class="code">tgt:MovieClip,
xps:Number,
yps:Number,
spd:Number) : Void</span></div>
</div>
</div>
<div class="description">Easing enterframe function for a Movieclip.</div>
<div class="boxWithBorder">
<div class="boxedElem">
<div class="contentHolder"><span class="title">Parameters:</span><div class="item">
<div class="floatbox code colorizedCode">tgt<span class="itemSeparator">:</span></div>
<div>MovieClip of the balloon to iterate</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">xps<span class="itemSeparator">:</span></div>
<div>Final x position.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">yps<span class="itemSeparator">:</span></div>
<div>Final y position.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">spd<span class="itemSeparator">:</span></div>
<div>Speed of the ease (1 to 10)</div>
</div>
</div>
</div>
</div>
</div>
<div class="method hasBottomDivider">
<h3 id="fadeIn">fadeIn</h3>
<div class="fullMemberString">
<div class="clearfix floatholder">
<div class="floatbox code">static function <b>fadeIn</b> (
</div>
<div><span class="code">tgt:MovieClip,
end:Number,
spd:Number) : Void</span></div>
</div>
</div>
<div class="description">Fadein function for MovieClip.</div>
<div class="boxWithBorder">
<div class="boxedElem">
<div class="contentHolder"><span class="title">Parameters:</span><div class="item">
<div class="floatbox code colorizedCode">tgt<span class="itemSeparator">:</span></div>
<div>Movieclip to fade.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">end<span class="itemSeparator">:</span></div>
<div>Final alpha value.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">inc<span class="itemSeparator">:</span></div>
<div>Speed of the fade (increment per frame).</div>
</div>
</div>
</div>
</div>
</div>
<div class="method hasBottomDivider">
<h3 id="fadeOut">fadeOut</h3>
<div class="fullMemberString">
<div class="clearfix floatholder">
<div class="floatbox code">static function <b>fadeOut</b> (
</div>
<div><span class="code">tgt:MovieClip,
end:Number,
spd:Number,
rmv:Boolean) : Void</span></div>
</div>
</div>
<div class="description">Fadeout function for MovieClip.</div>
<div class="boxWithBorder">
<div class="boxedElem">
<div class="contentHolder"><span class="title">Parameters:</span><div class="item">
<div class="floatbox code colorizedCode">tgt<span class="itemSeparator">:</span></div>
<div>Movieclip to fade.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">end<span class="itemSeparator">:</span></div>
<div>Final alpha value.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">inc<span class="itemSeparator">:</span></div>
<div>Speed of the fade (increment per frame).</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">rmv<span class="itemSeparator">:</span></div>
<div>Remove the clip after fadeout.</div>
</div>
</div>
</div>
</div>
</div>
<div class="method hasBottomDivider">
<h3 id="jump">jump</h3>
<div class="fullMemberString">
<div class="clearfix floatholder">
<div class="floatbox code">static function <b>jump</b> (
</div>
<div><span class="code">tgt:MovieClip,
scl:Number,
spd:Number) : Void</span></div>
</div>
</div>
<div class="description">Make a Movieclip jump to a specific scale</div>
<div class="boxWithBorder">
<div class="boxedElem">
<div class="contentHolder"><span class="title">Parameters:</span><div class="item">
<div class="floatbox code colorizedCode">tgt<span class="itemSeparator">:</span></div>
<div>Movieclip that should jump.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">scl<span class="itemSeparator">:</span></div>
<div>Final scale.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">spd<span class="itemSeparator">:</span></div>
<div>Oscillation speed (0 to 1).</div>
</div>
</div>
</div>
</div>
</div>
<div class="method hasBottomDivider">
<h3 id="setColor">setColor</h3>
<div class="fullMemberString">
<div class="clearfix floatholder">
<div class="floatbox code">static function <b>setColor</b> (
</div>
<div><span class="code">tgt:MovieClip,
red:Number,
gre:Number,
blu:Number,
dur:Number) : Void</span></div>
</div>
</div>
<div class="description">Transform the color of a MovieClip over time</div>
<div class="boxWithBorder">
<div class="boxedElem">
<div class="contentHolder"><span class="title">Parameters:</span><div class="item">
<div class="floatbox code colorizedCode">tgt<span class="itemSeparator">:</span></div>
<div>Target MovieClip.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">red<span class="itemSeparator">:</span></div>
<div>Red channel offset.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">gre<span class="itemSeparator">:</span></div>
<div>Green channel offset.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">blu<span class="itemSeparator">:</span></div>
<div>Blue channel offset.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">dur<span class="itemSeparator">:</span></div>
<div>Duration of the transformation (1 to 100).</div>
</div>
</div>
</div>
</div>
</div>
<div class="method hasBottomDivider">
<h3 id="write">write</h3>
<div class="fullMemberString">
<div class="clearfix floatholder">
<div class="floatbox code">static function <b>write</b> (
</div>
<div><span class="code">tgt:MovieClip,
txt:String,
spd:Number) : Void</span></div>
</div>
</div>
<div class="description">Write text character by character in a Movieclip's 'tf' (and 'tf2') textfield.</div>
<div class="boxWithBorder">
<div class="boxedElem">
<div class="contentHolder"><span class="title">Parameters:</span><div class="item">
<div class="floatbox code colorizedCode">tgt<span class="itemSeparator">:</span></div>
<div>Movieclip to draw the shape into.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">txt<span class="itemSeparator">:</span></div>
<div>Text to write.</div>
</div>
<div class="item">
<div class="floatbox code colorizedCode">spd<span class="itemSeparator">:</span></div>
<div>Writing speed (number of chars per frame).</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="docFooter"><span class="createdWith">Created with <a href="http://visiblearea.com/visdoc/">VisDoc</a></span><span class="separator">|</span><span class="creationDate">Tuesday, 07 November 2006, 14:45:41</span><span class="separator">|</span><a href="#" onclick="showTOC(); return false;" class="showToc">show TOC</a><a href="#" onclick="hideTOC(); return false;" class="hideToc">hide TOC</a></span><span class="tocFooter"><a href="#" onclick="hideTOC(); return false;" class="hideToc">hide TOC</a></span>
</div>
</div>
</div>
</body>
</html>