Subversion Repositories AndroidProjects

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
204 chris 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 
<html>
3 
        <head>
4 
                <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
5 
                <title>ARToolKit API Documentation</title>
6 
                <link href="doxygen.css" rel="stylesheet" type="text/css">
7 
        </head>
8 
        <body>
9 
<!-- Generated by Doxygen 1.4.6 -->
10 
<div class="tabs">
11 
  <ul>
12 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
13 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
14 
    <li id="current"><a href="files.html"><span>Files</span></a></li>
15 
  </ul></div>
16 
<div class="tabs">
17 
  <ul>
18 
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19 
    <li><a href="globals.html"><span>Globals</span></a></li>
20 
  </ul></div>
21 
<h1>arMulti.h File Reference</h1>ARToolkit multi pattern subroutines. <a href="#_details">More...</a>
22 
<p>
23 
<code>#include &lt;stdio.h&gt;</code><br>
24 
<code>#include &lt;AR/config.h&gt;</code><br>
25 
<code>#include &lt;<a class="el" href="param_8h.html">AR/param.h</a>&gt;</code><br>
26 
<code>#include &lt;<a class="el" href="ar_8h.html">AR/ar.h</a>&gt;</code><br>
27 
<table border="0" cellpadding="0" cellspacing="0">
28 
<tr><td></td></tr>
29 
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
30 
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structARMultiEachMarkerInfoT.html">ARMultiEachMarkerInfoT</a></td></tr>
31 
 
32 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">multi-marker structure  <a href="structARMultiEachMarkerInfoT.html#_details">More...</a><br></td></tr>
33 
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a></td></tr>
34 
 
35 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">global multi-marker structure  <a href="structARMultiMarkerInfoT.html#_details">More...</a><br></td></tr>
36 
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
37 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="arMulti_8h.html#db0590bceb05c98697aa997c9bf01b9d">arMultiReadConfigFile</a> (const char *filename)</td></tr>
38 
 
39 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">loading multi-markers description from a file  <a href="#db0590bceb05c98697aa997c9bf01b9d"></a><br></td></tr>
40 
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="arMulti_8h.html#078ec7bb88028842dd6efd788a1f934b">arMultiGetTransMat</a> (<a class="el" href="structARMarkerInfo.html">ARMarkerInfo</a> *marker_info, int marker_num, <a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *config)</td></tr>
41 
 
42 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute camera position in function of the multi-marker patterns (based on detected markers)  <a href="#078ec7bb88028842dd6efd788a1f934b"></a><br></td></tr>
43 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="arMulti_8h.html#1d313592c277bbfb9352741aba8d031f">arMultiActivate</a> (<a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *config)</td></tr>
44 
 
45 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">activate a multi-marker pattern on the recognition procedure.  <a href="#1d313592c277bbfb9352741aba8d031f"></a><br></td></tr>
46 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="arMulti_8h.html#15c56f224029790ec26b33fb414441ca">arMultiDeactivate</a> (<a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *config)</td></tr>
47 
 
48 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Desactivate a multi-marker pattern on the recognition procedure.  <a href="#15c56f224029790ec26b33fb414441ca"></a><br></td></tr>
49 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="arMulti_8h.html#0f33d2031514e1b5af6ba4dfa152633f">arMultiFreeConfig</a> (<a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *config)</td></tr>
50 
 
51 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">remove a multi-marker pattern from memory.  <a href="#0f33d2031514e1b5af6ba4dfa152633f"></a><br></td></tr>
52 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec96609a221602c7a64b3057bff58ea1"></a><!-- doxytag: member="arMulti.h::arsMultiGetTransMat" ref="ec96609a221602c7a64b3057bff58ea1" args="(ARMarkerInfo *marker_infoL, int marker_numL, ARMarkerInfo *marker_infoR, int marker_numR, ARMultiMarkerInfoT *config)" -->
53 
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>arsMultiGetTransMat</b> (<a class="el" href="structARMarkerInfo.html">ARMarkerInfo</a> *marker_infoL, int marker_numL, <a class="el" href="structARMarkerInfo.html">ARMarkerInfo</a> *marker_infoR, int marker_numR, <a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *config)</td></tr>
54 
 
55 
</table>
56 
<hr><a name="_details"></a><h2>Detailed Description</h2>
57 
ARToolkit multi pattern subroutines.
58 
<p>
59 
This file extend ar core routines for multi-pattern tracking. You can obtain position of a local coordinate system based on the estimation of multiple markers tracking (each in relative position)<p>
60 
<dl compact><dt><b>Remarks:</b></dt><dd>more efficient with uniform planar configuration</dd></dl>
61 
History :<p>
62 
<dl compact><dt><b>Author:</b></dt><dd>Hirokazu Kato <a href="mailto:kato@sys.im.hiroshima-cu.ac.jp">kato@sys.im.hiroshima-cu.ac.jp</a> </dd></dl>
63 
<dl compact><dt><b>Version:</b></dt><dd>1.0 </dd></dl>
64 
<dl compact><dt><b>Date:</b></dt><dd>01/09/05 </dd></dl>
65 
<hr><h2>Function Documentation</h2>
66 
<a class="anchor" name="1d313592c277bbfb9352741aba8d031f"></a><!-- doxytag: member="arMulti.h::arMultiActivate" ref="1d313592c277bbfb9352741aba8d031f" args="(ARMultiMarkerInfoT *config)" --><p>
67 
<table class="mdTable" cellpadding="2" cellspacing="0">
68 
  <tr>
69 
    <td class="mdRow">
70 
      <table cellpadding="0" cellspacing="0" border="0">
71 
        <tr>
72 
          <td class="md" nowrap valign="top">int arMultiActivate           </td>
73 
          <td class="md" valign="top">(&nbsp;</td>
74 
          <td class="md" nowrap valign="top"><a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *&nbsp;</td>
75 
          <td class="mdname1" valign="top" nowrap> <em>config</em>          </td>
76 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
77 
          <td class="md" nowrap></td>
78 
        </tr>
79 
      </table>
80 
    </td>
81 
  </tr>
82 
</table>
83 
<table cellspacing="5" cellpadding="0" border="0">
84 
  <tr>
85 
    <td>
86 
      &nbsp;
87 
    </td>
88 
    <td>
89 
 
90 
<p>
91 
activate a multi-marker pattern on the recognition procedure.
92 
<p>
93 
Activate a multi-marker for be checking during the template matching operation. <dl compact><dt><b>Parameters:</b></dt><dd>
94 
  <table border="0" cellspacing="2" cellpadding="0">
95 
    <tr><td valign="top"></td><td valign="top"><em>config</em>&nbsp;</td><td>pointer to the multi-marker </td></tr>
96 
  </table>
97 
</dl>
98 
<dl compact><dt><b>Returns:</b></dt><dd>0 if success, -1 if error </dd></dl>
99 
    </td>
100 
  </tr>
101 
</table>
102 
<a class="anchor" name="15c56f224029790ec26b33fb414441ca"></a><!-- doxytag: member="arMulti.h::arMultiDeactivate" ref="15c56f224029790ec26b33fb414441ca" args="(ARMultiMarkerInfoT *config)" --><p>
103 
<table class="mdTable" cellpadding="2" cellspacing="0">
104 
  <tr>
105 
    <td class="mdRow">
106 
      <table cellpadding="0" cellspacing="0" border="0">
107 
        <tr>
108 
          <td class="md" nowrap valign="top">int arMultiDeactivate           </td>
109 
          <td class="md" valign="top">(&nbsp;</td>
110 
          <td class="md" nowrap valign="top"><a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *&nbsp;</td>
111 
          <td class="mdname1" valign="top" nowrap> <em>config</em>          </td>
112 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
113 
          <td class="md" nowrap></td>
114 
        </tr>
115 
      </table>
116 
    </td>
117 
  </tr>
118 
</table>
119 
<table cellspacing="5" cellpadding="0" border="0">
120 
  <tr>
121 
    <td>
122 
      &nbsp;
123 
    </td>
124 
    <td>
125 
 
126 
<p>
127 
Desactivate a multi-marker pattern on the recognition procedure.
128 
<p>
129 
Desactivate a multi-marker for not be checking during the template matching operation. <dl compact><dt><b>Parameters:</b></dt><dd>
130 
  <table border="0" cellspacing="2" cellpadding="0">
131 
    <tr><td valign="top"></td><td valign="top"><em>config</em>&nbsp;</td><td>pointer to the multi-marker </td></tr>
132 
  </table>
133 
</dl>
134 
<dl compact><dt><b>Returns:</b></dt><dd>0 if success, -1 if error </dd></dl>
135 
    </td>
136 
  </tr>
137 
</table>
138 
<a class="anchor" name="0f33d2031514e1b5af6ba4dfa152633f"></a><!-- doxytag: member="arMulti.h::arMultiFreeConfig" ref="0f33d2031514e1b5af6ba4dfa152633f" args="(ARMultiMarkerInfoT *config)" --><p>
139 
<table class="mdTable" cellpadding="2" cellspacing="0">
140 
  <tr>
141 
    <td class="mdRow">
142 
      <table cellpadding="0" cellspacing="0" border="0">
143 
        <tr>
144 
          <td class="md" nowrap valign="top">int arMultiFreeConfig           </td>
145 
          <td class="md" valign="top">(&nbsp;</td>
146 
          <td class="md" nowrap valign="top"><a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *&nbsp;</td>
147 
          <td class="mdname1" valign="top" nowrap> <em>config</em>          </td>
148 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
149 
          <td class="md" nowrap></td>
150 
        </tr>
151 
      </table>
152 
    </td>
153 
  </tr>
154 
</table>
155 
<table cellspacing="5" cellpadding="0" border="0">
156 
  <tr>
157 
    <td>
158 
      &nbsp;
159 
    </td>
160 
    <td>
161 
 
162 
<p>
163 
remove a multi-marker pattern from memory.
164 
<p>
165 
desactivate a pattern and remove it from memory. Post-condition of this function is unavailability of the multi-marker pattern. <dl compact><dt><b>Parameters:</b></dt><dd>
166 
  <table border="0" cellspacing="2" cellpadding="0">
167 
    <tr><td valign="top"></td><td valign="top"><em>config</em>&nbsp;</td><td>pointer to the multi-marker </td></tr>
168 
  </table>
169 
</dl>
170 
<dl compact><dt><b>Returns:</b></dt><dd>0 if success, -1 if error </dd></dl>
171 
    </td>
172 
  </tr>
173 
</table>
174 
<a class="anchor" name="078ec7bb88028842dd6efd788a1f934b"></a><!-- doxytag: member="arMulti.h::arMultiGetTransMat" ref="078ec7bb88028842dd6efd788a1f934b" args="(ARMarkerInfo *marker_info, int marker_num, ARMultiMarkerInfoT *config)" --><p>
175 
<table class="mdTable" cellpadding="2" cellspacing="0">
176 
  <tr>
177 
    <td class="mdRow">
178 
      <table cellpadding="0" cellspacing="0" border="0">
179 
        <tr>
180 
          <td class="md" nowrap valign="top">double arMultiGetTransMat           </td>
181 
          <td class="md" valign="top">(&nbsp;</td>
182 
          <td class="md" nowrap valign="top"><a class="el" href="structARMarkerInfo.html">ARMarkerInfo</a> *&nbsp;</td>
183 
          <td class="mdname" nowrap> <em>marker_info</em>, </td>
184 
        </tr>
185 
        <tr>
186 
          <td class="md" nowrap align="right"></td>
187 
          <td class="md"></td>
188 
          <td class="md" nowrap>int&nbsp;</td>
189 
          <td class="mdname" nowrap> <em>marker_num</em>, </td>
190 
        </tr>
191 
        <tr>
192 
          <td class="md" nowrap align="right"></td>
193 
          <td class="md"></td>
194 
          <td class="md" nowrap><a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a> *&nbsp;</td>
195 
          <td class="mdname" nowrap> <em>config</em></td>
196 
        </tr>
197 
        <tr>
198 
          <td class="md"></td>
199 
          <td class="md">)&nbsp;</td>
200 
          <td class="md" colspan="2"></td>
201 
        </tr>
202 
      </table>
203 
    </td>
204 
  </tr>
205 
</table>
206 
<table cellspacing="5" cellpadding="0" border="0">
207 
  <tr>
208 
    <td>
209 
      &nbsp;
210 
    </td>
211 
    <td>
212 
 
213 
<p>
214 
compute camera position in function of the multi-marker patterns (based on detected markers)
215 
<p>
216 
calculate the transformation between the multi-marker patterns and the real camera. Based on confident values of detected markers in the multi-markers patterns, a global position is return.<p>
217 
<dl compact><dt><b>Parameters:</b></dt><dd>
218 
  <table border="0" cellspacing="2" cellpadding="0">
219 
    <tr><td valign="top"></td><td valign="top"><em>marker_info</em>&nbsp;</td><td>list of detected markers (from arDetectMarker) </td></tr>
220 
    <tr><td valign="top"></td><td valign="top"><em>marker_num</em>&nbsp;</td><td>number of detected markers </td></tr>
221 
    <tr><td valign="top"></td><td valign="top"><em>config</em>&nbsp;</td><td></td></tr>
222 
  </table>
223 
</dl>
224 
<dl compact><dt><b>Returns:</b></dt><dd></dd></dl>
225 
    </td>
226 
  </tr>
227 
</table>
228 
<a class="anchor" name="db0590bceb05c98697aa997c9bf01b9d"></a><!-- doxytag: member="arMulti.h::arMultiReadConfigFile" ref="db0590bceb05c98697aa997c9bf01b9d" args="(const char *filename)" --><p>
229 
<table class="mdTable" cellpadding="2" cellspacing="0">
230 
  <tr>
231 
    <td class="mdRow">
232 
      <table cellpadding="0" cellspacing="0" border="0">
233 
        <tr>
234 
          <td class="md" nowrap valign="top"><a class="el" href="structARMultiMarkerInfoT.html">ARMultiMarkerInfoT</a>* arMultiReadConfigFile           </td>
235 
          <td class="md" valign="top">(&nbsp;</td>
236 
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
237 
          <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
238 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
239 
          <td class="md" nowrap></td>
240 
        </tr>
241 
      </table>
242 
    </td>
243 
  </tr>
244 
</table>
245 
<table cellspacing="5" cellpadding="0" border="0">
246 
  <tr>
247 
    <td>
248 
      &nbsp;
249 
    </td>
250 
    <td>
251 
 
252 
<p>
253 
loading multi-markers description from a file
254 
<p>
255 
Load a configuration file for multi-markers tracking. The configuration file furnishs pointer to each pattern description.<p>
256 
<dl compact><dt><b>Parameters:</b></dt><dd>
257 
  <table border="0" cellspacing="2" cellpadding="0">
258 
    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>name of the pattern file </td></tr>
259 
  </table>
260 
</dl>
261 
<dl compact><dt><b>Returns:</b></dt><dd>a pattern structure, NULL if error </dd></dl>
262 
    </td>
263 
  </tr>
264 
</table>
265 
 
266 
        <small>Generated with <a href="http://www.doxygen.org/index.html">Doxygen</a><br>
267 
        Copyright © 2004-2006. HIT Lab NZ. All Rights Reserved.</small>
268 
        </body>
269 
</html>