classutil_1_1Grid.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697
  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:ab8e9f6c804b0eab1f5666a039130b8ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#ab8e9f6c804b0eab1f5666a039130b8ed">Convolve2D</a> (<a class="el" href="classutil_1_1Filter2D.html">util::Filter2D</a> &amp;filter)</td></tr>
  128. <tr class="separator:ab8e9f6c804b0eab1f5666a039130b8ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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>
  130. <tr class="separator:ac161adb14df09651a6b33f855d887bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  133. <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>
  134. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  135. <a class="anchor" id="a0b2bfd0044eb5633a3f1121e5e70709e"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">util::Grid::Grid </td>
  141. <td>(</td>
  142. <td class="paramtype">int&#160;</td>
  143. <td class="paramname"><em>width_count</em>, </td>
  144. </tr>
  145. <tr>
  146. <td class="paramkey"></td>
  147. <td></td>
  148. <td class="paramtype">int&#160;</td>
  149. <td class="paramname"><em>height_count</em>, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">double&#160;</td>
  155. <td class="paramname"><em>width</em>, </td>
  156. </tr>
  157. <tr>
  158. <td class="paramkey"></td>
  159. <td></td>
  160. <td class="paramtype">double&#160;</td>
  161. <td class="paramname"><em>height</em>&#160;</td>
  162. </tr>
  163. <tr>
  164. <td></td>
  165. <td>)</td>
  166. <td></td><td></td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <p>Creates a new two dimensional grid. </p><dl class="params"><dt>Parameters</dt><dd>
  171. <table class="params">
  172. <tr><td class="paramname">width_count</td><td>The number of elements on the x axis </td></tr>
  173. <tr><td class="paramname">height_count</td><td>The number of elements on the y axis </td></tr>
  174. <tr><td class="paramname">width</td><td>The size of the whole grid on the x axis </td></tr>
  175. <tr><td class="paramname">height</td><td>The size of the whole grid on the y axis </td></tr>
  176. </table>
  177. </dd>
  178. </dl>
  179. </div>
  180. </div>
  181. <a class="anchor" id="ad6457dda588e20ccd503e363e96dd57e"></a>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">util::Grid::Grid </td>
  187. <td>(</td>
  188. <td class="paramtype">int&#160;</td>
  189. <td class="paramname"><em>width_count</em>, </td>
  190. </tr>
  191. <tr>
  192. <td class="paramkey"></td>
  193. <td></td>
  194. <td class="paramtype">int&#160;</td>
  195. <td class="paramname"><em>height_count</em>, </td>
  196. </tr>
  197. <tr>
  198. <td class="paramkey"></td>
  199. <td></td>
  200. <td class="paramtype">int&#160;</td>
  201. <td class="paramname"><em>depth_count</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">double&#160;</td>
  207. <td class="paramname"><em>width</em>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype">double&#160;</td>
  213. <td class="paramname"><em>height</em>, </td>
  214. </tr>
  215. <tr>
  216. <td class="paramkey"></td>
  217. <td></td>
  218. <td class="paramtype">double&#160;</td>
  219. <td class="paramname"><em>depth</em>&#160;</td>
  220. </tr>
  221. <tr>
  222. <td></td>
  223. <td>)</td>
  224. <td></td><td></td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Creates a new three dimensional grid. </p><dl class="params"><dt>Parameters</dt><dd>
  229. <table class="params">
  230. <tr><td class="paramname">width_count</td><td>The number of elements on the x axis </td></tr>
  231. <tr><td class="paramname">height_count</td><td>The number of elements on the y axis </td></tr>
  232. <tr><td class="paramname">depth_count</td><td>The number of elements on the z axis </td></tr>
  233. <tr><td class="paramname">width</td><td>The size of the whole grid on the x axis </td></tr>
  234. <tr><td class="paramname">height</td><td>The size of the whole grid on the y axis </td></tr>
  235. <tr><td class="paramname">depth</td><td>The size of the whole grid on the z axis </td></tr>
  236. </table>
  237. </dd>
  238. </dl>
  239. </div>
  240. </div>
  241. <h2 class="groupheader">Member Function Documentation</h2>
  242. <a class="anchor" id="a6597c4f785a764c0b291b8135863fe67"></a>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">void util::Grid::Convolve2D </td>
  248. <td>(</td>
  249. <td class="paramtype">int&#160;</td>
  250. <td class="paramname"><em>vicinity</em>, </td>
  251. </tr>
  252. <tr>
  253. <td class="paramkey"></td>
  254. <td></td>
  255. <td class="paramtype">double *&#160;</td>
  256. <td class="paramname"><em>mask</em>, </td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey"></td>
  260. <td></td>
  261. <td class="paramtype">double&#160;</td>
  262. <td class="paramname"><em>multiplier</em>&#160;</td>
  263. </tr>
  264. <tr>
  265. <td></td>
  266. <td>)</td>
  267. <td></td><td></td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Performs a 2D convolution.</p>
  272. <dl class="params"><dt>Parameters</dt><dd>
  273. <table class="params">
  274. <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>
  275. <tr><td class="paramname">mask</td><td>The mask/kernel to use for the convolution </td></tr>
  276. <tr><td class="paramname">multiplier</td><td>The value is multiplied with the result at the end of the convolution </td></tr>
  277. </table>
  278. </dd>
  279. </dl>
  280. </div>
  281. </div>
  282. <a class="anchor" id="ab8e9f6c804b0eab1f5666a039130b8ed"></a>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">void util::Grid::Convolve2D </td>
  288. <td>(</td>
  289. <td class="paramtype"><a class="el" href="classutil_1_1Filter2D.html">util::Filter2D</a> &amp;&#160;</td>
  290. <td class="paramname"><em>filter</em></td><td>)</td>
  291. <td></td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Performs a 2D convolution.</p>
  296. <dl class="params"><dt>Parameters</dt><dd>
  297. <table class="params">
  298. <tr><td class="paramname">filter</td><td>The 2D filter to use </td></tr>
  299. </table>
  300. </dd>
  301. </dl>
  302. </div>
  303. </div>
  304. <a class="anchor" id="ac161adb14df09651a6b33f855d887bfa"></a>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname">void util::Grid::Convolve3D </td>
  310. <td>(</td>
  311. <td class="paramtype">int&#160;</td>
  312. <td class="paramname"><em>vicinity</em>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">double *&#160;</td>
  318. <td class="paramname"><em>mask</em>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype">double&#160;</td>
  324. <td class="paramname"><em>multiplier</em>&#160;</td>
  325. </tr>
  326. <tr>
  327. <td></td>
  328. <td>)</td>
  329. <td></td><td></td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Performs a 3D convolution.</p>
  334. <dl class="params"><dt>Parameters</dt><dd>
  335. <table class="params">
  336. <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>
  337. <tr><td class="paramname">mask</td><td>The mask/kernel to use for the convolution </td></tr>
  338. <tr><td class="paramname">multiplier</td><td>The value is multiplied with the result at the end of the convolution </td></tr>
  339. </table>
  340. </dd>
  341. </dl>
  342. </div>
  343. </div>
  344. <a class="anchor" id="afe6698a6766a43082ceea2d4bf27619e"></a>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">double util::Grid::GetDepth </td>
  350. <td>(</td>
  351. <td class="paramname"></td><td>)</td>
  352. <td> const</td>
  353. </tr>
  354. </table>
  355. </div><div class="memdoc">
  356. <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>
  357. </div>
  358. </div>
  359. <a class="anchor" id="a04f1c2fe745d469e49cf2523fe0f34fd"></a>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="memname">
  363. <tr>
  364. <td class="memname">int util::Grid::GetDepthCount </td>
  365. <td>(</td>
  366. <td class="paramname"></td><td>)</td>
  367. <td> const</td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. <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>
  372. </div>
  373. </div>
  374. <a class="anchor" id="a2d02a1eafe76faaa7e0f63ce406d782f"></a>
  375. <div class="memitem">
  376. <div class="memproto">
  377. <table class="memname">
  378. <tr>
  379. <td class="memname">double util::Grid::GetHeight </td>
  380. <td>(</td>
  381. <td class="paramname"></td><td>)</td>
  382. <td> const</td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <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>
  387. </div>
  388. </div>
  389. <a class="anchor" id="a0c63eb86e4be8c63e996ff61c3ef8b7f"></a>
  390. <div class="memitem">
  391. <div class="memproto">
  392. <table class="memname">
  393. <tr>
  394. <td class="memname">int util::Grid::GetHeightCount </td>
  395. <td>(</td>
  396. <td class="paramname"></td><td>)</td>
  397. <td> const</td>
  398. </tr>
  399. </table>
  400. </div><div class="memdoc">
  401. <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>
  402. </div>
  403. </div>
  404. <a class="anchor" id="a6658334ae9b505c56b75f6f15434832e"></a>
  405. <div class="memitem">
  406. <div class="memproto">
  407. <table class="memname">
  408. <tr>
  409. <td class="memname">core::ObjectDataPtr util::Grid::GetValue </td>
  410. <td>(</td>
  411. <td class="paramtype">int&#160;</td>
  412. <td class="paramname"><em>x</em>, </td>
  413. </tr>
  414. <tr>
  415. <td class="paramkey"></td>
  416. <td></td>
  417. <td class="paramtype">int&#160;</td>
  418. <td class="paramname"><em>y</em>, </td>
  419. </tr>
  420. <tr>
  421. <td class="paramkey"></td>
  422. <td></td>
  423. <td class="paramtype">int&#160;</td>
  424. <td class="paramname"><em>z</em> = <code>0</code>&#160;</td>
  425. </tr>
  426. <tr>
  427. <td></td>
  428. <td>)</td>
  429. <td></td><td> const</td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. <p>Gets the value in the grid cell with the given index. </p><dl class="params"><dt>Parameters</dt><dd>
  434. <table class="params">
  435. <tr><td class="paramname">x</td><td>The x axis index </td></tr>
  436. <tr><td class="paramname">y</td><td>The y axis index </td></tr>
  437. <tr><td class="paramname">z</td><td>The z axis index </td></tr>
  438. </table>
  439. </dd>
  440. </dl>
  441. <dl class="section return"><dt>Returns</dt><dd>The value in the grid cell </dd></dl>
  442. </div>
  443. </div>
  444. <a class="anchor" id="a6cc6449dfe16dde11035fe2d16a321cd"></a>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname">core::ObjectDataPtr util::Grid::GetValue </td>
  450. <td>(</td>
  451. <td class="paramtype">double&#160;</td>
  452. <td class="paramname"><em>x</em>, </td>
  453. </tr>
  454. <tr>
  455. <td class="paramkey"></td>
  456. <td></td>
  457. <td class="paramtype">double&#160;</td>
  458. <td class="paramname"><em>y</em>, </td>
  459. </tr>
  460. <tr>
  461. <td class="paramkey"></td>
  462. <td></td>
  463. <td class="paramtype">double&#160;</td>
  464. <td class="paramname"><em>z</em> = <code>0.0</code>&#160;</td>
  465. </tr>
  466. <tr>
  467. <td></td>
  468. <td>)</td>
  469. <td></td><td> const</td>
  470. </tr>
  471. </table>
  472. </div><div class="memdoc">
  473. <p>Gets the value in the grid cell at the given position. </p><dl class="params"><dt>Parameters</dt><dd>
  474. <table class="params">
  475. <tr><td class="paramname">x</td><td>The x axis value </td></tr>
  476. <tr><td class="paramname">y</td><td>The y axis value </td></tr>
  477. <tr><td class="paramname">z</td><td>The z axis value </td></tr>
  478. </table>
  479. </dd>
  480. </dl>
  481. <dl class="section return"><dt>Returns</dt><dd>The value in the grid cell </dd></dl>
  482. </div>
  483. </div>
  484. <a class="anchor" id="a8b4dc63bee5859cae315969e039b4cac"></a>
  485. <div class="memitem">
  486. <div class="memproto">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">double util::Grid::GetWidth </td>
  490. <td>(</td>
  491. <td class="paramname"></td><td>)</td>
  492. <td> const</td>
  493. </tr>
  494. </table>
  495. </div><div class="memdoc">
  496. <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>
  497. </div>
  498. </div>
  499. <a class="anchor" id="a3f5cdd325b3e3eb30ca5d38bd31d005e"></a>
  500. <div class="memitem">
  501. <div class="memproto">
  502. <table class="memname">
  503. <tr>
  504. <td class="memname">int util::Grid::GetWidthCount </td>
  505. <td>(</td>
  506. <td class="paramname"></td><td>)</td>
  507. <td> const</td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <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>
  512. </div>
  513. </div>
  514. <a class="anchor" id="a775e2a7574c81dd7acd1d185b2e72ed5"></a>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">void util::Grid::PositionToIndex </td>
  520. <td>(</td>
  521. <td class="paramtype">double&#160;</td>
  522. <td class="paramname"><em>x</em>, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype">double&#160;</td>
  528. <td class="paramname"><em>y</em>, </td>
  529. </tr>
  530. <tr>
  531. <td class="paramkey"></td>
  532. <td></td>
  533. <td class="paramtype">double&#160;</td>
  534. <td class="paramname"><em>z</em>, </td>
  535. </tr>
  536. <tr>
  537. <td class="paramkey"></td>
  538. <td></td>
  539. <td class="paramtype">int &amp;&#160;</td>
  540. <td class="paramname"><em>xi</em>, </td>
  541. </tr>
  542. <tr>
  543. <td class="paramkey"></td>
  544. <td></td>
  545. <td class="paramtype">int &amp;&#160;</td>
  546. <td class="paramname"><em>yi</em>, </td>
  547. </tr>
  548. <tr>
  549. <td class="paramkey"></td>
  550. <td></td>
  551. <td class="paramtype">int &amp;&#160;</td>
  552. <td class="paramname"><em>zi</em>&#160;</td>
  553. </tr>
  554. <tr>
  555. <td></td>
  556. <td>)</td>
  557. <td></td><td> const</td>
  558. </tr>
  559. </table>
  560. </div><div class="memdoc">
  561. <p>Converts a 3D position to an 3D index. </p><dl class="params"><dt>Parameters</dt><dd>
  562. <table class="params">
  563. <tr><td class="paramname">x</td><td>The x axis value </td></tr>
  564. <tr><td class="paramname">y</td><td>The y axis value </td></tr>
  565. <tr><td class="paramname">z</td><td>The z axis value </td></tr>
  566. <tr><td class="paramname">xi</td><td>The x axis index </td></tr>
  567. <tr><td class="paramname">yi</td><td>The y axis index </td></tr>
  568. <tr><td class="paramname">zi</td><td>The z axis index </td></tr>
  569. </table>
  570. </dd>
  571. </dl>
  572. </div>
  573. </div>
  574. <a class="anchor" id="a0e93bd63922e7cbe405176a1ae21877e"></a>
  575. <div class="memitem">
  576. <div class="memproto">
  577. <table class="memname">
  578. <tr>
  579. <td class="memname">void util::Grid::SetValue </td>
  580. <td>(</td>
  581. <td class="paramtype">core::ObjectDataPtr&#160;</td>
  582. <td class="paramname"><em>value</em>, </td>
  583. </tr>
  584. <tr>
  585. <td class="paramkey"></td>
  586. <td></td>
  587. <td class="paramtype">int&#160;</td>
  588. <td class="paramname"><em>x</em>, </td>
  589. </tr>
  590. <tr>
  591. <td class="paramkey"></td>
  592. <td></td>
  593. <td class="paramtype">int&#160;</td>
  594. <td class="paramname"><em>y</em>, </td>
  595. </tr>
  596. <tr>
  597. <td class="paramkey"></td>
  598. <td></td>
  599. <td class="paramtype">int&#160;</td>
  600. <td class="paramname"><em>z</em> = <code>0</code>&#160;</td>
  601. </tr>
  602. <tr>
  603. <td></td>
  604. <td>)</td>
  605. <td></td><td></td>
  606. </tr>
  607. </table>
  608. </div><div class="memdoc">
  609. <p>Sets a value in the grid cell with the given index. </p><dl class="params"><dt>Parameters</dt><dd>
  610. <table class="params">
  611. <tr><td class="paramname">value</td><td>The value to set </td></tr>
  612. <tr><td class="paramname">x</td><td>The x axis index </td></tr>
  613. <tr><td class="paramname">y</td><td>The y axis index </td></tr>
  614. <tr><td class="paramname">z</td><td>The z axis index </td></tr>
  615. </table>
  616. </dd>
  617. </dl>
  618. </div>
  619. </div>
  620. <a class="anchor" id="ad7dbf79146d9f5ae1662910b82fd25ea"></a>
  621. <div class="memitem">
  622. <div class="memproto">
  623. <table class="memname">
  624. <tr>
  625. <td class="memname">void util::Grid::SetValue </td>
  626. <td>(</td>
  627. <td class="paramtype">core::ObjectDataPtr&#160;</td>
  628. <td class="paramname"><em>value</em>, </td>
  629. </tr>
  630. <tr>
  631. <td class="paramkey"></td>
  632. <td></td>
  633. <td class="paramtype">double&#160;</td>
  634. <td class="paramname"><em>x</em>, </td>
  635. </tr>
  636. <tr>
  637. <td class="paramkey"></td>
  638. <td></td>
  639. <td class="paramtype">double&#160;</td>
  640. <td class="paramname"><em>y</em>, </td>
  641. </tr>
  642. <tr>
  643. <td class="paramkey"></td>
  644. <td></td>
  645. <td class="paramtype">double&#160;</td>
  646. <td class="paramname"><em>z</em> = <code>0</code>&#160;</td>
  647. </tr>
  648. <tr>
  649. <td></td>
  650. <td>)</td>
  651. <td></td><td></td>
  652. </tr>
  653. </table>
  654. </div><div class="memdoc">
  655. <p>Sets a value in the grid cell at the given position. </p><dl class="params"><dt>Parameters</dt><dd>
  656. <table class="params">
  657. <tr><td class="paramname">value</td><td>The value to set </td></tr>
  658. <tr><td class="paramname">x</td><td>The x axis value </td></tr>
  659. <tr><td class="paramname">y</td><td>The y axis value </td></tr>
  660. <tr><td class="paramname">z</td><td>The z axis value </td></tr>
  661. </table>
  662. </dd>
  663. </dl>
  664. </div>
  665. </div>
  666. <hr/>The documentation for this class was generated from the following files:<ul>
  667. <li>util/<a class="el" href="Grid_8h_source.html">Grid.h</a></li>
  668. <li>util/Grid.cpp</li>
  669. </ul>
  670. </div><!-- contents -->
  671. <!-- start footer part -->
  672. <hr class="footer"/><address class="footer"><small>
  673. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  674. <img class="footer" src="doxygen.png" alt="doxygen"/>
  675. </a> 1.8.12
  676. </small></address>
  677. </body>
  678. </html>