Updated docu.

2015-06-06 18:50:22 +02:00
parent 57aa160278
commit 307c4d998b
1073 changed files with 16543 additions and 6400 deletions
--- a/group__tracking.html
+++ b/group__tracking.html
@@ -0,0 +1,198 @@
+<!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>
+
+</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><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><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 Sat Jun 6 2015 18:48:32 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>