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.
666 lines
35 KiB
HTML
666 lines
35 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.Tween 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
|
|
 <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 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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_tween.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </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="#nested-classes">Classes</a> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#properties">Properties</a> |
|
|
<a href="class_otter_1_1_tween-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Otter.Tween Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween_1_1_tweener_impl.html">TweenerImpl</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a5fa1a108aef4a73324abf1f77498f768"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>RotationUnit</b> { <b>Degrees</b>,
|
|
<b>Radians</b>
|
|
}</td></tr>
|
|
<tr class="separator:a5fa1a108aef4a73324abf1f77498f768"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:ab477840bcb01765479529790b0f122fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#ab477840bcb01765479529790b0f122fa">From</a> (object values)</td></tr>
|
|
<tr class="memdesc:ab477840bcb01765479529790b0f122fa"><td class="mdescLeft"> </td><td class="mdescRight">Apply target values to a starting point before tweening. <a href="#ab477840bcb01765479529790b0f122fa">More...</a><br/></td></tr>
|
|
<tr class="separator:ab477840bcb01765479529790b0f122fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad193d7a0ff8105a48e6ab915850ad1d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#ad193d7a0ff8105a48e6ab915850ad1d6">Ease</a> (Func< float, float > ease)</td></tr>
|
|
<tr class="memdesc:ad193d7a0ff8105a48e6ab915850ad1d6"><td class="mdescLeft"> </td><td class="mdescRight">Set the easing function. <a href="#ad193d7a0ff8105a48e6ab915850ad1d6">More...</a><br/></td></tr>
|
|
<tr class="separator:ad193d7a0ff8105a48e6ab915850ad1d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86f3c6a27cb2fb10f399c68ded5ea127"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a86f3c6a27cb2fb10f399c68ded5ea127">OnBegin</a> (Action callback)</td></tr>
|
|
<tr class="memdesc:a86f3c6a27cb2fb10f399c68ded5ea127"><td class="mdescLeft"> </td><td class="mdescRight">Set a function to call when the tween begins (useful when using delays). Can be called multiple times for compound callbacks. <a href="#a86f3c6a27cb2fb10f399c68ded5ea127">More...</a><br/></td></tr>
|
|
<tr class="separator:a86f3c6a27cb2fb10f399c68ded5ea127"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d390f9b46fe97749691577687e2d398"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a2d390f9b46fe97749691577687e2d398">OnComplete</a> (Action callback)</td></tr>
|
|
<tr class="memdesc:a2d390f9b46fe97749691577687e2d398"><td class="mdescLeft"> </td><td class="mdescRight">Set a function to call when the tween finishes. Can be called multiple times for compound callbacks. If the tween repeats infinitely, this will be called each time; otherwise it will only run when the tween is finished repeating. <a href="#a2d390f9b46fe97749691577687e2d398">More...</a><br/></td></tr>
|
|
<tr class="separator:a2d390f9b46fe97749691577687e2d398"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0c88d6ecb2f070f1f7274a65d367ccf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#ae0c88d6ecb2f070f1f7274a65d367ccf">OnUpdate</a> (Action callback)</td></tr>
|
|
<tr class="memdesc:ae0c88d6ecb2f070f1f7274a65d367ccf"><td class="mdescLeft"> </td><td class="mdescRight">Set a function to call as the tween updates. Can be called multiple times for compound callbacks. <a href="#ae0c88d6ecb2f070f1f7274a65d367ccf">More...</a><br/></td></tr>
|
|
<tr class="separator:ae0c88d6ecb2f070f1f7274a65d367ccf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0408020e06d640a1b48503adc9fd4e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#ae0408020e06d640a1b48503adc9fd4e4">Repeat</a> (int times=-1)</td></tr>
|
|
<tr class="memdesc:ae0408020e06d640a1b48503adc9fd4e4"><td class="mdescLeft"> </td><td class="mdescRight">Enable repeating. <a href="#ae0408020e06d640a1b48503adc9fd4e4">More...</a><br/></td></tr>
|
|
<tr class="separator:ae0408020e06d640a1b48503adc9fd4e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a517406efd8c77949ce38b61a9167459b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a517406efd8c77949ce38b61a9167459b">RepeatDelay</a> (float delay)</td></tr>
|
|
<tr class="memdesc:a517406efd8c77949ce38b61a9167459b"><td class="mdescLeft"> </td><td class="mdescRight">Set a delay for when the tween repeats. <a href="#a517406efd8c77949ce38b61a9167459b">More...</a><br/></td></tr>
|
|
<tr class="separator:a517406efd8c77949ce38b61a9167459b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a509766db24e7792a4d186601d8b227a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a509766db24e7792a4d186601d8b227a1">Reflect</a> ()</td></tr>
|
|
<tr class="memdesc:a509766db24e7792a4d186601d8b227a1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the tween to reverse every other time it repeats. Repeating must be enabled for this to have any effect. <a href="#a509766db24e7792a4d186601d8b227a1">More...</a><br/></td></tr>
|
|
<tr class="separator:a509766db24e7792a4d186601d8b227a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19e042cd019b571dac811a0b8f42c6f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a19e042cd019b571dac811a0b8f42c6f2">Reverse</a> ()</td></tr>
|
|
<tr class="memdesc:a19e042cd019b571dac811a0b8f42c6f2"><td class="mdescLeft"> </td><td class="mdescRight">Swaps the start and end values of the tween. <a href="#a19e042cd019b571dac811a0b8f42c6f2">More...</a><br/></td></tr>
|
|
<tr class="separator:a19e042cd019b571dac811a0b8f42c6f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a727e7e1044b480edd7361380f0a9ad32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a727e7e1044b480edd7361380f0a9ad32">Rotation</a> (RotationUnit unit=RotationUnit.Degrees)</td></tr>
|
|
<tr class="memdesc:a727e7e1044b480edd7361380f0a9ad32"><td class="mdescLeft"> </td><td class="mdescRight">Whether this tween handles rotation. <a href="#a727e7e1044b480edd7361380f0a9ad32">More...</a><br/></td></tr>
|
|
<tr class="separator:a727e7e1044b480edd7361380f0a9ad32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5738c67c7b00ec6055a93d4138676990"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_tween.html">Tween</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a5738c67c7b00ec6055a93d4138676990">Round</a> ()</td></tr>
|
|
<tr class="memdesc:a5738c67c7b00ec6055a93d4138676990"><td class="mdescLeft"> </td><td class="mdescRight">Whether tweened values should be rounded to integer values. <a href="#a5738c67c7b00ec6055a93d4138676990">More...</a><br/></td></tr>
|
|
<tr class="separator:a5738c67c7b00ec6055a93d4138676990"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0287921b1272c4313fd7f42b45311c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#ad0287921b1272c4313fd7f42b45311c3">Cancel</a> (params string[] properties)</td></tr>
|
|
<tr class="memdesc:ad0287921b1272c4313fd7f42b45311c3"><td class="mdescLeft"> </td><td class="mdescRight">Cancel tweening given properties. <a href="#ad0287921b1272c4313fd7f42b45311c3">More...</a><br/></td></tr>
|
|
<tr class="separator:ad0287921b1272c4313fd7f42b45311c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd1327114dc8bc734b665ac931aa0ea1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#acd1327114dc8bc734b665ac931aa0ea1">Cancel</a> ()</td></tr>
|
|
<tr class="memdesc:acd1327114dc8bc734b665ac931aa0ea1"><td class="mdescLeft"> </td><td class="mdescRight">Remove tweens from the tweener without calling their complete functions. <a href="#acd1327114dc8bc734b665ac931aa0ea1">More...</a><br/></td></tr>
|
|
<tr class="separator:acd1327114dc8bc734b665ac931aa0ea1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e9b6da266d6f70af381f9b92fa805d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a1e9b6da266d6f70af381f9b92fa805d6">CancelAndComplete</a> ()</td></tr>
|
|
<tr class="memdesc:a1e9b6da266d6f70af381f9b92fa805d6"><td class="mdescLeft"> </td><td class="mdescRight">Assign tweens their final value and remove them from the tweener. <a href="#a1e9b6da266d6f70af381f9b92fa805d6">More...</a><br/></td></tr>
|
|
<tr class="separator:a1e9b6da266d6f70af381f9b92fa805d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad99a7e1b353eac6a0c173b8cd0a4fd3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#ad99a7e1b353eac6a0c173b8cd0a4fd3c">Pause</a> ()</td></tr>
|
|
<tr class="memdesc:ad99a7e1b353eac6a0c173b8cd0a4fd3c"><td class="mdescLeft"> </td><td class="mdescRight">Set tweens to pause. They won't update and their delays won't tick down. <a href="#ad99a7e1b353eac6a0c173b8cd0a4fd3c">More...</a><br/></td></tr>
|
|
<tr class="separator:ad99a7e1b353eac6a0c173b8cd0a4fd3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c3298778b0b9a34635b26ecff5c1122"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a3c3298778b0b9a34635b26ecff5c1122">PauseToggle</a> ()</td></tr>
|
|
<tr class="memdesc:a3c3298778b0b9a34635b26ecff5c1122"><td class="mdescLeft"> </td><td class="mdescRight">Toggle tweens' paused value. <a href="#a3c3298778b0b9a34635b26ecff5c1122">More...</a><br/></td></tr>
|
|
<tr class="separator:a3c3298778b0b9a34635b26ecff5c1122"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af64ba7c5b7230ba3693cf13e6f616c32"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#af64ba7c5b7230ba3693cf13e6f616c32">Resume</a> ()</td></tr>
|
|
<tr class="memdesc:af64ba7c5b7230ba3693cf13e6f616c32"><td class="mdescLeft"> </td><td class="mdescRight">Resumes tweens from a paused state. <a href="#af64ba7c5b7230ba3693cf13e6f616c32">More...</a><br/></td></tr>
|
|
<tr class="separator:af64ba7c5b7230ba3693cf13e6f616c32"><td class="memSeparator" colspan="2"> </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:a7358ee01666f7fed87a95dd6d2b903db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7358ee01666f7fed87a95dd6d2b903db"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>Paused</b><code> [get, set]</code></td></tr>
|
|
<tr class="separator:a7358ee01666f7fed87a95dd6d2b903db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b1af86ce4b707829b1689dc519a3e03"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a1b1af86ce4b707829b1689dc519a3e03">TimeRemaining</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:a1b1af86ce4b707829b1689dc519a3e03"><td class="mdescLeft"> </td><td class="mdescRight">The time remaining before the tween ends or repeats. <a href="#a1b1af86ce4b707829b1689dc519a3e03">More...</a><br/></td></tr>
|
|
<tr class="separator:a1b1af86ce4b707829b1689dc519a3e03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa08bd9dc0c712932601c4acb869342ba"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#aa08bd9dc0c712932601c4acb869342ba">Completion</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:aa08bd9dc0c712932601c4acb869342ba"><td class="mdescLeft"> </td><td class="mdescRight">A value between 0 and 1, where 0 means the tween has not been started and 1 means that it has completed. <a href="#aa08bd9dc0c712932601c4acb869342ba">More...</a><br/></td></tr>
|
|
<tr class="separator:aa08bd9dc0c712932601c4acb869342ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3e10984a9073956198519e88546a436"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#ac3e10984a9073956198519e88546a436">Looping</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:ac3e10984a9073956198519e88546a436"><td class="mdescLeft"> </td><td class="mdescRight">Whether the tween is currently looping. <a href="#ac3e10984a9073956198519e88546a436">More...</a><br/></td></tr>
|
|
<tr class="separator:ac3e10984a9073956198519e88546a436"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4cc12bce32511853421678b510163f2a"><td class="memItemLeft" align="right" valign="top">object </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_tween.html#a4cc12bce32511853421678b510163f2a">Target</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:a4cc12bce32511853421678b510163f2a"><td class="mdescLeft"> </td><td class="mdescRight">The object this tween targets. Will be null if the tween represents a timer. <a href="#a4cc12bce32511853421678b510163f2a">More...</a><br/></td></tr>
|
|
<tr class="separator:a4cc12bce32511853421678b510163f2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ad0287921b1272c4313fd7f42b45311c3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Tween.Cancel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">params string[] </td>
|
|
<td class="paramname"><em>properties</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Cancel tweening given properties. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">properties</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acd1327114dc8bc734b665ac931aa0ea1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Tween.Cancel </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove tweens from the tweener without calling their complete functions. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1e9b6da266d6f70af381f9b92fa805d6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Tween.CancelAndComplete </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assign tweens their final value and remove them from the tweener. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad193d7a0ff8105a48e6ab915850ad1d6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.Ease </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Func< float, float > </td>
|
|
<td class="paramname"><em>ease</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the easing function. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ease</td><td>The Easer to use.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab477840bcb01765479529790b0f122fa"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.From </td>
|
|
<td>(</td>
|
|
<td class="paramtype">object </td>
|
|
<td class="paramname"><em>values</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Apply target values to a starting point before tweening. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">values</td><td>The values to apply, in an anonymous type ( new { prop1 = 100, prop2 = 0} ).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a86f3c6a27cb2fb10f399c68ded5ea127"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.OnBegin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Action </td>
|
|
<td class="paramname"><em>callback</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a function to call when the tween begins (useful when using delays). Can be called multiple times for compound callbacks. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">callback</td><td>The function that will be called when the tween starts, after the delay.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2d390f9b46fe97749691577687e2d398"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.OnComplete </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Action </td>
|
|
<td class="paramname"><em>callback</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a function to call when the tween finishes. Can be called multiple times for compound callbacks. If the tween repeats infinitely, this will be called each time; otherwise it will only run when the tween is finished repeating. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">callback</td><td>The function that will be called on tween completion.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae0c88d6ecb2f070f1f7274a65d367ccf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.OnUpdate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Action </td>
|
|
<td class="paramname"><em>callback</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a function to call as the tween updates. Can be called multiple times for compound callbacks. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">callback</td><td>The function to use.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad99a7e1b353eac6a0c173b8cd0a4fd3c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Tween.Pause </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set tweens to pause. They won't update and their delays won't tick down. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3c3298778b0b9a34635b26ecff5c1122"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Tween.PauseToggle </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Toggle tweens' paused value. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a509766db24e7792a4d186601d8b227a1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.Reflect </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the tween to reverse every other time it repeats. Repeating must be enabled for this to have any effect. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae0408020e06d640a1b48503adc9fd4e4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.Repeat </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>times</em> = <code>-1</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable repeating. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">times</td><td>Number of times to repeat. Leave blank or pass a negative number to repeat infinitely.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a517406efd8c77949ce38b61a9167459b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.RepeatDelay </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>delay</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a delay for when the tween repeats. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">delay</td><td>How long to wait before repeating.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af64ba7c5b7230ba3693cf13e6f616c32"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Tween.Resume </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resumes tweens from a paused state. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a19e042cd019b571dac811a0b8f42c6f2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.Reverse </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Swaps the start and end values of the tween. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a727e7e1044b480edd7361380f0a9ad32"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.Rotation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">RotationUnit </td>
|
|
<td class="paramname"><em>unit</em> = <code>RotationUnit.Degrees</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Whether this tween handles rotation. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5738c67c7b00ec6055a93d4138676990"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_tween.html">Tween</a> Otter.Tween.Round </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Whether tweened values should be rounded to integer values. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to this.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Property Documentation</h2>
|
|
<a class="anchor" id="aa08bd9dc0c712932601c4acb869342ba"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Otter.Tween.Completion</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>A value between 0 and 1, where 0 means the tween has not been started and 1 means that it has completed. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac3e10984a9073956198519e88546a436"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Otter.Tween.Looping</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>Whether the tween is currently looping. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4cc12bce32511853421678b510163f2a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">object Otter.Tween.Target</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 object this tween targets. Will be null if the tween represents a timer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1b1af86ce4b707829b1689dc519a3e03"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Otter.Tween.TimeRemaining</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 time remaining before the tween ends or repeats. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>Otter/Utility/Glide/Tween.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_tween.html">Tween</a></li>
|
|
<li class="footer">Generated on Thu May 12 2016 18:16:53 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>
|