classutil_1_1Grid.html 25 KB

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