root / branches / lib_additions / docs / libdragonfly / group__rangefinder.html @ 79
History | View | Annotate | Download (7.05 KB)
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|
2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
3 |
<title>libdragonfly: Rangefinder</title> |
4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
6 |
</head><body> |
7 |
<!-- Generated by Doxygen 1.4.6 -->
|
8 |
<div class="tabs"> |
9 |
<ul>
|
10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
12 |
<li><a href="files.html"><span>Files</span></a></li> |
13 |
</ul></div> |
14 |
<h1>Rangefinder</h1>Functions for using the IR rangefinders. |
15 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
16 |
<tr><td></td></tr> |
17 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
18 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7b2b32709f9770a283701ffcf3723497"></a><!-- doxytag: member="rangefinder::IR1" ref="g7b2b32709f9770a283701ffcf3723497" args="" --> |
19 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g7b2b32709f9770a283701ffcf3723497">IR1</a> 6</td></tr> |
20 |
|
21 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 1. <br></td></tr> |
22 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a08e4f5cb3582e623cc14a6c92d48de"></a><!-- doxytag: member="rangefinder::IR2" ref="g5a08e4f5cb3582e623cc14a6c92d48de" args="" --> |
23 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g5a08e4f5cb3582e623cc14a6c92d48de">IR2</a> 5</td></tr> |
24 |
|
25 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 2. <br></td></tr> |
26 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g26c72d21cca0ec21af4bd9b20ba3ad51"></a><!-- doxytag: member="rangefinder::IR3" ref="g26c72d21cca0ec21af4bd9b20ba3ad51" args="" --> |
27 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g26c72d21cca0ec21af4bd9b20ba3ad51">IR3</a> 4</td></tr> |
28 |
|
29 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 3. <br></td></tr> |
30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g20f2f5908baa0eeba04b9ceaf718cea0"></a><!-- doxytag: member="rangefinder::IR4" ref="g20f2f5908baa0eeba04b9ceaf718cea0" args="" --> |
31 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g20f2f5908baa0eeba04b9ceaf718cea0">IR4</a> 3</td></tr> |
32 |
|
33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 4. <br></td></tr> |
34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g23554754d5334bdc35df623e1e012ede"></a><!-- doxytag: member="rangefinder::IR5" ref="g23554754d5334bdc35df623e1e012ede" args="" --> |
35 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g23554754d5334bdc35df623e1e012ede">IR5</a> 2</td></tr> |
36 |
|
37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">IR Rangefinder 5. <br></td></tr> |
38 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59">range_init</a> (void)</td></tr> |
40 |
|
41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the rangefinders. <a href="#g52d0666b725e6d3a14b5bddc28190e59"></a><br></td></tr> |
42 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rangefinder.html#g22bd0717784e34cb3a0762d78554dcf2">range_read_distance</a> (int range_id)</td></tr> |
43 |
|
44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the distance from a rangefinder. <a href="#g22bd0717784e34cb3a0762d78554dcf2"></a><br></td></tr> |
45 |
</table>
|
46 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
47 |
Functions for using the IR rangefinders. |
48 |
<p>
|
49 |
Functions for using the IR rangefinders. <hr><h2>Function Documentation</h2> |
50 |
<a class="anchor" name="g52d0666b725e6d3a14b5bddc28190e59"></a><!-- doxytag: member="rangefinder.c::range_init" ref="g52d0666b725e6d3a14b5bddc28190e59" args="(void)" --><p> |
51 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
52 |
<tr>
|
53 |
<td class="mdRow"> |
54 |
<table cellpadding="0" cellspacing="0" border="0"> |
55 |
<tr>
|
56 |
<td class="md" nowrap valign="top">void range_init </td> |
57 |
<td class="md" valign="top">( </td> |
58 |
<td class="md" nowrap valign="top">void </td> |
59 |
<td class="mdname1" valign="top" nowrap> </td> |
60 |
<td class="md" valign="top"> ) </td> |
61 |
<td class="md" nowrap></td> |
62 |
</tr>
|
63 |
</table>
|
64 |
</td>
|
65 |
</tr>
|
66 |
</table>
|
67 |
<table cellspacing="5" cellpadding="0" border="0"> |
68 |
<tr>
|
69 |
<td>
|
70 |
|
71 |
</td>
|
72 |
<td>
|
73 |
|
74 |
<p>
|
75 |
Initialize the rangefinders. |
76 |
<p>
|
77 |
Initializes the rangefinders. This must be called before range_read_distance.<p>
|
78 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__rangefinder.html#g22bd0717784e34cb3a0762d78554dcf2">range_read_distance</a> </dd></dl> |
79 |
</td>
|
80 |
</tr>
|
81 |
</table>
|
82 |
<a class="anchor" name="g22bd0717784e34cb3a0762d78554dcf2"></a><!-- doxytag: member="rangefinder.c::range_read_distance" ref="g22bd0717784e34cb3a0762d78554dcf2" args="(int range_id)" --><p> |
83 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
84 |
<tr>
|
85 |
<td class="mdRow"> |
86 |
<table cellpadding="0" cellspacing="0" border="0"> |
87 |
<tr>
|
88 |
<td class="md" nowrap valign="top">int range_read_distance </td> |
89 |
<td class="md" valign="top">( </td> |
90 |
<td class="md" nowrap valign="top">int </td> |
91 |
<td class="mdname1" valign="top" nowrap> <em>range_id</em> </td> |
92 |
<td class="md" valign="top"> ) </td> |
93 |
<td class="md" nowrap></td> |
94 |
</tr>
|
95 |
</table>
|
96 |
</td>
|
97 |
</tr>
|
98 |
</table>
|
99 |
<table cellspacing="5" cellpadding="0" border="0"> |
100 |
<tr>
|
101 |
<td>
|
102 |
|
103 |
</td>
|
104 |
<td>
|
105 |
|
106 |
<p>
|
107 |
Read the distance from a rangefinder. |
108 |
<p>
|
109 |
Reads the distance measured by one of the rangefinders. This distance is in arbitrary units.<p>
|
110 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
111 |
<table border="0" cellspacing="2" cellpadding="0"> |
112 |
<tr><td valign="top"></td><td valign="top"><em>range_id</em> </td><td>the rangefinder to use. This should be one of the constants IR1 - IR5.</td></tr> |
113 |
</table>
|
114 |
</dl>
|
115 |
<dl compact><dt><b>Returns:</b></dt><dd>the distance measured by the rangefinder</dd></dl> |
116 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__rangefinder.html#g52d0666b725e6d3a14b5bddc28190e59">range_init</a> </dd></dl> |
117 |
</td>
|
118 |
</tr>
|
119 |
</table>
|
120 |
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 15:36:18 2007 for libdragonfly by |
121 |
<a href="http://www.doxygen.org/index.html"> |
122 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
123 |
</body>
|
124 |
</html>
|