123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.12"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Tracore: util::Grid Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { init_search(); });
- </script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">Tracore
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.12 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><b>util</b></li><li class="navelem"><a class="el" href="classutil_1_1Grid.html">Grid</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="classutil_1_1Grid-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">util::Grid Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <<a class="el" href="Grid_8h_source.html">Grid.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a0b2bfd0044eb5633a3f1121e5e70709e"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="separator:a0b2bfd0044eb5633a3f1121e5e70709e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad6457dda588e20ccd503e363e96dd57e"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="separator:ad6457dda588e20ccd503e363e96dd57e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e93bd63922e7cbe405176a1ae21877e"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:a0e93bd63922e7cbe405176a1ae21877e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad7dbf79146d9f5ae1662910b82fd25ea"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:ad7dbf79146d9f5ae1662910b82fd25ea"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6658334ae9b505c56b75f6f15434832e"><td class="memItemLeft" align="right" valign="top">core::ObjectDataPtr </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>
- <tr class="separator:a6658334ae9b505c56b75f6f15434832e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6cc6449dfe16dde11035fe2d16a321cd"><td class="memItemLeft" align="right" valign="top">core::ObjectDataPtr </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>
- <tr class="separator:a6cc6449dfe16dde11035fe2d16a321cd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f5cdd325b3e3eb30ca5d38bd31d005e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a3f5cdd325b3e3eb30ca5d38bd31d005e">GetWidthCount</a> () const</td></tr>
- <tr class="separator:a3f5cdd325b3e3eb30ca5d38bd31d005e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0c63eb86e4be8c63e996ff61c3ef8b7f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a0c63eb86e4be8c63e996ff61c3ef8b7f">GetHeightCount</a> () const</td></tr>
- <tr class="separator:a0c63eb86e4be8c63e996ff61c3ef8b7f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a04f1c2fe745d469e49cf2523fe0f34fd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a04f1c2fe745d469e49cf2523fe0f34fd">GetDepthCount</a> () const</td></tr>
- <tr class="separator:a04f1c2fe745d469e49cf2523fe0f34fd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8b4dc63bee5859cae315969e039b4cac"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a8b4dc63bee5859cae315969e039b4cac">GetWidth</a> () const</td></tr>
- <tr class="separator:a8b4dc63bee5859cae315969e039b4cac"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2d02a1eafe76faaa7e0f63ce406d782f"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a2d02a1eafe76faaa7e0f63ce406d782f">GetHeight</a> () const</td></tr>
- <tr class="separator:a2d02a1eafe76faaa7e0f63ce406d782f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afe6698a6766a43082ceea2d4bf27619e"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#afe6698a6766a43082ceea2d4bf27619e">GetDepth</a> () const</td></tr>
- <tr class="separator:afe6698a6766a43082ceea2d4bf27619e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a775e2a7574c81dd7acd1d185b2e72ed5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1Grid.html#a775e2a7574c81dd7acd1d185b2e72ed5">PositionToIndex</a> (double x, double y, double z, int &xi, int &yi, int &zi) const</td></tr>
- <tr class="separator:a775e2a7574c81dd7acd1d185b2e72ed5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6597c4f785a764c0b291b8135863fe67"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:a6597c4f785a764c0b291b8135863fe67"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab8e9f6c804b0eab1f5666a039130b8ed"><td class="memItemLeft" align="right" valign="top">void </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> &filter)</td></tr>
- <tr class="separator:ab8e9f6c804b0eab1f5666a039130b8ed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac161adb14df09651a6b33f855d887bfa"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:ac161adb14df09651a6b33f855d887bfa"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <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>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a class="anchor" id="a0b2bfd0044eb5633a3f1121e5e70709e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">util::Grid::Grid </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width_count</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height_count</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>height</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Creates a new two dimensional grid. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">width_count</td><td>The number of elements on the x axis </td></tr>
- <tr><td class="paramname">height_count</td><td>The number of elements on the y axis </td></tr>
- <tr><td class="paramname">width</td><td>The size of the whole grid on the x axis </td></tr>
- <tr><td class="paramname">height</td><td>The size of the whole grid on the y axis </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ad6457dda588e20ccd503e363e96dd57e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">util::Grid::Grid </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width_count</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height_count</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>depth_count</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>depth</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Creates a new three dimensional grid. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">width_count</td><td>The number of elements on the x axis </td></tr>
- <tr><td class="paramname">height_count</td><td>The number of elements on the y axis </td></tr>
- <tr><td class="paramname">depth_count</td><td>The number of elements on the z axis </td></tr>
- <tr><td class="paramname">width</td><td>The size of the whole grid on the x axis </td></tr>
- <tr><td class="paramname">height</td><td>The size of the whole grid on the y axis </td></tr>
- <tr><td class="paramname">depth</td><td>The size of the whole grid on the z axis </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a6597c4f785a764c0b291b8135863fe67"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void util::Grid::Convolve2D </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>vicinity</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double * </td>
- <td class="paramname"><em>mask</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>multiplier</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Performs a 2D convolution.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- <tr><td class="paramname">mask</td><td>The mask/kernel to use for the convolution </td></tr>
- <tr><td class="paramname">multiplier</td><td>The value is multiplied with the result at the end of the convolution </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ab8e9f6c804b0eab1f5666a039130b8ed"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void util::Grid::Convolve2D </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classutil_1_1Filter2D.html">util::Filter2D</a> & </td>
- <td class="paramname"><em>filter</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Performs a 2D convolution.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">filter</td><td>The 2D filter to use </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ac161adb14df09651a6b33f855d887bfa"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void util::Grid::Convolve3D </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>vicinity</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double * </td>
- <td class="paramname"><em>mask</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>multiplier</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Performs a 3D convolution.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- <tr><td class="paramname">mask</td><td>The mask/kernel to use for the convolution </td></tr>
- <tr><td class="paramname">multiplier</td><td>The value is multiplied with the result at the end of the convolution </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="afe6698a6766a43082ceea2d4bf27619e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">double util::Grid::GetDepth </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a04f1c2fe745d469e49cf2523fe0f34fd"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int util::Grid::GetDepthCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a2d02a1eafe76faaa7e0f63ce406d782f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">double util::Grid::GetHeight </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a0c63eb86e4be8c63e996ff61c3ef8b7f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int util::Grid::GetHeightCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a6658334ae9b505c56b75f6f15434832e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">core::ObjectDataPtr util::Grid::GetValue </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>z</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the value in the grid cell with the given index. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">x</td><td>The x axis index </td></tr>
- <tr><td class="paramname">y</td><td>The y axis index </td></tr>
- <tr><td class="paramname">z</td><td>The z axis index </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The value in the grid cell </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a6cc6449dfe16dde11035fe2d16a321cd"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">core::ObjectDataPtr util::Grid::GetValue </td>
- <td>(</td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>y</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>z</em> = <code>0.0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the value in the grid cell at the given position. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">x</td><td>The x axis value </td></tr>
- <tr><td class="paramname">y</td><td>The y axis value </td></tr>
- <tr><td class="paramname">z</td><td>The z axis value </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The value in the grid cell </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a8b4dc63bee5859cae315969e039b4cac"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">double util::Grid::GetWidth </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a3f5cdd325b3e3eb30ca5d38bd31d005e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int util::Grid::GetWidthCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a775e2a7574c81dd7acd1d185b2e72ed5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void util::Grid::PositionToIndex </td>
- <td>(</td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>y</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>z</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int & </td>
- <td class="paramname"><em>xi</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int & </td>
- <td class="paramname"><em>yi</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int & </td>
- <td class="paramname"><em>zi</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Converts a 3D position to an 3D index. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">x</td><td>The x axis value </td></tr>
- <tr><td class="paramname">y</td><td>The y axis value </td></tr>
- <tr><td class="paramname">z</td><td>The z axis value </td></tr>
- <tr><td class="paramname">xi</td><td>The x axis index </td></tr>
- <tr><td class="paramname">yi</td><td>The y axis index </td></tr>
- <tr><td class="paramname">zi</td><td>The z axis index </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a0e93bd63922e7cbe405176a1ae21877e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void util::Grid::SetValue </td>
- <td>(</td>
- <td class="paramtype">core::ObjectDataPtr </td>
- <td class="paramname"><em>value</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>z</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets a value in the grid cell with the given index. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">value</td><td>The value to set </td></tr>
- <tr><td class="paramname">x</td><td>The x axis index </td></tr>
- <tr><td class="paramname">y</td><td>The y axis index </td></tr>
- <tr><td class="paramname">z</td><td>The z axis index </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ad7dbf79146d9f5ae1662910b82fd25ea"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void util::Grid::SetValue </td>
- <td>(</td>
- <td class="paramtype">core::ObjectDataPtr </td>
- <td class="paramname"><em>value</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>y</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>z</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets a value in the grid cell at the given position. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">value</td><td>The value to set </td></tr>
- <tr><td class="paramname">x</td><td>The x axis value </td></tr>
- <tr><td class="paramname">y</td><td>The y axis value </td></tr>
- <tr><td class="paramname">z</td><td>The z axis value </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>util/<a class="el" href="Grid_8h_source.html">Grid.h</a></li>
- <li>util/Grid.cpp</li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.12
- </small></address>
- </body>
- </html>
|