classutil_1_1Grid.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.12"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Tracore: util::Grid Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <script type="text/javascript">
  16. $(document).ready(function() { init_search(); });
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">Tracore
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.12 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><b>util</b></li><li class="navelem"><a class="el" href="classutil_1_1Grid.html">Grid</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-methods">Public Member Functions</a> &#124;
  90. <a href="classutil_1_1Grid-members.html">List of all members</a> </div>
  91. <div class="headertitle">
  92. <div class="title">util::Grid Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p><code>#include &lt;<a class="el" href="Grid_8h_source.html">Grid.h</a>&gt;</code></p>
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  98. Public Member Functions</h2></td></tr>
  99. <tr class="memitem:a0b2bfd0044eb5633a3f1121e5e70709e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a0b2bfd0044eb5633a3f1121e5e70709e">Grid</a> (int width_count, int height_count, double width, double height)</td></tr>
  100. <tr class="separator:a0b2bfd0044eb5633a3f1121e5e70709e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ad6457dda588e20ccd503e363e96dd57e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#ad6457dda588e20ccd503e363e96dd57e">Grid</a> (int width_count, int height_count, int depth_count, double width, double height, double depth)</td></tr>
  102. <tr class="separator:ad6457dda588e20ccd503e363e96dd57e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a0e93bd63922e7cbe405176a1ae21877e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a0e93bd63922e7cbe405176a1ae21877e">SetValue</a> (core::ObjectDataPtr value, int x, int y, int z=0)</td></tr>
  104. <tr class="separator:a0e93bd63922e7cbe405176a1ae21877e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ad7dbf79146d9f5ae1662910b82fd25ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#ad7dbf79146d9f5ae1662910b82fd25ea">SetValue</a> (core::ObjectDataPtr value, double x, double y, double z=0)</td></tr>
  106. <tr class="separator:ad7dbf79146d9f5ae1662910b82fd25ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a6658334ae9b505c56b75f6f15434832e"><td class="memItemLeft" align="right" valign="top">core::ObjectDataPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a6658334ae9b505c56b75f6f15434832e">GetValue</a> (int x, int y, int z=0) const</td></tr>
  108. <tr class="separator:a6658334ae9b505c56b75f6f15434832e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a6cc6449dfe16dde11035fe2d16a321cd"><td class="memItemLeft" align="right" valign="top">core::ObjectDataPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a6cc6449dfe16dde11035fe2d16a321cd">GetValue</a> (double x, double y, double z=0.0) const</td></tr>
  110. <tr class="separator:a6cc6449dfe16dde11035fe2d16a321cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a3f5cdd325b3e3eb30ca5d38bd31d005e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a3f5cdd325b3e3eb30ca5d38bd31d005e">GetWidthCount</a> () const</td></tr>
  112. <tr class="separator:a3f5cdd325b3e3eb30ca5d38bd31d005e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a0c63eb86e4be8c63e996ff61c3ef8b7f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a0c63eb86e4be8c63e996ff61c3ef8b7f">GetHeightCount</a> () const</td></tr>
  114. <tr class="separator:a0c63eb86e4be8c63e996ff61c3ef8b7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a04f1c2fe745d469e49cf2523fe0f34fd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a04f1c2fe745d469e49cf2523fe0f34fd">GetDepthCount</a> () const</td></tr>
  116. <tr class="separator:a04f1c2fe745d469e49cf2523fe0f34fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a8b4dc63bee5859cae315969e039b4cac"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a8b4dc63bee5859cae315969e039b4cac">GetWidth</a> () const</td></tr>
  118. <tr class="separator:a8b4dc63bee5859cae315969e039b4cac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a2d02a1eafe76faaa7e0f63ce406d782f"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a2d02a1eafe76faaa7e0f63ce406d782f">GetHeight</a> () const</td></tr>
  120. <tr class="separator:a2d02a1eafe76faaa7e0f63ce406d782f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:afe6698a6766a43082ceea2d4bf27619e"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#afe6698a6766a43082ceea2d4bf27619e">GetDepth</a> () const</td></tr>
  122. <tr class="separator:afe6698a6766a43082ceea2d4bf27619e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a775e2a7574c81dd7acd1d185b2e72ed5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a775e2a7574c81dd7acd1d185b2e72ed5">PositionToIndex</a> (double x, double y, double z, int &amp;xi, int &amp;yi, int &amp;zi) const</td></tr>
  124. <tr class="separator:a775e2a7574c81dd7acd1d185b2e72ed5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a6597c4f785a764c0b291b8135863fe67"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a6597c4f785a764c0b291b8135863fe67">Convolve2D</a> (int vicinity, double *mask, double multiplier)</td></tr>
  126. <tr class="separator:a6597c4f785a764c0b291b8135863fe67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ac161adb14df09651a6b33f855d887bfa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#ac161adb14df09651a6b33f855d887bfa">Convolve3D</a> (int vicinity, double *mask, double multiplier)</td></tr>
  128. <tr class="separator:ac161adb14df09651a6b33f855d887bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table>
  130. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  131. <div class="textblock"><p>Class for storing values in a three dimensional grid. Can also be used for two dimensions but has a bit overhead. </p>
  132. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  133. <a class="anchor" id="a0b2bfd0044eb5633a3f1121e5e70709e"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">util::Grid::Grid </td>
  139. <td>(</td>
  140. <td class="paramtype">int&#160;</td>
  141. <td class="paramname"><em>width_count</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">int&#160;</td>
  147. <td class="paramname"><em>height_count</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">double&#160;</td>
  153. <td class="paramname"><em>width</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">double&#160;</td>
  159. <td class="paramname"><em>height</em>&#160;</td>
  160. </tr>
  161. <tr>
  162. <td></td>
  163. <td>)</td>
  164. <td></td><td></td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. <p>Creates a new two dimensional grid. </p><dl class="params"><dt>Parameters</dt><dd>
  169. <table class="params">
  170. <tr><td class="paramname">width_count</td><td>The number of elements on the x axis </td></tr>
  171. <tr><td class="paramname">height_count</td><td>The number of elements on the y axis </td></tr>
  172. <tr><td class="paramname">width</td><td>The size of the whole grid on the x axis </td></tr>
  173. <tr><td class="paramname">height</td><td>The size of the whole grid on the y axis </td></tr>
  174. </table>
  175. </dd>
  176. </dl>
  177. </div>
  178. </div>
  179. <a class="anchor" id="ad6457dda588e20ccd503e363e96dd57e"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">util::Grid::Grid </td>
  185. <td>(</td>
  186. <td class="paramtype">int&#160;</td>
  187. <td class="paramname"><em>width_count</em>, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype">int&#160;</td>
  193. <td class="paramname"><em>height_count</em>, </td>
  194. </tr>
  195. <tr>
  196. <td class="paramkey"></td>
  197. <td></td>
  198. <td class="paramtype">int&#160;</td>
  199. <td class="paramname"><em>depth_count</em>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype">double&#160;</td>
  205. <td class="paramname"><em>width</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype">double&#160;</td>
  211. <td class="paramname"><em>height</em>, </td>
  212. </tr>
  213. <tr>
  214. <td class="paramkey"></td>
  215. <td></td>
  216. <td class="paramtype">double&#160;</td>
  217. <td class="paramname"><em>depth</em>&#160;</td>
  218. </tr>
  219. <tr>
  220. <td></td>
  221. <td>)</td>
  222. <td></td><td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Creates a new three dimensional grid. </p><dl class="params"><dt>Parameters</dt><dd>
  227. <table class="params">
  228. <tr><td class="paramname">width_count</td><td>The number of elements on the x axis </td></tr>
  229. <tr><td class="paramname">height_count</td><td>The number of elements on the y axis </td></tr>
  230. <tr><td class="paramname">depth_count</td><td>The number of elements on the z axis </td></tr>
  231. <tr><td class="paramname">width</td><td>The size of the whole grid on the x axis </td></tr>
  232. <tr><td class="paramname">height</td><td>The size of the whole grid on the y axis </td></tr>
  233. <tr><td class="paramname">depth</td><td>The size of the whole grid on the z axis </td></tr>
  234. </table>
  235. </dd>
  236. </dl>
  237. </div>
  238. </div>
  239. <h2 class="groupheader">Member Function Documentation</h2>
  240. <a class="anchor" id="a6597c4f785a764c0b291b8135863fe67"></a>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">void util::Grid::Convolve2D </td>
  246. <td>(</td>
  247. <td class="paramtype">int&#160;</td>
  248. <td class="paramname"><em>vicinity</em>, </td>
  249. </tr>
  250. <tr>
  251. <td class="paramkey"></td>
  252. <td></td>
  253. <td class="paramtype">double *&#160;</td>
  254. <td class="paramname"><em>mask</em>, </td>
  255. </tr>
  256. <tr>
  257. <td class="paramkey"></td>
  258. <td></td>
  259. <td class="paramtype">double&#160;</td>
  260. <td class="paramname"><em>multiplier</em>&#160;</td>
  261. </tr>
  262. <tr>
  263. <td></td>
  264. <td>)</td>
  265. <td></td><td></td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <p>Performs a 2D convolution.</p>
  270. <dl class="params"><dt>Parameters</dt><dd>
  271. <table class="params">
  272. <tr><td class="paramname">vicinity</td><td>The size of the mask around the center (a 3x3 mask has a vicinity of 1) </td></tr>
  273. <tr><td class="paramname">mask</td><td>The mask/kernel to use for the convolution </td></tr>
  274. <tr><td class="paramname">multiplier</td><td>The value is multiplied with the result at the end of the convolution </td></tr>
  275. </table>
  276. </dd>
  277. </dl>
  278. </div>
  279. </div>
  280. <a class="anchor" id="ac161adb14df09651a6b33f855d887bfa"></a>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">void util::Grid::Convolve3D </td>
  286. <td>(</td>
  287. <td class="paramtype">int&#160;</td>
  288. <td class="paramname"><em>vicinity</em>, </td>
  289. </tr>
  290. <tr>
  291. <td class="paramkey"></td>
  292. <td></td>
  293. <td class="paramtype">double *&#160;</td>
  294. <td class="paramname"><em>mask</em>, </td>
  295. </tr>
  296. <tr>
  297. <td class="paramkey"></td>
  298. <td></td>
  299. <td class="paramtype">double&#160;</td>
  300. <td class="paramname"><em>multiplier</em>&#160;</td>
  301. </tr>
  302. <tr>
  303. <td></td>
  304. <td>)</td>
  305. <td></td><td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Performs a 3D convolution.</p>
  310. <dl class="params"><dt>Parameters</dt><dd>
  311. <table class="params">
  312. <tr><td class="paramname">vicinity</td><td>The size of the mask around the center (a 3x3 mask has a vicinity of 1) </td></tr>
  313. <tr><td class="paramname">mask</td><td>The mask/kernel to use for the convolution </td></tr>
  314. <tr><td class="paramname">multiplier</td><td>The value is multiplied with the result at the end of the convolution </td></tr>
  315. </table>
  316. </dd>
  317. </dl>
  318. </div>
  319. </div>
  320. <a class="anchor" id="afe6698a6766a43082ceea2d4bf27619e"></a>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname">double util::Grid::GetDepth </td>
  326. <td>(</td>
  327. <td class="paramname"></td><td>)</td>
  328. <td> const</td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Gets the size of the whole grid on the z axis. </p><dl class="section return"><dt>Returns</dt><dd>the size of the whole grid on the z axis </dd></dl>
  333. </div>
  334. </div>
  335. <a class="anchor" id="a04f1c2fe745d469e49cf2523fe0f34fd"></a>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <table class="memname">
  339. <tr>
  340. <td class="memname">int util::Grid::GetDepthCount </td>
  341. <td>(</td>
  342. <td class="paramname"></td><td>)</td>
  343. <td> const</td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <p>Gets the number of elements on the z axis. </p><dl class="section return"><dt>Returns</dt><dd>The number of elements on the z axis </dd></dl>
  348. </div>
  349. </div>
  350. <a class="anchor" id="a2d02a1eafe76faaa7e0f63ce406d782f"></a>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">double util::Grid::GetHeight </td>
  356. <td>(</td>
  357. <td class="paramname"></td><td>)</td>
  358. <td> const</td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Gets the size of the whole grid on the y axis. </p><dl class="section return"><dt>Returns</dt><dd>the size of the whole grid on the y axis </dd></dl>
  363. </div>
  364. </div>
  365. <a class="anchor" id="a0c63eb86e4be8c63e996ff61c3ef8b7f"></a>
  366. <div class="memitem">
  367. <div class="memproto">
  368. <table class="memname">
  369. <tr>
  370. <td class="memname">int util::Grid::GetHeightCount </td>
  371. <td>(</td>
  372. <td class="paramname"></td><td>)</td>
  373. <td> const</td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <p>Gets the number of elements on the y axis. </p><dl class="section return"><dt>Returns</dt><dd>The number of elements on the y axis </dd></dl>
  378. </div>
  379. </div>
  380. <a class="anchor" id="a6658334ae9b505c56b75f6f15434832e"></a>
  381. <div class="memitem">
  382. <div class="memproto">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname">core::ObjectDataPtr util::Grid::GetValue </td>
  386. <td>(</td>
  387. <td class="paramtype">int&#160;</td>
  388. <td class="paramname"><em>x</em>, </td>
  389. </tr>
  390. <tr>
  391. <td class="paramkey"></td>
  392. <td></td>
  393. <td class="paramtype">int&#160;</td>
  394. <td class="paramname"><em>y</em>, </td>
  395. </tr>
  396. <tr>
  397. <td class="paramkey"></td>
  398. <td></td>
  399. <td class="paramtype">int&#160;</td>
  400. <td class="paramname"><em>z</em> = <code>0</code>&#160;</td>
  401. </tr>
  402. <tr>
  403. <td></td>
  404. <td>)</td>
  405. <td></td><td> const</td>
  406. </tr>
  407. </table>
  408. </div><div class="memdoc">
  409. <p>Gets the value in the grid cell with the given index. </p><dl class="params"><dt>Parameters</dt><dd>
  410. <table class="params">
  411. <tr><td class="paramname">x</td><td>The x axis index </td></tr>
  412. <tr><td class="paramname">y</td><td>The y axis index </td></tr>
  413. <tr><td class="paramname">z</td><td>The z axis index </td></tr>
  414. </table>
  415. </dd>
  416. </dl>
  417. <dl class="section return"><dt>Returns</dt><dd>The value in the grid cell </dd></dl>
  418. </div>
  419. </div>
  420. <a class="anchor" id="a6cc6449dfe16dde11035fe2d16a321cd"></a>
  421. <div class="memitem">
  422. <div class="memproto">
  423. <table class="memname">
  424. <tr>
  425. <td class="memname">core::ObjectDataPtr util::Grid::GetValue </td>
  426. <td>(</td>
  427. <td class="paramtype">double&#160;</td>
  428. <td class="paramname"><em>x</em>, </td>
  429. </tr>
  430. <tr>
  431. <td class="paramkey"></td>
  432. <td></td>
  433. <td class="paramtype">double&#160;</td>
  434. <td class="paramname"><em>y</em>, </td>
  435. </tr>
  436. <tr>
  437. <td class="paramkey"></td>
  438. <td></td>
  439. <td class="paramtype">double&#160;</td>
  440. <td class="paramname"><em>z</em> = <code>0.0</code>&#160;</td>
  441. </tr>
  442. <tr>
  443. <td></td>
  444. <td>)</td>
  445. <td></td><td> const</td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <p>Gets the value in the grid cell at the given position. </p><dl class="params"><dt>Parameters</dt><dd>
  450. <table class="params">
  451. <tr><td class="paramname">x</td><td>The x axis value </td></tr>
  452. <tr><td class="paramname">y</td><td>The y axis value </td></tr>
  453. <tr><td class="paramname">z</td><td>The z axis value </td></tr>
  454. </table>
  455. </dd>
  456. </dl>
  457. <dl class="section return"><dt>Returns</dt><dd>The value in the grid cell </dd></dl>
  458. </div>
  459. </div>
  460. <a class="anchor" id="a8b4dc63bee5859cae315969e039b4cac"></a>
  461. <div class="memitem">
  462. <div class="memproto">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname">double util::Grid::GetWidth </td>
  466. <td>(</td>
  467. <td class="paramname"></td><td>)</td>
  468. <td> const</td>
  469. </tr>
  470. </table>
  471. </div><div class="memdoc">
  472. <p>Gets the size of the whole grid on the x axis. </p><dl class="section return"><dt>Returns</dt><dd>the size of the whole grid on the x axis </dd></dl>
  473. </div>
  474. </div>
  475. <a class="anchor" id="a3f5cdd325b3e3eb30ca5d38bd31d005e"></a>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="memname">
  479. <tr>
  480. <td class="memname">int util::Grid::GetWidthCount </td>
  481. <td>(</td>
  482. <td class="paramname"></td><td>)</td>
  483. <td> const</td>
  484. </tr>
  485. </table>
  486. </div><div class="memdoc">
  487. <p>Gets the number of elements on the x axis. </p><dl class="section return"><dt>Returns</dt><dd>The number of elements on the x axis </dd></dl>
  488. </div>
  489. </div>
  490. <a class="anchor" id="a775e2a7574c81dd7acd1d185b2e72ed5"></a>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname">void util::Grid::PositionToIndex </td>
  496. <td>(</td>
  497. <td class="paramtype">double&#160;</td>
  498. <td class="paramname"><em>x</em>, </td>
  499. </tr>
  500. <tr>
  501. <td class="paramkey"></td>
  502. <td></td>
  503. <td class="paramtype">double&#160;</td>
  504. <td class="paramname"><em>y</em>, </td>
  505. </tr>
  506. <tr>
  507. <td class="paramkey"></td>
  508. <td></td>
  509. <td class="paramtype">double&#160;</td>
  510. <td class="paramname"><em>z</em>, </td>
  511. </tr>
  512. <tr>
  513. <td class="paramkey"></td>
  514. <td></td>
  515. <td class="paramtype">int &amp;&#160;</td>
  516. <td class="paramname"><em>xi</em>, </td>
  517. </tr>
  518. <tr>
  519. <td class="paramkey"></td>
  520. <td></td>
  521. <td class="paramtype">int &amp;&#160;</td>
  522. <td class="paramname"><em>yi</em>, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype">int &amp;&#160;</td>
  528. <td class="paramname"><em>zi</em>&#160;</td>
  529. </tr>
  530. <tr>
  531. <td></td>
  532. <td>)</td>
  533. <td></td><td> const</td>
  534. </tr>
  535. </table>
  536. </div><div class="memdoc">
  537. <p>Converts a 3D position to an 3D index. </p><dl class="params"><dt>Parameters</dt><dd>
  538. <table class="params">
  539. <tr><td class="paramname">x</td><td>The x axis value </td></tr>
  540. <tr><td class="paramname">y</td><td>The y axis value </td></tr>
  541. <tr><td class="paramname">z</td><td>The z axis value </td></tr>
  542. <tr><td class="paramname">xi</td><td>The x axis index </td></tr>
  543. <tr><td class="paramname">yi</td><td>The y axis index </td></tr>
  544. <tr><td class="paramname">zi</td><td>The z axis index </td></tr>
  545. </table>
  546. </dd>
  547. </dl>
  548. </div>
  549. </div>
  550. <a class="anchor" id="a0e93bd63922e7cbe405176a1ae21877e"></a>
  551. <div class="memitem">
  552. <div class="memproto">
  553. <table class="memname">
  554. <tr>
  555. <td class="memname">void util::Grid::SetValue </td>
  556. <td>(</td>
  557. <td class="paramtype">core::ObjectDataPtr&#160;</td>
  558. <td class="paramname"><em>value</em>, </td>
  559. </tr>
  560. <tr>
  561. <td class="paramkey"></td>
  562. <td></td>
  563. <td class="paramtype">int&#160;</td>
  564. <td class="paramname"><em>x</em>, </td>
  565. </tr>
  566. <tr>
  567. <td class="paramkey"></td>
  568. <td></td>
  569. <td class="paramtype">int&#160;</td>
  570. <td class="paramname"><em>y</em>, </td>
  571. </tr>
  572. <tr>
  573. <td class="paramkey"></td>
  574. <td></td>
  575. <td class="paramtype">int&#160;</td>
  576. <td class="paramname"><em>z</em> = <code>0</code>&#160;</td>
  577. </tr>
  578. <tr>
  579. <td></td>
  580. <td>)</td>
  581. <td></td><td></td>
  582. </tr>
  583. </table>
  584. </div><div class="memdoc">
  585. <p>Sets a value in the grid cell with the given index. </p><dl class="params"><dt>Parameters</dt><dd>
  586. <table class="params">
  587. <tr><td class="paramname">value</td><td>The value to set </td></tr>
  588. <tr><td class="paramname">x</td><td>The x axis index </td></tr>
  589. <tr><td class="paramname">y</td><td>The y axis index </td></tr>
  590. <tr><td class="paramname">z</td><td>The z axis index </td></tr>
  591. </table>
  592. </dd>
  593. </dl>
  594. </div>
  595. </div>
  596. <a class="anchor" id="ad7dbf79146d9f5ae1662910b82fd25ea"></a>
  597. <div class="memitem">
  598. <div class="memproto">
  599. <table class="memname">
  600. <tr>
  601. <td class="memname">void util::Grid::SetValue </td>
  602. <td>(</td>
  603. <td class="paramtype">core::ObjectDataPtr&#160;</td>
  604. <td class="paramname"><em>value</em>, </td>
  605. </tr>
  606. <tr>
  607. <td class="paramkey"></td>
  608. <td></td>
  609. <td class="paramtype">double&#160;</td>
  610. <td class="paramname"><em>x</em>, </td>
  611. </tr>
  612. <tr>
  613. <td class="paramkey"></td>
  614. <td></td>
  615. <td class="paramtype">double&#160;</td>
  616. <td class="paramname"><em>y</em>, </td>
  617. </tr>
  618. <tr>
  619. <td class="paramkey"></td>
  620. <td></td>
  621. <td class="paramtype">double&#160;</td>
  622. <td class="paramname"><em>z</em> = <code>0</code>&#160;</td>
  623. </tr>
  624. <tr>
  625. <td></td>
  626. <td>)</td>
  627. <td></td><td></td>
  628. </tr>
  629. </table>
  630. </div><div class="memdoc">
  631. <p>Sets a value in the grid cell at the given position. </p><dl class="params"><dt>Parameters</dt><dd>
  632. <table class="params">
  633. <tr><td class="paramname">value</td><td>The value to set </td></tr>
  634. <tr><td class="paramname">x</td><td>The x axis value </td></tr>
  635. <tr><td class="paramname">y</td><td>The y axis value </td></tr>
  636. <tr><td class="paramname">z</td><td>The z axis value </td></tr>
  637. </table>
  638. </dd>
  639. </dl>
  640. </div>
  641. </div>
  642. <hr/>The documentation for this class was generated from the following files:<ul>
  643. <li>util/<a class="el" href="Grid_8h_source.html">Grid.h</a></li>
  644. <li>util/Grid.cpp</li>
  645. </ul>
  646. </div><!-- contents -->
  647. <!-- start footer part -->
  648. <hr class="footer"/><address class="footer"><small>
  649. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  650. <img class="footer" src="doxygen.png" alt="doxygen"/>
  651. </a> 1.8.12
  652. </small></address>
  653. </body>
  654. </html>