Alex
/
OtterPlayGround
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
main
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ceafb5d381'
${ noResults }
OtterPlayGround/Docs/class_otter_1_1_speed.html

583 lines
28 KiB
HTML
Raw Normal View History Unescape Escape

Initial Commit für Otter2D Framework
2 years ago
<!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.Speed 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_speed.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-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_otter_1_1_speed-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Otter.Speed Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class used for tracking an X and Y speed of an object. <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> also has an XMax and YMax that can be used to clamp the X and Y values automatically.
<a href="class_otter_1_1_speed.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:a2cd792963722f405ab64023c90d4cb24"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a2cd792963722f405ab64023c90d4cb24">Speed</a> (float x, float y, float maxX, float maxY, bool hardClamp)</td></tr>
<tr class="memdesc:a2cd792963722f405ab64023c90d4cb24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. <a href="#a2cd792963722f405ab64023c90d4cb24">More...</a><br/></td></tr>
<tr class="separator:a2cd792963722f405ab64023c90d4cb24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61910bf513d770e2e919602ffcd17614"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a61910bf513d770e2e919602ffcd17614">Speed</a> (float x, float y, float maxX, float maxY)</td></tr>
<tr class="memdesc:a61910bf513d770e2e919602ffcd17614"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. <a href="#a61910bf513d770e2e919602ffcd17614">More...</a><br/></td></tr>
<tr class="separator:a61910bf513d770e2e919602ffcd17614"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cf96b0d3510aa609ce0d7cdeb7898c1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a9cf96b0d3510aa609ce0d7cdeb7898c1">Speed</a> (float maxX, float maxY)</td></tr>
<tr class="memdesc:a9cf96b0d3510aa609ce0d7cdeb7898c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. <a href="#a9cf96b0d3510aa609ce0d7cdeb7898c1">More...</a><br/></td></tr>
<tr class="separator:a9cf96b0d3510aa609ce0d7cdeb7898c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73eb1fa0d578333d64b403d50f36e039"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a73eb1fa0d578333d64b403d50f36e039">Speed</a> (float maxX, float maxY, bool hardClamp)</td></tr>
<tr class="memdesc:a73eb1fa0d578333d64b403d50f36e039"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. <a href="#a73eb1fa0d578333d64b403d50f36e039">More...</a><br/></td></tr>
<tr class="separator:a73eb1fa0d578333d64b403d50f36e039"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab509278277bba66622fbce40380ee9e9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#ab509278277bba66622fbce40380ee9e9">Speed</a> (float max, bool hardClamp)</td></tr>
<tr class="memdesc:ab509278277bba66622fbce40380ee9e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. <a href="#ab509278277bba66622fbce40380ee9e9">More...</a><br/></td></tr>
<tr class="separator:ab509278277bba66622fbce40380ee9e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5816c2417edb30aab7db52c28485a496"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a5816c2417edb30aab7db52c28485a496">Speed</a> (float max)</td></tr>
<tr class="memdesc:a5816c2417edb30aab7db52c28485a496"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. <a href="#a5816c2417edb30aab7db52c28485a496">More...</a><br/></td></tr>
<tr class="separator:a5816c2417edb30aab7db52c28485a496"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93fc83f34f3ad103d19fa20c02399441"><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a93fc83f34f3ad103d19fa20c02399441">ToString</a> ()</td></tr>
<tr class="memdesc:a93fc83f34f3ad103d19fa20c02399441"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a String that represents this instance. <a href="#a93fc83f34f3ad103d19fa20c02399441">More...</a><br/></td></tr>
<tr class="separator:a93fc83f34f3ad103d19fa20c02399441"><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:a1f99949e464d5dc2ba5223be8e6ba454"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a1f99949e464d5dc2ba5223be8e6ba454">MaxX</a></td></tr>
<tr class="memdesc:a1f99949e464d5dc2ba5223be8e6ba454"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum X speed. <a href="#a1f99949e464d5dc2ba5223be8e6ba454">More...</a><br/></td></tr>
<tr class="separator:a1f99949e464d5dc2ba5223be8e6ba454"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cffae81a68cfc4aa43061d4969abb82"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a2cffae81a68cfc4aa43061d4969abb82">MaxY</a></td></tr>
<tr class="memdesc:a2cffae81a68cfc4aa43061d4969abb82"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum Y speed. <a href="#a2cffae81a68cfc4aa43061d4969abb82">More...</a><br/></td></tr>
<tr class="separator:a2cffae81a68cfc4aa43061d4969abb82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0907ae2680f643586d6cc62ed1d06cc7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a0907ae2680f643586d6cc62ed1d06cc7">HardClamp</a></td></tr>
<tr class="memdesc:a0907ae2680f643586d6cc62ed1d06cc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the maximum values will be hard clamped. If true, values will never exceed the maximums. <a href="#a0907ae2680f643586d6cc62ed1d06cc7">More...</a><br/></td></tr>
<tr class="separator:a0907ae2680f643586d6cc62ed1d06cc7"><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:a1359847d888abd7f263d836aec52b6a9"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a1359847d888abd7f263d836aec52b6a9">X</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a1359847d888abd7f263d836aec52b6a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current X value of the speed. <a href="#a1359847d888abd7f263d836aec52b6a9">More...</a><br/></td></tr>
<tr class="separator:a1359847d888abd7f263d836aec52b6a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43bdb435938b4bd61cfbe363c1b1023b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a43bdb435938b4bd61cfbe363c1b1023b">Y</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a43bdb435938b4bd61cfbe363c1b1023b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current Y value of the speed. <a href="#a43bdb435938b4bd61cfbe363c1b1023b">More...</a><br/></td></tr>
<tr class="separator:a43bdb435938b4bd61cfbe363c1b1023b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c211d0ccc23b830eed0f4d060920f66"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a1c211d0ccc23b830eed0f4d060920f66">Max</a><code> [set]</code></td></tr>
<tr class="memdesc:a1c211d0ccc23b830eed0f4d060920f66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shortcut to set both MaxX and MaxY. <a href="#a1c211d0ccc23b830eed0f4d060920f66">More...</a><br/></td></tr>
<tr class="separator:a1c211d0ccc23b830eed0f4d060920f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04bdb6af654ba6be8f09e32412e8b7f7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_speed.html#a04bdb6af654ba6be8f09e32412e8b7f7">Length</a><code> [get]</code></td></tr>
<tr class="memdesc:a04bdb6af654ba6be8f09e32412e8b7f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The length of the speed object. <a href="#a04bdb6af654ba6be8f09e32412e8b7f7">More...</a><br/></td></tr>
<tr class="separator:a04bdb6af654ba6be8f09e32412e8b7f7"><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 tracking an X and Y speed of an object. <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> also has an XMax and YMax that can be used to clamp the X and Y values automatically. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2cd792963722f405ab64023c90d4cb24"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Speed.Speed </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>hardClamp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The initial X value.</td></tr>
<tr><td class="paramname">y</td><td>The initial Y value.</td></tr>
<tr><td class="paramname">maxX</td><td>The maximum X value.</td></tr>
<tr><td class="paramname">maxY</td><td>The maximum Y value.</td></tr>
<tr><td class="paramname">hardClamp</td><td>Determines if the value can exceed the maximum.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a61910bf513d770e2e919602ffcd17614"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Speed.Speed </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxY</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>The initial X value.</td></tr>
<tr><td class="paramname">y</td><td>The initial Y value.</td></tr>
<tr><td class="paramname">maxX</td><td>The maximum X value.</td></tr>
<tr><td class="paramname">maxY</td><td>The maximum Y value.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9cf96b0d3510aa609ce0d7cdeb7898c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Speed.Speed </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxY</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxX</td><td>The maximum X value.</td></tr>
<tr><td class="paramname">maxY</td><td>The maximum Y value.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a73eb1fa0d578333d64b403d50f36e039"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Speed.Speed </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>hardClamp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxX</td><td>The maximum X value.</td></tr>
<tr><td class="paramname">maxY</td><td>The maximum Y value.</td></tr>
<tr><td class="paramname">hardClamp</td><td>Determines if the value can exceed the maximum.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab509278277bba66622fbce40380ee9e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Speed.Speed </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>hardClamp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">max</td><td>The maximum X and Y values.</td></tr>
<tr><td class="paramname">hardClamp</td><td>Determines if the value can exceed the maximum.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5816c2417edb30aab7db52c28485a496"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Otter.Speed.Speed </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>max</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="class_otter_1_1_speed.html" title="Class used for tracking an X and Y speed of an object. Speed also has an XMax and YMax that can be us...">Speed</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">max</td><td>The maximum X and Y values.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a93fc83f34f3ad103d19fa20c02399441"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override string Otter.Speed.ToString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a String that represents this instance. </p>
<dl class="section return"><dt>Returns</dt><dd>A String that represents this instance. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a0907ae2680f643586d6cc62ed1d06cc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Otter.Speed.HardClamp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if the maximum values will be hard clamped. If true, values will never exceed the maximums. </p>
</div>
</div>
<a class="anchor" id="a1f99949e464d5dc2ba5223be8e6ba454"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Otter.Speed.MaxX</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum X speed. </p>
</div>
</div>
<a class="anchor" id="a2cffae81a68cfc4aa43061d4969abb82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Otter.Speed.MaxY</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum Y speed. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a04bdb6af654ba6be8f09e32412e8b7f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Otter.Speed.Length</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 length of the speed object. </p>
</div>
</div>
<a class="anchor" id="a1c211d0ccc23b830eed0f4d060920f66"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Otter.Speed.Max</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shortcut to set both MaxX and MaxY. </p>
</div>
</div>
<a class="anchor" id="a1359847d888abd7f263d836aec52b6a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Otter.Speed.X</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 X value of the speed. </p>
</div>
</div>
<a class="anchor" id="a43bdb435938b4bd61cfbe363c1b1023b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Otter.Speed.Y</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 Y value of the speed. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Otter/Utility/Speed.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_speed.html">Speed</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>