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.
1352 lines
95 KiB
HTML
1352 lines
95 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.Axis 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_axis.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="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#properties">Properties</a> |
|
|
<a href="class_otter_1_1_axis-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Otter.Axis Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple sources of input like keyboard, mouse buttons, or joystick axes and buttons. <a class="el" href="class_otter_1_1_input.html" title="Class used for managing input from the keyboard, mouse, and joysticks. Updated by the active Game...">Input</a> can also be delivered from code.
|
|
<a href="class_otter_1_1_axis.html#details">More...</a></p>
|
|
|
|
<p>Inherits <a class="el" href="class_otter_1_1_component.html">Otter.Component</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:af9860dedcda3c40c56fd49e0a531b5ab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#af9860dedcda3c40c56fd49e0a531b5ab">Axis</a> ()</td></tr>
|
|
<tr class="memdesc:af9860dedcda3c40c56fd49e0a531b5ab"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. <a href="#af9860dedcda3c40c56fd49e0a531b5ab">More...</a><br/></td></tr>
|
|
<tr class="separator:af9860dedcda3c40c56fd49e0a531b5ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a141d32c0af98a61df2e3cc1cbf418616"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a141d32c0af98a61df2e3cc1cbf418616">Axis</a> (<a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> up, <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> right, <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> down, <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> left)</td></tr>
|
|
<tr class="memdesc:a141d32c0af98a61df2e3cc1cbf418616"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> using Keys. <a href="#a141d32c0af98a61df2e3cc1cbf418616">More...</a><br/></td></tr>
|
|
<tr class="separator:a141d32c0af98a61df2e3cc1cbf418616"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a653cc846742da53a35870c598b786316"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a653cc846742da53a35870c598b786316">Axis</a> (<a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> x, <a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> y, params int[] joystick)</td></tr>
|
|
<tr class="memdesc:a653cc846742da53a35870c598b786316"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> using a joystick axis. <a href="#a653cc846742da53a35870c598b786316">More...</a><br/></td></tr>
|
|
<tr class="separator:a653cc846742da53a35870c598b786316"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4253d849dc8b802bed694e8cb512f70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#aa4253d849dc8b802bed694e8cb512f70">Axis</a> (<a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> up, <a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> right, <a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> down, <a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> left, params int[] joystick)</td></tr>
|
|
<tr class="memdesc:aa4253d849dc8b802bed694e8cb512f70"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> using AxisButtons. <a href="#aa4253d849dc8b802bed694e8cb512f70">More...</a><br/></td></tr>
|
|
<tr class="separator:aa4253d849dc8b802bed694e8cb512f70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29dfbe84eff4a99c8b0da552a66215bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a29dfbe84eff4a99c8b0da552a66215bb">Reset</a> ()</td></tr>
|
|
<tr class="memdesc:a29dfbe84eff4a99c8b0da552a66215bb"><td class="mdescLeft"> </td><td class="mdescRight">Reset the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> to report no input. <a href="#a29dfbe84eff4a99c8b0da552a66215bb">More...</a><br/></td></tr>
|
|
<tr class="separator:a29dfbe84eff4a99c8b0da552a66215bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8fdbb5aa70a516061933bbbddf2776b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#ad8fdbb5aa70a516061933bbbddf2776b">Clear</a> ()</td></tr>
|
|
<tr class="memdesc:ad8fdbb5aa70a516061933bbbddf2776b"><td class="mdescLeft"> </td><td class="mdescRight">Clear all registered inputs for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. <a href="#ad8fdbb5aa70a516061933bbbddf2776b">More...</a><br/></td></tr>
|
|
<tr class="separator:ad8fdbb5aa70a516061933bbbddf2776b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adae9736eff17721213ef9843ac72da24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#adae9736eff17721213ef9843ac72da24">AddJoyAxis</a> (<a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> x, <a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> y, params int[] joystick)</td></tr>
|
|
<tr class="memdesc:adae9736eff17721213ef9843ac72da24"><td class="mdescLeft"> </td><td class="mdescRight">Add a joystick axis. <a href="#adae9736eff17721213ef9843ac72da24">More...</a><br/></td></tr>
|
|
<tr class="separator:adae9736eff17721213ef9843ac72da24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5b5efc54a377f7c272cec4ac3d60c0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#ab5b5efc54a377f7c272cec4ac3d60c0c">AddAxis</a> (<a class="el" href="class_otter_1_1_axis.html">Axis</a> source)</td></tr>
|
|
<tr class="memdesc:ab5b5efc54a377f7c272cec4ac3d60c0c"><td class="mdescLeft"> </td><td class="mdescRight">Add another <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> to this <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. <a href="#ab5b5efc54a377f7c272cec4ac3d60c0c">More...</a><br/></td></tr>
|
|
<tr class="separator:ab5b5efc54a377f7c272cec4ac3d60c0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aede0d61dd037d6cba7067e0f7d5bfc02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#aede0d61dd037d6cba7067e0f7d5bfc02">AddButton</a> (int button, <a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a> direction, params int[] joystick)</td></tr>
|
|
<tr class="memdesc:aede0d61dd037d6cba7067e0f7d5bfc02"><td class="mdescLeft"> </td><td class="mdescRight">Add a joystick button. <a href="#aede0d61dd037d6cba7067e0f7d5bfc02">More...</a><br/></td></tr>
|
|
<tr class="separator:aede0d61dd037d6cba7067e0f7d5bfc02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcceb76ce921658f8e6ef49d1b4a1833"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#abcceb76ce921658f8e6ef49d1b4a1833">AddButton</a> (<a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> button, <a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a> direction, params int[] joystick)</td></tr>
|
|
<tr class="memdesc:abcceb76ce921658f8e6ef49d1b4a1833"><td class="mdescLeft"> </td><td class="mdescRight">Add a joystick axis button. <a href="#abcceb76ce921658f8e6ef49d1b4a1833">More...</a><br/></td></tr>
|
|
<tr class="separator:abcceb76ce921658f8e6ef49d1b4a1833"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dba26c587fdfcae41d1b120a00cb5f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a3dba26c587fdfcae41d1b120a00cb5f5">AddKey</a> (<a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> key, <a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a> direction)</td></tr>
|
|
<tr class="memdesc:a3dba26c587fdfcae41d1b120a00cb5f5"><td class="mdescLeft"> </td><td class="mdescRight">Add a key. <a href="#a3dba26c587fdfcae41d1b120a00cb5f5">More...</a><br/></td></tr>
|
|
<tr class="separator:a3dba26c587fdfcae41d1b120a00cb5f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3c7823695cba9c1842361561650839e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#ac3c7823695cba9c1842361561650839e">AddKeys</a> (params <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>[] upRightDownLeft)</td></tr>
|
|
<tr class="memdesc:ac3c7823695cba9c1842361561650839e"><td class="mdescLeft"> </td><td class="mdescRight">Add keys. <a href="#ac3c7823695cba9c1842361561650839e">More...</a><br/></td></tr>
|
|
<tr class="separator:ac3c7823695cba9c1842361561650839e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5432ee7a3c43845e0ae6cf74efab0ff5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a5432ee7a3c43845e0ae6cf74efab0ff5">ForceState</a> (float x, float y)</td></tr>
|
|
<tr class="memdesc:a5432ee7a3c43845e0ae6cf74efab0ff5"><td class="mdescLeft"> </td><td class="mdescRight">Force the axis state. <a href="#a5432ee7a3c43845e0ae6cf74efab0ff5">More...</a><br/></td></tr>
|
|
<tr class="separator:a5432ee7a3c43845e0ae6cf74efab0ff5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adeebf15b7f4e1484a61deba96b331b13"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#adeebf15b7f4e1484a61deba96b331b13">ForceState</a> (<a class="el" href="struct_otter_1_1_vector2.html">Vector2</a> xy)</td></tr>
|
|
<tr class="memdesc:adeebf15b7f4e1484a61deba96b331b13"><td class="mdescLeft"> </td><td class="mdescRight">Force the axis state. <a href="#adeebf15b7f4e1484a61deba96b331b13">More...</a><br/></td></tr>
|
|
<tr class="separator:adeebf15b7f4e1484a61deba96b331b13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9a1e7ce22c9b5720466e4548864187c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#ad9a1e7ce22c9b5720466e4548864187c">ForceStateX</a> (float x)</td></tr>
|
|
<tr class="memdesc:ad9a1e7ce22c9b5720466e4548864187c"><td class="mdescLeft"> </td><td class="mdescRight">Force the axis x state. <a href="#ad9a1e7ce22c9b5720466e4548864187c">More...</a><br/></td></tr>
|
|
<tr class="separator:ad9a1e7ce22c9b5720466e4548864187c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41ca28b6a5dd015b5f57bca3b187ae2e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a41ca28b6a5dd015b5f57bca3b187ae2e">ForceStateY</a> (float y)</td></tr>
|
|
<tr class="memdesc:a41ca28b6a5dd015b5f57bca3b187ae2e"><td class="mdescLeft"> </td><td class="mdescRight">Force the axis y state. <a href="#a41ca28b6a5dd015b5f57bca3b187ae2e">More...</a><br/></td></tr>
|
|
<tr class="separator:a41ca28b6a5dd015b5f57bca3b187ae2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f465cfde8c115ec62c0b67f7ba3d64a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a5f465cfde8c115ec62c0b67f7ba3d64a">ReleaseState</a> ()</td></tr>
|
|
<tr class="memdesc:a5f465cfde8c115ec62c0b67f7ba3d64a"><td class="mdescLeft"> </td><td class="mdescRight">Relinquish control of the axis back to input. <a href="#a5f465cfde8c115ec62c0b67f7ba3d64a">More...</a><br/></td></tr>
|
|
<tr class="separator:a5f465cfde8c115ec62c0b67f7ba3d64a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a622bfd562c79591809642b828ded1a"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a2a622bfd562c79591809642b828ded1a">UpdateFirst</a> ()</td></tr>
|
|
<tr class="memdesc:a2a622bfd562c79591809642b828ded1a"><td class="mdescLeft"> </td><td class="mdescRight">Update the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. <a href="#a2a622bfd562c79591809642b828ded1a">More...</a><br/></td></tr>
|
|
<tr class="separator:a2a622bfd562c79591809642b828ded1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c2856787376c18c856a8fb23cd451ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c2856787376c18c856a8fb23cd451ae"></a>
|
|
override string </td><td class="memItemRight" valign="bottom"><b>ToString</b> ()</td></tr>
|
|
<tr class="separator:a6c2856787376c18c856a8fb23cd451ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_otter_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_otter_1_1_component')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_otter_1_1_component.html">Otter.Component</a></td></tr>
|
|
<tr class="memitem:a9614ef82f236ab6ed8c3cb9d7715e815 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a9614ef82f236ab6ed8c3cb9d7715e815">GetEntity< T ></a> ()</td></tr>
|
|
<tr class="memdesc:a9614ef82f236ab6ed8c3cb9d7715e815 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> as a specific Type. <a href="#a9614ef82f236ab6ed8c3cb9d7715e815">More...</a><br/></td></tr>
|
|
<tr class="separator:a9614ef82f236ab6ed8c3cb9d7715e815 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a896ba54fa65a3208621eaa06e23ac042 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a896ba54fa65a3208621eaa06e23ac042">Added</a> ()</td></tr>
|
|
<tr class="memdesc:a896ba54fa65a3208621eaa06e23ac042 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called when the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> is added to the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#a896ba54fa65a3208621eaa06e23ac042">More...</a><br/></td></tr>
|
|
<tr class="separator:a896ba54fa65a3208621eaa06e23ac042 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36bfe8aa7c9d8e9a71d0265ed3118e81 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a36bfe8aa7c9d8e9a71d0265ed3118e81">Removed</a> ()</td></tr>
|
|
<tr class="memdesc:a36bfe8aa7c9d8e9a71d0265ed3118e81 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called when the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> is removed from the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#a36bfe8aa7c9d8e9a71d0265ed3118e81">More...</a><br/></td></tr>
|
|
<tr class="separator:a36bfe8aa7c9d8e9a71d0265ed3118e81 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0ab335d5603e5f09268e360a0710d09 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ac0ab335d5603e5f09268e360a0710d09">RemoveSelf</a> ()</td></tr>
|
|
<tr class="memdesc:ac0ab335d5603e5f09268e360a0710d09 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Removes the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> from its parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#ac0ab335d5603e5f09268e360a0710d09">More...</a><br/></td></tr>
|
|
<tr class="separator:ac0ab335d5603e5f09268e360a0710d09 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae777aef927019fdb858e31de6cf79909 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ae777aef927019fdb858e31de6cf79909">Update</a> ()</td></tr>
|
|
<tr class="memdesc:ae777aef927019fdb858e31de6cf79909 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called during the Update on the parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#ae777aef927019fdb858e31de6cf79909">More...</a><br/></td></tr>
|
|
<tr class="separator:ae777aef927019fdb858e31de6cf79909 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2cbb5cdad72e0ea64e2f7516e025bb11 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a2cbb5cdad72e0ea64e2f7516e025bb11">Render</a> ()</td></tr>
|
|
<tr class="memdesc:a2cbb5cdad72e0ea64e2f7516e025bb11 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called during the Render on the parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#a2cbb5cdad72e0ea64e2f7516e025bb11">More...</a><br/></td></tr>
|
|
<tr class="separator:a2cbb5cdad72e0ea64e2f7516e025bb11 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7b18954fddd565ee9514cc2046b7cea inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#af7b18954fddd565ee9514cc2046b7cea">UpdateLast</a> ()</td></tr>
|
|
<tr class="memdesc:af7b18954fddd565ee9514cc2046b7cea inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Called during the UpdateLast on the parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#af7b18954fddd565ee9514cc2046b7cea">More...</a><br/></td></tr>
|
|
<tr class="separator:af7b18954fddd565ee9514cc2046b7cea inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bc7ea52a216ad05157e7ba5dec11672 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a5bc7ea52a216ad05157e7ba5dec11672">GetComponent< T ></a> ()</td></tr>
|
|
<tr class="memdesc:a5bc7ea52a216ad05157e7ba5dec11672 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Gets the first <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> of type T from this <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a>'s <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#a5bc7ea52a216ad05157e7ba5dec11672">More...</a><br/></td></tr>
|
|
<tr class="separator:a5bc7ea52a216ad05157e7ba5dec11672 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ee21d56d7c47862da8be5e52cefb529 inherit pub_methods_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a0ee21d56d7c47862da8be5e52cefb529">GetComponents< T ></a> ()</td></tr>
|
|
<tr class="memdesc:a0ee21d56d7c47862da8be5e52cefb529 inherit pub_methods_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Gets a list of Components of type T from this <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a>'s <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#a0ee21d56d7c47862da8be5e52cefb529">More...</a><br/></td></tr>
|
|
<tr class="separator:a0ee21d56d7c47862da8be5e52cefb529 inherit pub_methods_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </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:ac592ab8ffd94fb884a3f2d47778bd9d5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#ac592ab8ffd94fb884a3f2d47778bd9d5">CreateArrowKeys</a> ()</td></tr>
|
|
<tr class="memdesc:ac592ab8ffd94fb884a3f2d47778bd9d5"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> that uses the arrow keys for movement. <a href="#ac592ab8ffd94fb884a3f2d47778bd9d5">More...</a><br/></td></tr>
|
|
<tr class="separator:ac592ab8ffd94fb884a3f2d47778bd9d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3e67670bd91b48528951cd8e9ec77da"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_otter_1_1_axis.html">Axis</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#ae3e67670bd91b48528951cd8e9ec77da">CreateWASD</a> ()</td></tr>
|
|
<tr class="memdesc:ae3e67670bd91b48528951cd8e9ec77da"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> that uses WASD for movement. <a href="#ae3e67670bd91b48528951cd8e9ec77da">More...</a><br/></td></tr>
|
|
<tr class="separator:ae3e67670bd91b48528951cd8e9ec77da"><td class="memSeparator" colspan="2"> </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:a00862097597cf1e462f512c651942203"><td class="memItemLeft" align="right" valign="top">Dictionary< <a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a>, List<br class="typebreak"/>
|
|
< <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a00862097597cf1e462f512c651942203">Keys</a> = new Dictionary<<a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a>, List<<a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>>>()</td></tr>
|
|
<tr class="memdesc:a00862097597cf1e462f512c651942203"><td class="mdescLeft"> </td><td class="mdescRight">The Keys to uss. <a href="#a00862097597cf1e462f512c651942203">More...</a><br/></td></tr>
|
|
<tr class="separator:a00862097597cf1e462f512c651942203"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93b8428418d38d748866f67c969785e7"><td class="memItemLeft" align="right" valign="top">Dictionary< <a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a>, List<br class="typebreak"/>
|
|
< List< int > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a93b8428418d38d748866f67c969785e7">JoyButtons</a> = new Dictionary<<a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a>, List<List<int>>>()</td></tr>
|
|
<tr class="memdesc:a93b8428418d38d748866f67c969785e7"><td class="mdescLeft"> </td><td class="mdescRight">The joystick buttons to use. <a href="#a93b8428418d38d748866f67c969785e7">More...</a><br/></td></tr>
|
|
<tr class="separator:a93b8428418d38d748866f67c969785e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96fe7b418e001a16c27f2a56e25c2503"><td class="memItemLeft" align="right" valign="top">List< List< <a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a96fe7b418e001a16c27f2a56e25c2503">AxesX</a> = new List<List<<a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a>>>()</td></tr>
|
|
<tr class="memdesc:a96fe7b418e001a16c27f2a56e25c2503"><td class="mdescLeft"> </td><td class="mdescRight">The X axes to use. <a href="#a96fe7b418e001a16c27f2a56e25c2503">More...</a><br/></td></tr>
|
|
<tr class="separator:a96fe7b418e001a16c27f2a56e25c2503"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a875015e53d287483dee7eac00ea9aa96"><td class="memItemLeft" align="right" valign="top">List< List< <a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a875015e53d287483dee7eac00ea9aa96">AxesY</a> = new List<List<<a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a>>>()</td></tr>
|
|
<tr class="memdesc:a875015e53d287483dee7eac00ea9aa96"><td class="mdescLeft"> </td><td class="mdescRight">The Y axes to use. <a href="#a875015e53d287483dee7eac00ea9aa96">More...</a><br/></td></tr>
|
|
<tr class="separator:a875015e53d287483dee7eac00ea9aa96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8ca2761a1f5306ff0e9b7f591c97e2a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#af8ca2761a1f5306ff0e9b7f591c97e2a">Enabled</a> = true</td></tr>
|
|
<tr class="memdesc:af8ca2761a1f5306ff0e9b7f591c97e2a"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the axis is currently enabled. If false, X and Y will report 0. <a href="#af8ca2761a1f5306ff0e9b7f591c97e2a">More...</a><br/></td></tr>
|
|
<tr class="separator:af8ca2761a1f5306ff0e9b7f591c97e2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aceabfdd68de01e8c03b75a49c3c784cb"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#aceabfdd68de01e8c03b75a49c3c784cb">DeadZone</a> = 0.15f</td></tr>
|
|
<tr class="memdesc:aceabfdd68de01e8c03b75a49c3c784cb"><td class="mdescLeft"> </td><td class="mdescRight">The range that must be exceeded by joysticks in order for their input to register. <a href="#aceabfdd68de01e8c03b75a49c3c784cb">More...</a><br/></td></tr>
|
|
<tr class="separator:aceabfdd68de01e8c03b75a49c3c784cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b775e0c7af234a6c0cbd279f3fdb4ad"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a5b775e0c7af234a6c0cbd279f3fdb4ad">RemapRange</a> = true</td></tr>
|
|
<tr class="memdesc:a5b775e0c7af234a6c0cbd279f3fdb4ad"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the DeadZone will be treated as 0 for joysticks. If true, remaps the range DeadZone to 100 to 0 to 1. If false, remaps the range 0 to 100 to 0 to 1. <a href="#a5b775e0c7af234a6c0cbd279f3fdb4ad">More...</a><br/></td></tr>
|
|
<tr class="separator:a5b775e0c7af234a6c0cbd279f3fdb4ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a44527ca05f58b2dbd902d6db694eb631"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a44527ca05f58b2dbd902d6db694eb631">RoundInput</a> = true</td></tr>
|
|
<tr class="memdesc:a44527ca05f58b2dbd902d6db694eb631"><td class="mdescLeft"> </td><td class="mdescRight">Determines if raw data coming from the joysticks should be rounded to 2 digits. <a href="#a44527ca05f58b2dbd902d6db694eb631">More...</a><br/></td></tr>
|
|
<tr class="separator:a44527ca05f58b2dbd902d6db694eb631"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f11a806bb5b23ab514cf98f37067ddf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a3f11a806bb5b23ab514cf98f37067ddf">Locked</a> = false</td></tr>
|
|
<tr class="memdesc:a3f11a806bb5b23ab514cf98f37067ddf"><td class="mdescLeft"> </td><td class="mdescRight">Determines if input has any effect on the axis. When set to true the axis will remain at the X and Y it was at when locked. <a href="#a3f11a806bb5b23ab514cf98f37067ddf">More...</a><br/></td></tr>
|
|
<tr class="separator:a3f11a806bb5b23ab514cf98f37067ddf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_class_otter_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_otter_1_1_component')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_otter_1_1_component.html">Otter.Component</a></td></tr>
|
|
<tr class="memitem:a622eab27046de9233e421bf9e18824fe inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_entity.html">Entity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a622eab27046de9233e421bf9e18824fe">Entity</a></td></tr>
|
|
<tr class="memdesc:a622eab27046de9233e421bf9e18824fe inherit pub_attribs_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> of the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a>. <a href="#a622eab27046de9233e421bf9e18824fe">More...</a><br/></td></tr>
|
|
<tr class="separator:a622eab27046de9233e421bf9e18824fe inherit pub_attribs_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3503c833d8f7da07162182b3af743adb inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a3503c833d8f7da07162182b3af743adb">RenderAfterEntity</a> = true</td></tr>
|
|
<tr class="memdesc:a3503c833d8f7da07162182b3af743adb inherit pub_attribs_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> should render after the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> has rendered. <a href="#a3503c833d8f7da07162182b3af743adb">More...</a><br/></td></tr>
|
|
<tr class="separator:a3503c833d8f7da07162182b3af743adb inherit pub_attribs_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92cf7d2d7058c35ee879daf95728c390 inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a92cf7d2d7058c35ee879daf95728c390">Visible</a> = true</td></tr>
|
|
<tr class="memdesc:a92cf7d2d7058c35ee879daf95728c390 inherit pub_attribs_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">Determines if the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> will render. <a href="#a92cf7d2d7058c35ee879daf95728c390">More...</a><br/></td></tr>
|
|
<tr class="separator:a92cf7d2d7058c35ee879daf95728c390 inherit pub_attribs_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec8b7e96ceae938a19f99d6e38bd81a3 inherit pub_attribs_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#aec8b7e96ceae938a19f99d6e38bd81a3">Timer</a> = 0</td></tr>
|
|
<tr class="memdesc:aec8b7e96ceae938a19f99d6e38bd81a3 inherit pub_attribs_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">How long the <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> has been alive (added to an <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> and updated.) <a href="#aec8b7e96ceae938a19f99d6e38bd81a3">More...</a><br/></td></tr>
|
|
<tr class="separator:aec8b7e96ceae938a19f99d6e38bd81a3 inherit pub_attribs_class_otter_1_1_component"><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:a8c0a92a82621c8a4047e3666fdf14980"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_otter_1_1_vector2.html">Vector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a8c0a92a82621c8a4047e3666fdf14980">Position</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:a8c0a92a82621c8a4047e3666fdf14980"><td class="mdescLeft"> </td><td class="mdescRight">The current <a class="el" href="struct_otter_1_1_vector2.html" title="Struct for representing a Vector2. ">Vector2</a> position of the axis. <a href="#a8c0a92a82621c8a4047e3666fdf14980">More...</a><br/></td></tr>
|
|
<tr class="separator:a8c0a92a82621c8a4047e3666fdf14980"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17c71c41ca3a798a11d6875716914478"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a17c71c41ca3a798a11d6875716914478">X</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:a17c71c41ca3a798a11d6875716914478"><td class="mdescLeft"> </td><td class="mdescRight">The X position of the axis from -1 to 1. <a href="#a17c71c41ca3a798a11d6875716914478">More...</a><br/></td></tr>
|
|
<tr class="separator:a17c71c41ca3a798a11d6875716914478"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa73162aa1da0a45c57b9aa8a477a5f0f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#aa73162aa1da0a45c57b9aa8a477a5f0f">Y</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:aa73162aa1da0a45c57b9aa8a477a5f0f"><td class="mdescLeft"> </td><td class="mdescRight">The Y position of the axis from -1 to 1. <a href="#aa73162aa1da0a45c57b9aa8a477a5f0f">More...</a><br/></td></tr>
|
|
<tr class="separator:aa73162aa1da0a45c57b9aa8a477a5f0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba51e4ffbf32a7245b3ce6f82298d141"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#aba51e4ffbf32a7245b3ce6f82298d141">LastX</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:aba51e4ffbf32a7245b3ce6f82298d141"><td class="mdescLeft"> </td><td class="mdescRight">The previous X position of the axis. <a href="#aba51e4ffbf32a7245b3ce6f82298d141">More...</a><br/></td></tr>
|
|
<tr class="separator:aba51e4ffbf32a7245b3ce6f82298d141"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad098d6cc5f6ad83a211dedc7495d63b7"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#ad098d6cc5f6ad83a211dedc7495d63b7">LastY</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:ad098d6cc5f6ad83a211dedc7495d63b7"><td class="mdescLeft"> </td><td class="mdescRight">The previous Y position of the axis. <a href="#ad098d6cc5f6ad83a211dedc7495d63b7">More...</a><br/></td></tr>
|
|
<tr class="separator:ad098d6cc5f6ad83a211dedc7495d63b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58b7a11208837f6214d74ec07632cf40"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a58b7a11208837f6214d74ec07632cf40">ForcedInput</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:a58b7a11208837f6214d74ec07632cf40"><td class="mdescLeft"> </td><td class="mdescRight">Check if the axis is currently forced. <a href="#a58b7a11208837f6214d74ec07632cf40">More...</a><br/></td></tr>
|
|
<tr class="separator:a58b7a11208837f6214d74ec07632cf40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a334184f03251234b501c10d2142332"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a0a334184f03251234b501c10d2142332">Up</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:a0a334184f03251234b501c10d2142332"><td class="mdescLeft"> </td><td class="mdescRight">The the up <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. <a href="#a0a334184f03251234b501c10d2142332">More...</a><br/></td></tr>
|
|
<tr class="separator:a0a334184f03251234b501c10d2142332"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3d4280cfd17068494c61abcc97ce9bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#aa3d4280cfd17068494c61abcc97ce9bf">Left</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:aa3d4280cfd17068494c61abcc97ce9bf"><td class="mdescLeft"> </td><td class="mdescRight">The the left <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. <a href="#aa3d4280cfd17068494c61abcc97ce9bf">More...</a><br/></td></tr>
|
|
<tr class="separator:aa3d4280cfd17068494c61abcc97ce9bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1c695a34bb06b5892736bc179592733"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#af1c695a34bb06b5892736bc179592733">Down</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:af1c695a34bb06b5892736bc179592733"><td class="mdescLeft"> </td><td class="mdescRight">Gets the down <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. <a href="#af1c695a34bb06b5892736bc179592733">More...</a><br/></td></tr>
|
|
<tr class="separator:af1c695a34bb06b5892736bc179592733"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18616e9e8e7eee117bbec2b7582e877a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_button.html">Button</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a18616e9e8e7eee117bbec2b7582e877a">Right</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:a18616e9e8e7eee117bbec2b7582e877a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the right <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. <a href="#a18616e9e8e7eee117bbec2b7582e877a">More...</a><br/></td></tr>
|
|
<tr class="separator:a18616e9e8e7eee117bbec2b7582e877a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07fef8b812f60c12d4054e8afb13081a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a07fef8b812f60c12d4054e8afb13081a">HasInput</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:a07fef8b812f60c12d4054e8afb13081a"><td class="mdescLeft"> </td><td class="mdescRight">Check if the axis has any means of input currently registered to it. <a href="#a07fef8b812f60c12d4054e8afb13081a">More...</a><br/></td></tr>
|
|
<tr class="separator:a07fef8b812f60c12d4054e8afb13081a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d31e2007d46711c8d52c5926a58d284"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_axis.html#a6d31e2007d46711c8d52c5926a58d284">Neutral</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:a6d31e2007d46711c8d52c5926a58d284"><td class="mdescLeft"> </td><td class="mdescRight">Check of the axis is completely neutral. <a href="#a6d31e2007d46711c8d52c5926a58d284">More...</a><br/></td></tr>
|
|
<tr class="separator:a6d31e2007d46711c8d52c5926a58d284"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header properties_class_otter_1_1_component"><td colspan="2" onclick="javascript:toggleInherit('properties_class_otter_1_1_component')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_otter_1_1_component.html">Otter.Component</a></td></tr>
|
|
<tr class="memitem:ac0f8379345a3a41105d1f78413277edd inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ac0f8379345a3a41105d1f78413277edd">InstanceId</a><code> [get, set]</code></td></tr>
|
|
<tr class="memdesc:ac0f8379345a3a41105d1f78413277edd inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a>'s id for the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> its attached to. <a href="#ac0f8379345a3a41105d1f78413277edd">More...</a><br/></td></tr>
|
|
<tr class="separator:ac0f8379345a3a41105d1f78413277edd inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9b2b3b286b4e37001be95a0674b8285 inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_scene.html">Scene</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#af9b2b3b286b4e37001be95a0674b8285">Scene</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:af9b2b3b286b4e37001be95a0674b8285 inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> that the parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> is in. <a href="#af9b2b3b286b4e37001be95a0674b8285">More...</a><br/></td></tr>
|
|
<tr class="separator:af9b2b3b286b4e37001be95a0674b8285 inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c5894d2272d5dd4259d952fed3c4532 inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_collider.html">Collider</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#a5c5894d2272d5dd4259d952fed3c4532">Collider</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:a5c5894d2272d5dd4259d952fed3c4532 inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The first <a class="el" href="class_otter_1_1_collider.html" title="The base class used for collision detection. Entities contain Colliders that can check for collisions...">Collider</a> of the parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#a5c5894d2272d5dd4259d952fed3c4532">More...</a><br/></td></tr>
|
|
<tr class="separator:a5c5894d2272d5dd4259d952fed3c4532 inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1f59cc511b6b9b0ed8efd946dad6ba5 inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_graphic.html">Graphic</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ae1f59cc511b6b9b0ed8efd946dad6ba5">Graphic</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:ae1f59cc511b6b9b0ed8efd946dad6ba5 inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The first <a class="el" href="class_otter_1_1_graphic.html" title="Base abstract class used for anything that can be rendered. ">Graphic</a> of the parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#ae1f59cc511b6b9b0ed8efd946dad6ba5">More...</a><br/></td></tr>
|
|
<tr class="separator:ae1f59cc511b6b9b0ed8efd946dad6ba5 inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af59740c53a5d56085985232b6da1be3e inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List< <a class="el" href="class_otter_1_1_graphic.html">Graphic</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#af59740c53a5d56085985232b6da1be3e">Graphics</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:af59740c53a5d56085985232b6da1be3e inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The list of Graphics from the parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#af59740c53a5d56085985232b6da1be3e">More...</a><br/></td></tr>
|
|
<tr class="separator:af59740c53a5d56085985232b6da1be3e inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0905b7a81b660e8aa4b1c4eb3aa7abc inherit properties_class_otter_1_1_component"><td class="memItemLeft" align="right" valign="top">List< <a class="el" href="class_otter_1_1_collider.html">Collider</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_component.html#ab0905b7a81b660e8aa4b1c4eb3aa7abc">Colliders</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:ab0905b7a81b660e8aa4b1c4eb3aa7abc inherit properties_class_otter_1_1_component"><td class="mdescLeft"> </td><td class="mdescRight">The list of Colliders from the parent <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a>. <a href="#ab0905b7a81b660e8aa4b1c4eb3aa7abc">More...</a><br/></td></tr>
|
|
<tr class="separator:ab0905b7a81b660e8aa4b1c4eb3aa7abc inherit properties_class_otter_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="class_otter_1_1_component.html" title="Base Component class. Components can be added to Entities. ">Component</a> that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple sources of input like keyboard, mouse buttons, or joystick axes and buttons. <a class="el" href="class_otter_1_1_input.html" title="Class used for managing input from the keyboard, mouse, and joysticks. Updated by the active Game...">Input</a> can also be delivered from code. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="af9860dedcda3c40c56fd49e0a531b5ab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Otter.Axis.Axis </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a141d32c0af98a61df2e3cc1cbf418616"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Otter.Axis.Axis </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> </td>
|
|
<td class="paramname"><em>up</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> </td>
|
|
<td class="paramname"><em>right</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> </td>
|
|
<td class="paramname"><em>down</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> </td>
|
|
<td class="paramname"><em>left</em> </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_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> using Keys. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">up</td><td>The Key for Up.</td></tr>
|
|
<tr><td class="paramname">right</td><td>The Key for Right.</td></tr>
|
|
<tr><td class="paramname">down</td><td>The Key for Down.</td></tr>
|
|
<tr><td class="paramname">left</td><td>The Key for Left.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a653cc846742da53a35870c598b786316"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Otter.Axis.Axis </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">params int[] </td>
|
|
<td class="paramname"><em>joystick</em> </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_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> using a joystick axis. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>The JoyAxis to use for X.</td></tr>
|
|
<tr><td class="paramname">y</td><td>The JoyAxis to use for Y.</td></tr>
|
|
<tr><td class="paramname">joystick</td><td>The joystick id to use.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa4253d849dc8b802bed694e8cb512f70"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Otter.Axis.Axis </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> </td>
|
|
<td class="paramname"><em>up</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> </td>
|
|
<td class="paramname"><em>right</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> </td>
|
|
<td class="paramname"><em>down</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> </td>
|
|
<td class="paramname"><em>left</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">params int[] </td>
|
|
<td class="paramname"><em>joystick</em> </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_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> using AxisButtons. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">up</td><td>The AxisButton for Up.</td></tr>
|
|
<tr><td class="paramname">right</td><td>The AxisButton for Right.</td></tr>
|
|
<tr><td class="paramname">down</td><td>The AxisButton for Down.</td></tr>
|
|
<tr><td class="paramname">left</td><td>The AxisButton for Left.</td></tr>
|
|
<tr><td class="paramname">joystick</td><td>The joystick id to use.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ab5b5efc54a377f7c272cec4ac3d60c0c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_axis.html">Axis</a> Otter.Axis.AddAxis </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_otter_1_1_axis.html">Axis</a> </td>
|
|
<td class="paramname"><em>source</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add another <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> to this <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">source</td><td>The source <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> to use.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>This <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aede0d61dd037d6cba7067e0f7d5bfc02"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_axis.html">Axis</a> Otter.Axis.AddButton </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>button</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a> </td>
|
|
<td class="paramname"><em>direction</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">params int[] </td>
|
|
<td class="paramname"><em>joystick</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a joystick button. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">button</td><td>The joystick button id.</td></tr>
|
|
<tr><td class="paramname">direction</td><td>The direction this button should effect.</td></tr>
|
|
<tr><td class="paramname">joystick</td><td>The joystick id.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abcceb76ce921658f8e6ef49d1b4a1833"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_axis.html">Axis</a> Otter.Axis.AddButton </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ae50964d9170cd36fc2b2f3be91efdda0">AxisButton</a> </td>
|
|
<td class="paramname"><em>button</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a> </td>
|
|
<td class="paramname"><em>direction</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">params int[] </td>
|
|
<td class="paramname"><em>joystick</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a joystick axis button. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">button</td><td>The joystick axis button.</td></tr>
|
|
<tr><td class="paramname">direction</td><td>The direction this axis button should effect.</td></tr>
|
|
<tr><td class="paramname">joystick</td><td>The joystick id.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adae9736eff17721213ef9843ac72da24"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_axis.html">Axis</a> Otter.Axis.AddJoyAxis </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a> </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">params int[] </td>
|
|
<td class="paramname"><em>joystick</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a joystick axis. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>The x axis of the joystick.</td></tr>
|
|
<tr><td class="paramname">y</td><td>The y axis of the joystick.</td></tr>
|
|
<tr><td class="paramname">joystick</td><td>The joystick id.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3dba26c587fdfcae41d1b120a00cb5f5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_axis.html">Axis</a> Otter.Axis.AddKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a> </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a> </td>
|
|
<td class="paramname"><em>direction</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a key. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>The keyboard key.</td></tr>
|
|
<tr><td class="paramname">direction</td><td>The direction this key should effect.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac3c7823695cba9c1842361561650839e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_axis.html">Axis</a> Otter.Axis.AddKeys </td>
|
|
<td>(</td>
|
|
<td class="paramtype">params <a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>[] </td>
|
|
<td class="paramname"><em>upRightDownLeft</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add keys. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">upRightDownLeft</td><td>Four keys to create a pair of axes from (Up, Right, Down, Left).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad8fdbb5aa70a516061933bbbddf2776b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Axis.Clear </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear all registered inputs for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac592ab8ffd94fb884a3f2d47778bd9d5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="class_otter_1_1_axis.html">Axis</a> Otter.Axis.CreateArrowKeys </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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>Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> that uses the arrow keys for movement. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae3e67670bd91b48528951cd8e9ec77da"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="class_otter_1_1_axis.html">Axis</a> Otter.Axis.CreateWASD </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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>Create a new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> that uses WASD for movement. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5432ee7a3c43845e0ae6cf74efab0ff5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Axis.ForceState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Force the axis state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>The forced x state.</td></tr>
|
|
<tr><td class="paramname">y</td><td>The forced y state.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adeebf15b7f4e1484a61deba96b331b13"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Axis.ForceState </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_otter_1_1_vector2.html">Vector2</a> </td>
|
|
<td class="paramname"><em>xy</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Force the axis state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">xy</td><td>The forced x and y state.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad9a1e7ce22c9b5720466e4548864187c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Axis.ForceStateX </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>x</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Force the axis x state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>The forced x state.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a41ca28b6a5dd015b5f57bca3b187ae2e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Axis.ForceStateY </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>y</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Force the axis y state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">y</td><td>The forced y state.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5f465cfde8c115ec62c0b67f7ba3d64a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Axis.ReleaseState </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Relinquish control of the axis back to input. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a29dfbe84eff4a99c8b0da552a66215bb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Otter.Axis.Reset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reset the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a> to report no input. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2a622bfd562c79591809642b828ded1a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">override void Otter.Axis.UpdateFirst </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_otter_1_1_component.html#a44d89b80a8843ac6042dbfd4793a8df5">Otter.Component</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a96fe7b418e001a16c27f2a56e25c2503"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">List<List<<a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a>> > Otter.Axis.AxesX = new List<List<<a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a>>>()</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The X axes to use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a875015e53d287483dee7eac00ea9aa96"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">List<List<<a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a>> > Otter.Axis.AxesY = new List<List<<a class="el" href="namespace_otter.html#a0c52d8244f487375b4061dff5c24907e">JoyAxis</a>>>()</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The Y axes to use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aceabfdd68de01e8c03b75a49c3c784cb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Otter.Axis.DeadZone = 0.15f</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The range that must be exceeded by joysticks in order for their input to register. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af8ca2761a1f5306ff0e9b7f591c97e2a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Otter.Axis.Enabled = true</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines if the axis is currently enabled. If false, X and Y will report 0. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a93b8428418d38d748866f67c969785e7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Dictionary<<a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a>, List<List<int> > > Otter.Axis.JoyButtons = new Dictionary<<a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a>, List<List<int>>>()</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The joystick buttons to use. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a00862097597cf1e462f512c651942203"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Dictionary<<a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a>, List<<a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>> > Otter.Axis.Keys = new Dictionary<<a class="el" href="namespace_otter.html#a87339246dce4e8a3b721e7a58d84245b">Direction</a>, List<<a class="el" href="namespace_otter.html#ada9814b672a9a3b475297439e1159a67">Key</a>>>()</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The Keys to uss. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3f11a806bb5b23ab514cf98f37067ddf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Otter.Axis.Locked = false</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines if input has any effect on the axis. When set to true the axis will remain at the X and Y it was at when locked. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5b775e0c7af234a6c0cbd279f3fdb4ad"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Otter.Axis.RemapRange = true</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines if the DeadZone will be treated as 0 for joysticks. If true, remaps the range DeadZone to 100 to 0 to 1. If false, remaps the range 0 to 100 to 0 to 1. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a44527ca05f58b2dbd902d6db694eb631"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Otter.Axis.RoundInput = true</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines if raw data coming from the joysticks should be rounded to 2 digits. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Property Documentation</h2>
|
|
<a class="anchor" id="af1c695a34bb06b5892736bc179592733"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Axis.Down</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>Gets the down <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a58b7a11208837f6214d74ec07632cf40"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Otter.Axis.ForcedInput</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>Check if the axis is currently forced. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a07fef8b812f60c12d4054e8afb13081a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Otter.Axis.HasInput</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>Check if the axis has any means of input currently registered to it. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aba51e4ffbf32a7245b3ce6f82298d141"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Otter.Axis.LastX</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 previous X position of the axis. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad098d6cc5f6ad83a211dedc7495d63b7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Otter.Axis.LastY</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 previous Y position of the axis. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa3d4280cfd17068494c61abcc97ce9bf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Axis.Left</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 the left <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6d31e2007d46711c8d52c5926a58d284"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Otter.Axis.Neutral</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>Check of the axis is completely neutral. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8c0a92a82621c8a4047e3666fdf14980"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_otter_1_1_vector2.html">Vector2</a> Otter.Axis.Position</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 <a class="el" href="struct_otter_1_1_vector2.html" title="Struct for representing a Vector2. ">Vector2</a> position of the axis. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a18616e9e8e7eee117bbec2b7582e877a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Axis.Right</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>Gets the right <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0a334184f03251234b501c10d2142332"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_button.html">Button</a> Otter.Axis.Up</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 the up <a class="el" href="class_otter_1_1_button.html" title="Component used for interpreting input as a button. It can recieve input from multiple sources includi...">Button</a> for the <a class="el" href="class_otter_1_1_axis.html" title="Component that represents an axis of input. Interprets both X and Y from -1 to 1. Can use multiple so...">Axis</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a17c71c41ca3a798a11d6875716914478"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Otter.Axis.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 X position of the axis from -1 to 1. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa73162aa1da0a45c57b9aa8a477a5f0f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float Otter.Axis.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 Y position of the axis from -1 to 1. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>Otter/Components/Axis.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_axis.html">Axis</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>
|