Files
discoverpixy/group__tracking.html
2015-06-08 11:04:50 +02:00

236 lines
18 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.9.1"/>
<title>discoverpixy: Tracking (Screen)</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</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><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Tracking (Screen)<div class="ingroups"><a class="el" href="group__app.html">Application</a> &raquo; <a class="el" href="group__screens.html">Screens</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Tracking (Screen):</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__tracking.png" border="0" alt="" usemap="#group____tracking"/>
<map name="group____tracking" id="group____tracking">
<area shape="rect" id="node2" href="group__screens.html" title="Screens" alt="" coords="5,5,76,32"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga3c8bf9318d59fa185140f11fbd82f7d1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tracking.html#ga3c8bf9318d59fa185140f11fbd82f7d1">Tracking_Implementation</a> { <a class="el" href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a601022de7c24d62c465df0a920b8e8ba">OUR_TRACKING</a>,
<a class="el" href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a8047bc34a9635f316a089c282bb66604">REFERENCE_TRACKING</a>
}</td></tr>
<tr class="separator:ga3c8bf9318d59fa185140f11fbd82f7d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa650e188292061217071b2f3311460fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tracking.html#gaa650e188292061217071b2f3311460fe">tracking_set_mode</a> (enum <a class="el" href="group__tracking.html#ga3c8bf9318d59fa185140f11fbd82f7d1">Tracking_Implementation</a> impl)</td></tr>
<tr class="separator:gaa650e188292061217071b2f3311460fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadbbcf262b0bef063b8bb876013a80ef7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__screen.html#gaf7783b8728d6d218aa9e3b29eaf9689c">SCREEN_STRUCT</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tracking.html#gadbbcf262b0bef063b8bb876013a80ef7">get_screen_tracking</a> ()</td></tr>
<tr class="separator:gadbbcf262b0bef063b8bb876013a80ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The Tracking-Screen shows the object-tracking and allows some configuration </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga3c8bf9318d59fa185140f11fbd82f7d1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__tracking.html#ga3c8bf9318d59fa185140f11fbd82f7d1">Tracking_Implementation</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum which contains the available tracking implementations </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga3c8bf9318d59fa185140f11fbd82f7d1a601022de7c24d62c465df0a920b8e8ba"></a>OUR_TRACKING&#160;</td><td class="fielddoc">
<p>Our own tracking PID implementation. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga3c8bf9318d59fa185140f11fbd82f7d1a8047bc34a9635f316a089c282bb66604"></a>REFERENCE_TRACKING&#160;</td><td class="fielddoc">
<p>Pixy's internal tracking implementation. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="screen__tracking_8h_source.html#l00031">31</a> of file <a class="el" href="screen__tracking_8h_source.html">screen_tracking.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a601022de7c24d62c465df0a920b8e8ba">OUR_TRACKING</a>, </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a8047bc34a9635f316a089c282bb66604">REFERENCE_TRACKING</a></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;};</div>
<div class="ttc" id="group__tracking_html_gga3c8bf9318d59fa185140f11fbd82f7d1a8047bc34a9635f316a089c282bb66604"><div class="ttname"><a href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a8047bc34a9635f316a089c282bb66604">REFERENCE_TRACKING</a></div><div class="ttdoc">Pixy&#39;s internal tracking implementation. </div><div class="ttdef"><b>Definition:</b> <a href="screen__tracking_8h_source.html#l00033">screen_tracking.h:33</a></div></div>
<div class="ttc" id="group__tracking_html_gga3c8bf9318d59fa185140f11fbd82f7d1a601022de7c24d62c465df0a920b8e8ba"><div class="ttname"><a href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a601022de7c24d62c465df0a920b8e8ba">OUR_TRACKING</a></div><div class="ttdoc">Our own tracking PID implementation. </div><div class="ttdef"><b>Definition:</b> <a href="screen__tracking_8h_source.html#l00032">screen_tracking.h:32</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gadbbcf262b0bef063b8bb876013a80ef7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__screen.html#gaf7783b8728d6d218aa9e3b29eaf9689c">SCREEN_STRUCT</a>* get_screen_tracking </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to the tracking screen </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__screen.html#gad4473a16eaf48dab405d23f5f63af3aa">gui_screen_navigate</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Definition at line <a class="el" href="screen__tracking_8c_source.html#l00418">418</a> of file <a class="el" href="screen__tracking_8c_source.html">screen_tracking.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160;{</div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160; <span class="keywordflow">return</span> &amp;<a class="code" href="screen__tracking_8c.html#a939fdd806f427cc8505ed817e28cce9d">screen</a>;</div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;}</div>
<div class="ttc" id="screen__tracking_8c_html_a939fdd806f427cc8505ed817e28cce9d"><div class="ttname"><a href="screen__tracking_8c.html#a939fdd806f427cc8505ed817e28cce9d">screen</a></div><div class="ttdeci">static SCREEN_STRUCT screen</div><div class="ttdef"><b>Definition:</b> <a href="screen__tracking_8c_source.html#l00411">screen_tracking.c:411</a></div></div>
</div><!-- fragment -->
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__tracking_gadbbcf262b0bef063b8bb876013a80ef7_icgraph.png" border="0" usemap="#group__tracking_gadbbcf262b0bef063b8bb876013a80ef7_icgraph" alt=""/></div>
<map name="group__tracking_gadbbcf262b0bef063b8bb876013a80ef7_icgraph" id="group__tracking_gadbbcf262b0bef063b8bb876013a80ef7_icgraph">
<area shape="rect" id="node2" href="screen__main_8c.html#af63dbdd3e891f9e0b15d60c53df83a72" title="b_our_tracking_cb" alt="" coords="192,5,320,32"/><area shape="rect" id="node4" href="screen__main_8c.html#a92ab4314565044b947e0b14b0c7cb2b9" title="b_ref_tracking_cb" alt="" coords="194,56,318,83"/><area shape="rect" id="node3" href="screen__main_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="368,31,419,57"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="gaa650e188292061217071b2f3311460fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tracking_set_mode </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__tracking.html#ga3c8bf9318d59fa185140f11fbd82f7d1">Tracking_Implementation</a>&#160;</td>
<td class="paramname"><em>impl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current Mode/Tracking Implementation. Call this before using the screen obtained by <a class="el" href="group__tracking.html#gadbbcf262b0bef063b8bb876013a80ef7">get_screen_tracking()</a> </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impl</td><td>The new mode </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="screen__tracking_8c_source.html#l00210">210</a> of file <a class="el" href="screen__tracking_8c_source.html">screen_tracking.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;{</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; <span class="comment">//Depending on the enum value let tracking_current point to a different setting/callback structure</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; <span class="keywordflow">switch</span> (impl) {</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; <span class="keywordflow">case</span> <a class="code" href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a601022de7c24d62c465df0a920b8e8ba">OUR_TRACKING</a>:</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <a class="code" href="screen__tracking_8c.html#a7bd7bb6bc639dec66a8fd93227f293f0">tracking_current</a> = &amp;<a class="code" href="screen__tracking_8c.html#a8ad01802d2302a672e63cf5d0080a61a">tracking_our</a>;</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160;</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; <span class="keywordflow">case</span> <a class="code" href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a8047bc34a9635f316a089c282bb66604">REFERENCE_TRACKING</a>:</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; <a class="code" href="screen__tracking_8c.html#a7bd7bb6bc639dec66a8fd93227f293f0">tracking_current</a> = &amp;<a class="code" href="screen__tracking_8c.html#afc404400e5518dc8701053e6abb74a4c">tracking_reference</a>;</div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; <a class="code" href="screen__tracking_8c.html#a7bd7bb6bc639dec66a8fd93227f293f0">tracking_current</a> = NULL;</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; }</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;}</div>
<div class="ttc" id="screen__tracking_8c_html_a8ad01802d2302a672e63cf5d0080a61a"><div class="ttname"><a href="screen__tracking_8c.html#a8ad01802d2302a672e63cf5d0080a61a">tracking_our</a></div><div class="ttdeci">static TRACKING_CONFIG_STRUCT tracking_our</div><div class="ttdef"><b>Definition:</b> <a href="screen__tracking_8c_source.html#l00167">screen_tracking.c:167</a></div></div>
<div class="ttc" id="screen__tracking_8c_html_a7bd7bb6bc639dec66a8fd93227f293f0"><div class="ttname"><a href="screen__tracking_8c.html#a7bd7bb6bc639dec66a8fd93227f293f0">tracking_current</a></div><div class="ttdeci">static TRACKING_CONFIG_STRUCT * tracking_current</div><div class="ttdef"><b>Definition:</b> <a href="screen__tracking_8c_source.html#l00207">screen_tracking.c:207</a></div></div>
<div class="ttc" id="group__tracking_html_gga3c8bf9318d59fa185140f11fbd82f7d1a8047bc34a9635f316a089c282bb66604"><div class="ttname"><a href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a8047bc34a9635f316a089c282bb66604">REFERENCE_TRACKING</a></div><div class="ttdoc">Pixy&#39;s internal tracking implementation. </div><div class="ttdef"><b>Definition:</b> <a href="screen__tracking_8h_source.html#l00033">screen_tracking.h:33</a></div></div>
<div class="ttc" id="screen__tracking_8c_html_afc404400e5518dc8701053e6abb74a4c"><div class="ttname"><a href="screen__tracking_8c.html#afc404400e5518dc8701053e6abb74a4c">tracking_reference</a></div><div class="ttdeci">static TRACKING_CONFIG_STRUCT tracking_reference</div><div class="ttdef"><b>Definition:</b> <a href="screen__tracking_8c_source.html#l00200">screen_tracking.c:200</a></div></div>
<div class="ttc" id="group__tracking_html_gga3c8bf9318d59fa185140f11fbd82f7d1a601022de7c24d62c465df0a920b8e8ba"><div class="ttname"><a href="group__tracking.html#gga3c8bf9318d59fa185140f11fbd82f7d1a601022de7c24d62c465df0a920b8e8ba">OUR_TRACKING</a></div><div class="ttdoc">Our own tracking PID implementation. </div><div class="ttdef"><b>Definition:</b> <a href="screen__tracking_8h_source.html#l00032">screen_tracking.h:32</a></div></div>
</div><!-- fragment -->
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__tracking_gaa650e188292061217071b2f3311460fe_icgraph.png" border="0" usemap="#group__tracking_gaa650e188292061217071b2f3311460fe_icgraph" alt=""/></div>
<map name="group__tracking_gaa650e188292061217071b2f3311460fe_icgraph" id="group__tracking_gaa650e188292061217071b2f3311460fe_icgraph">
<area shape="rect" id="node2" href="screen__main_8c.html#af63dbdd3e891f9e0b15d60c53df83a72" title="b_our_tracking_cb" alt="" coords="185,5,313,32"/><area shape="rect" id="node4" href="screen__main_8c.html#a92ab4314565044b947e0b14b0c7cb2b9" title="b_ref_tracking_cb" alt="" coords="187,56,311,83"/><area shape="rect" id="node3" href="screen__main_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="361,31,412,57"/></map>
</div>
</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 8 2015 11:01:19 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>