You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

776 lines
39 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Otter: Otter.Anim Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="otterlogosmall.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Otter
&#160;<span id="projectnumber">0.9.8.91</span>
</div>
<div id="projectbrief">2d Game Development Framework based on SFML.Net</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_otter_1_1_anim.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_otter_1_1_anim-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Otter.Anim Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class used for animations in Spritemap.
<a href="class_otter_1_1_anim.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abe3cea34bb85c7762004a464f8e7a3ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#abe3cea34bb85c7762004a464f8e7a3ae">Anim</a> (int[] frames, float[] frameDelays=null)</td></tr>
<tr class="memdesc:abe3cea34bb85c7762004a464f8e7a3ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="class_otter_1_1_anim.html" title="Class used for animations in Spritemap. ">Anim</a> with an array of ints for frames, and an array of floats for frameDelays. <a href="#abe3cea34bb85c7762004a464f8e7a3ae">More...</a><br/></td></tr>
<tr class="separator:abe3cea34bb85c7762004a464f8e7a3ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a786c7890507fa6ad33d7e4323618699e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a786c7890507fa6ad33d7e4323618699e">Anim</a> (string frames, string frameDelays)</td></tr>
<tr class="memdesc:a786c7890507fa6ad33d7e4323618699e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="class_otter_1_1_anim.html" title="Class used for animations in Spritemap. ">Anim</a> with a string of ints for frames, and a string of floats for frameDelays. <a href="#a786c7890507fa6ad33d7e4323618699e">More...</a><br/></td></tr>
<tr class="separator:a786c7890507fa6ad33d7e4323618699e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80bb1861107cfeddc5de21114f25aa97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_anim.html">Anim</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a80bb1861107cfeddc5de21114f25aa97">Repeat</a> (int times=-1)</td></tr>
<tr class="memdesc:a80bb1861107cfeddc5de21114f25aa97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how many times this animation loops. -1 for infinite. <a href="#a80bb1861107cfeddc5de21114f25aa97">More...</a><br/></td></tr>
<tr class="separator:a80bb1861107cfeddc5de21114f25aa97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4647fddaa7bfe82ba550c8b13375f456"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_anim.html">Anim</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a4647fddaa7bfe82ba550c8b13375f456">NoRepeat</a> ()</td></tr>
<tr class="memdesc:a4647fddaa7bfe82ba550c8b13375f456"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables repeating. Animations default to repeat on. <a href="#a4647fddaa7bfe82ba550c8b13375f456">More...</a><br/></td></tr>
<tr class="separator:a4647fddaa7bfe82ba550c8b13375f456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93f8fe0a30e4c36c5e2ed657f631a81f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_anim.html">Anim</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a93f8fe0a30e4c36c5e2ed657f631a81f">PingPong</a> (bool pingpong=true)</td></tr>
<tr class="memdesc:a93f8fe0a30e4c36c5e2ed657f631a81f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the animation will repeat by going back and forth between the start and end. <a href="#a93f8fe0a30e4c36c5e2ed657f631a81f">More...</a><br/></td></tr>
<tr class="separator:a93f8fe0a30e4c36c5e2ed657f631a81f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d599b30dacc9076cf564d5a1d355c90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_anim.html">Anim</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a0d599b30dacc9076cf564d5a1d355c90">Speed</a> (float speed)</td></tr>
<tr class="memdesc:a0d599b30dacc9076cf564d5a1d355c90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the playback speed of the animation. 1 = 1 frame. <a href="#a0d599b30dacc9076cf564d5a1d355c90">More...</a><br/></td></tr>
<tr class="separator:a0d599b30dacc9076cf564d5a1d355c90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5760466ca7ce56f645c76e1bc467fc9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_anim.html">Anim</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a5760466ca7ce56f645c76e1bc467fc9e">LoopBackTo</a> (int frame=0)</td></tr>
<tr class="memdesc:a5760466ca7ce56f645c76e1bc467fc9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines which frame the animation will loop back to when it repeats. <a href="#a5760466ca7ce56f645c76e1bc467fc9e">More...</a><br/></td></tr>
<tr class="separator:a5760466ca7ce56f645c76e1bc467fc9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b8c67cf504c4c12f42d2b00967ec474"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_anim.html">Anim</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a0b8c67cf504c4c12f42d2b00967ec474">Stop</a> ()</td></tr>
<tr class="memdesc:a0b8c67cf504c4c12f42d2b00967ec474"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the animation and returns it to the first frame. <a href="#a0b8c67cf504c4c12f42d2b00967ec474">More...</a><br/></td></tr>
<tr class="separator:a0b8c67cf504c4c12f42d2b00967ec474"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f3f68c0bcda3852736bfa9ffefd7c61"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_anim.html">Anim</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a4f3f68c0bcda3852736bfa9ffefd7c61">Reset</a> ()</td></tr>
<tr class="memdesc:a4f3f68c0bcda3852736bfa9ffefd7c61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the animation back to frame 0 but does not stop it. <a href="#a4f3f68c0bcda3852736bfa9ffefd7c61">More...</a><br/></td></tr>
<tr class="separator:a4f3f68c0bcda3852736bfa9ffefd7c61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6a132d07c166147acbf3f9a933d3dfc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#aa6a132d07c166147acbf3f9a933d3dfc">Update</a> (float t=1f)</td></tr>
<tr class="memdesc:aa6a132d07c166147acbf3f9a933d3dfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the <a class="el" href="class_otter_1_1_anim.html" title="Class used for animations in Spritemap. ">Anim</a> object. Handled by the Spritemap usually. If this doesn't run the animation will not play. <a href="#aa6a132d07c166147acbf3f9a933d3dfc">More...</a><br/></td></tr>
<tr class="separator:aa6a132d07c166147acbf3f9a933d3dfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa5ba3ca3068dfa543bbce718d7fdb40f"><td class="memItemLeft" align="right" valign="top">static int[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#aa5ba3ca3068dfa543bbce718d7fdb40f">FramesRange</a> (int min, int max)</td></tr>
<tr class="memdesc:aa5ba3ca3068dfa543bbce718d7fdb40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an array of numbers from min to max. Useful for passing in arguments for long animations. <a href="#aa5ba3ca3068dfa543bbce718d7fdb40f">More...</a><br/></td></tr>
<tr class="separator:aa5ba3ca3068dfa543bbce718d7fdb40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a02a06c1a0c560852e761ef4e76a41f"><td class="memItemLeft" align="right" valign="top">static int[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a6a02a06c1a0c560852e761ef4e76a41f">ParseFrames</a> (string input)</td></tr>
<tr class="memdesc:a6a02a06c1a0c560852e761ef4e76a41f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an array of frames from a string expression. The expression must be similar to the following format: "0,3,7-11,2,5" Whitespace is permitted, and commas are optional. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>A string formatted as above, describing the frames to generate.</td></tr>
</table>
</dd>
</dl>
<a href="#a6a02a06c1a0c560852e761ef4e76a41f">More...</a><br/></td></tr>
<tr class="separator:a6a02a06c1a0c560852e761ef4e76a41f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7bf1d90c1b325955db531ddb5b2a229d"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a7bf1d90c1b325955db531ddb5b2a229d">OnComplete</a> = delegate { }</td></tr>
<tr class="memdesc:a7bf1d90c1b325955db531ddb5b2a229d"><td class="mdescLeft">&#160;</td><td class="mdescRight">An action to run when the animation finishes playing. <a href="#a7bf1d90c1b325955db531ddb5b2a229d">More...</a><br/></td></tr>
<tr class="separator:a7bf1d90c1b325955db531ddb5b2a229d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57280b04cedeac7e18d6bb07d80951d6"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a57280b04cedeac7e18d6bb07d80951d6">OnNewFrame</a> = delegate { }</td></tr>
<tr class="memdesc:a57280b04cedeac7e18d6bb07d80951d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">An action that is called when the <a class="el" href="class_otter_1_1_anim.html" title="Class used for animations in Spritemap. ">Anim</a> switches to a new frame. <a href="#a57280b04cedeac7e18d6bb07d80951d6">More...</a><br/></td></tr>
<tr class="separator:a57280b04cedeac7e18d6bb07d80951d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b0368f3963149b1b4c484965e0f2b60"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a3b0368f3963149b1b4c484965e0f2b60">Active</a></td></tr>
<tr class="memdesc:a3b0368f3963149b1b4c484965e0f2b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the animation is active (playing.) <a href="#a3b0368f3963149b1b4c484965e0f2b60">More...</a><br/></td></tr>
<tr class="separator:a3b0368f3963149b1b4c484965e0f2b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ad9cfcd207fdabec7a2d8715ae9645b1d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#ad9cfcd207fdabec7a2d8715ae9645b1d">PlaybackSpeed</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ad9cfcd207fdabec7a2d8715ae9645b1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The overall playback speed of the animation. <a href="#ad9cfcd207fdabec7a2d8715ae9645b1d">More...</a><br/></td></tr>
<tr class="separator:ad9cfcd207fdabec7a2d8715ae9645b1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45b4b8bd534e7a0fc516059392e8c8ef"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a45b4b8bd534e7a0fc516059392e8c8ef">RepeatCount</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a45b4b8bd534e7a0fc516059392e8c8ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">The repeat count of the animation. <a href="#a45b4b8bd534e7a0fc516059392e8c8ef">More...</a><br/></td></tr>
<tr class="separator:a45b4b8bd534e7a0fc516059392e8c8ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04cf79e0b4d996ec77be76c79a21f4f9"><td class="memItemLeft" align="right" valign="top">List&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a04cf79e0b4d996ec77be76c79a21f4f9">Frames</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a04cf79e0b4d996ec77be76c79a21f4f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The frames used in the animation. <a href="#a04cf79e0b4d996ec77be76c79a21f4f9">More...</a><br/></td></tr>
<tr class="separator:a04cf79e0b4d996ec77be76c79a21f4f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3704589c1f590e78ad7a04cc2d87b53a"><td class="memItemLeft" align="right" valign="top">List&lt; float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a3704589c1f590e78ad7a04cc2d87b53a">FrameDelays</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a3704589c1f590e78ad7a04cc2d87b53a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The frame delays used in the animation. <a href="#a3704589c1f590e78ad7a04cc2d87b53a">More...</a><br/></td></tr>
<tr class="separator:a3704589c1f590e78ad7a04cc2d87b53a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b72692c052d6e6e57a88ea4d2321721"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a5b72692c052d6e6e57a88ea4d2321721">FrameCount</a><code> [get]</code></td></tr>
<tr class="memdesc:a5b72692c052d6e6e57a88ea4d2321721"><td class="mdescLeft">&#160;</td><td class="mdescRight">The total number of frames in this animation. <a href="#a5b72692c052d6e6e57a88ea4d2321721">More...</a><br/></td></tr>
<tr class="separator:a5b72692c052d6e6e57a88ea4d2321721"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a776f3dd3735ba77720e5cb5a083bc42e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a776f3dd3735ba77720e5cb5a083bc42e">CurrentFrame</a><code> [get]</code></td></tr>
<tr class="memdesc:a776f3dd3735ba77720e5cb5a083bc42e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current frame of the animation. <a href="#a776f3dd3735ba77720e5cb5a083bc42e">More...</a><br/></td></tr>
<tr class="separator:a776f3dd3735ba77720e5cb5a083bc42e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a010d1fce5971986c83472d83bdbaf838"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#a010d1fce5971986c83472d83bdbaf838">CurrentFrameIndex</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a010d1fce5971986c83472d83bdbaf838"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current frame index of the animation. <a href="#a010d1fce5971986c83472d83bdbaf838">More...</a><br/></td></tr>
<tr class="separator:a010d1fce5971986c83472d83bdbaf838"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af793e5952cfb9a8aa744ce537c3cecea"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_anim.html#af793e5952cfb9a8aa744ce537c3cecea">TotalDuration</a><code> [get]</code></td></tr>
<tr class="memdesc:af793e5952cfb9a8aa744ce537c3cecea"><td class="mdescLeft">&#160;</td><td class="mdescRight">The total duration of the animation. <a href="#af793e5952cfb9a8aa744ce537c3cecea">More...</a><br/></td></tr>
<tr class="separator:af793e5952cfb9a8aa744ce537c3cecea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class used for animations in Spritemap. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abe3cea34bb85c7762004a464f8e7a3ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Anim.Anim </td>
<td>(</td>
<td class="paramtype">int[]&#160;</td>
<td class="paramname"><em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float[]&#160;</td>
<td class="paramname"><em>frameDelays</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="class_otter_1_1_anim.html" title="Class used for animations in Spritemap. ">Anim</a> with an array of ints for frames, and an array of floats for frameDelays. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frames</td><td>The frames from the sprite sheet to display.</td></tr>
<tr><td class="paramname">frameDelays</td><td>The time that each frame should be displayed.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a786c7890507fa6ad33d7e4323618699e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Anim.Anim </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>frames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>frameDelays</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="class_otter_1_1_anim.html" title="Class used for animations in Spritemap. ">Anim</a> with a string of ints for frames, and a string of floats for frameDelays. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frames</td><td>A string of frames separated by a delim character. Example: "0,1,2-7,9,11"</td></tr>
<tr><td class="paramname">frameDelays</td><td>A string of floats separated by a delim character. Example: "0.5f,1,0.5f,1"</td></tr>
<tr><td class="paramname">delim</td><td>The string of characters to parse the string by. Default is ","</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa5ba3ca3068dfa543bbce718d7fdb40f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int [] Otter.Anim.FramesRange </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an array of numbers from min to max. Useful for passing in arguments for long animations. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">min</td><td>The start of the animation (includes this number.)</td></tr>
<tr><td class="paramname">max</td><td>The end of the animation (includes this number.)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The array of ints representing an animation.</dd></dl>
</div>
</div>
<a class="anchor" id="a5760466ca7ce56f645c76e1bc467fc9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_anim.html">Anim</a> Otter.Anim.LoopBackTo </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>frame</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines which frame the animation will loop back to when it repeats. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frame</td><td>The frame to loop back to (from 0 to frame count - 1)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The anim object.</dd></dl>
</div>
</div>
<a class="anchor" id="a4647fddaa7bfe82ba550c8b13375f456"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_anim.html">Anim</a> Otter.Anim.NoRepeat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disables repeating. Animations default to repeat on. </p>
<dl class="section return"><dt>Returns</dt><dd>The anim object.</dd></dl>
</div>
</div>
<a class="anchor" id="a6a02a06c1a0c560852e761ef4e76a41f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int [] Otter.Anim.ParseFrames </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>input</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an array of frames from a string expression. The expression must be similar to the following format: "0,3,7-11,2,5" Whitespace is permitted, and commas are optional. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>A string formatted as above, describing the frames to generate.</td></tr>
</table>
</dd>
</dl>
</p>
</div>
</div>
<a class="anchor" id="a93f8fe0a30e4c36c5e2ed657f631a81f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_anim.html">Anim</a> Otter.Anim.PingPong </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>pingpong</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the animation will repeat by going back and forth between the start and end. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pingpong</td><td>True for yes, false for no no no.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The anim object.</dd></dl>
</div>
</div>
<a class="anchor" id="a80bb1861107cfeddc5de21114f25aa97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_anim.html">Anim</a> Otter.Anim.Repeat </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>times</em> = <code>-1</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines how many times this animation loops. -1 for infinite. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">times</td><td>How many times the animation should repeat.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The anim object.</dd></dl>
</div>
</div>
<a class="anchor" id="a4f3f68c0bcda3852736bfa9ffefd7c61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_anim.html">Anim</a> Otter.Anim.Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the animation back to frame 0 but does not stop it. </p>
<dl class="section return"><dt>Returns</dt><dd>The anim object.</dd></dl>
</div>
</div>
<a class="anchor" id="a0d599b30dacc9076cf564d5a1d355c90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_anim.html">Anim</a> Otter.Anim.Speed </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>speed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the playback speed of the animation. 1 = 1 frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">speed</td><td>The new speed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The anim object.</dd></dl>
</div>
</div>
<a class="anchor" id="a0b8c67cf504c4c12f42d2b00967ec474"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_otter_1_1_anim.html">Anim</a> Otter.Anim.Stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops the animation and returns it to the first frame. </p>
<dl class="section return"><dt>Returns</dt><dd>The anim object.</dd></dl>
</div>
</div>
<a class="anchor" id="aa6a132d07c166147acbf3f9a933d3dfc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Otter.Anim.Update </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>t</em> = <code>1f</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the <a class="el" href="class_otter_1_1_anim.html" title="Class used for animations in Spritemap. ">Anim</a> object. Handled by the Spritemap usually. If this doesn't run the animation will not play. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td>The time scale.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a3b0368f3963149b1b4c484965e0f2b60"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Otter.Anim.Active</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the animation is active (playing.) </p>
</div>
</div>
<a class="anchor" id="a7bf1d90c1b325955db531ddb5b2a229d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Action Otter.Anim.OnComplete = delegate { }</td>
</tr>
</table>
</div><div class="memdoc">
<p>An action to run when the animation finishes playing. </p>
</div>
</div>
<a class="anchor" id="a57280b04cedeac7e18d6bb07d80951d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Action Otter.Anim.OnNewFrame = delegate { }</td>
</tr>
</table>
</div><div class="memdoc">
<p>An action that is called when the <a class="el" href="class_otter_1_1_anim.html" title="Class used for animations in Spritemap. ">Anim</a> switches to a new frame. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a776f3dd3735ba77720e5cb5a083bc42e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Otter.Anim.CurrentFrame</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The current frame of the animation. </p>
</div>
</div>
<a class="anchor" id="a010d1fce5971986c83472d83bdbaf838"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Otter.Anim.CurrentFrameIndex</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The current frame index of the animation. </p>
</div>
</div>
<a class="anchor" id="a5b72692c052d6e6e57a88ea4d2321721"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Otter.Anim.FrameCount</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The total number of frames in this animation. </p>
</div>
</div>
<a class="anchor" id="a3704589c1f590e78ad7a04cc2d87b53a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">List&lt;float&gt; Otter.Anim.FrameDelays</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The frame delays used in the animation. </p>
</div>
</div>
<a class="anchor" id="a04cf79e0b4d996ec77be76c79a21f4f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">List&lt;int&gt; Otter.Anim.Frames</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The frames used in the animation. </p>
</div>
</div>
<a class="anchor" id="ad9cfcd207fdabec7a2d8715ae9645b1d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Otter.Anim.PlaybackSpeed</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The overall playback speed of the animation. </p>
</div>
</div>
<a class="anchor" id="a45b4b8bd534e7a0fc516059392e8c8ef"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Otter.Anim.RepeatCount</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The repeat count of the animation. </p>
</div>
</div>
<a class="anchor" id="af793e5952cfb9a8aa744ce537c3cecea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Otter.Anim.TotalDuration</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The total duration of the animation. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Otter/Graphics/Anim.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespace_otter.html">Otter</a></li><li class="navelem"><a class="el" href="class_otter_1_1_anim.html">Anim</a></li>
<li class="footer">Generated on Thu May 12 2016 18:16:52 for Otter by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>