<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CGridPlaneXY.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<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><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CGridPlaneXY.h</div> </div>
</div>
<div class="contents">
<a href="_c_grid_plane_x_y_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef opengl_CGridPlaneXY_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define opengl_CGridPlaneXY_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="_c_renderizable_display_list_8h.html">mrpt/opengl/CRenderizableDisplayList.h</a>></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>mrpt
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keyword">namespace </span>opengl
<a name="l00037"></a>00037 {
<a name="l00038"></a><a class="code" href="namespacemrpt_1_1opengl.html#a2795cb42890012bf3db2e5cf7e549669">00038</a> <span class="keyword">class </span><a class="code" href="opengl_2include_2mrpt_2opengl_2link__pragmas_8h.html#af6a1c8d5d6b3c8c0af00dbeef88ce269">OPENGL_IMPEXP</a> <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html" title="A grid of lines over the XY plane.">CGridPlaneXY</a>;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">// This must be added to any CSerializable derived class:</span>
<a name="l00041"></a><a class="code" href="structmrpt_1_1opengl_1_1_c_grid_plane_x_y_ptr.html#a324928d859da81da252f7270756f8c28">00041</a> <a class="code" href="_c_serializable_8h.html#a9ef523d787f6cb837a0585b790882588" title="This declaration must be inserted in all CSerializable classes definition, before the class declarati...">DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE_LINKAGE</a>( <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html" title="A grid of lines over the XY plane.">CGridPlaneXY</a> , <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html" title="A renderizable object suitable for rendering with OpenGL's display lists.">CRenderizableDisplayList</a>, <a class="code" href="opengl_2include_2mrpt_2opengl_2link__pragmas_8h.html#af6a1c8d5d6b3c8c0af00dbeef88ce269">OPENGL_IMPEXP</a> )
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">/** A grid of lines over the XY plane.</span>
<a name="l00044"></a>00044 <span class="comment"> * \sa opengl::COpenGLScene</span>
<a name="l00045"></a>00045 <span class="comment"> * </span>
<a name="l00046"></a>00046 <span class="comment"> * <div align="center"></span>
<a name="l00047"></a>00047 <span class="comment"> * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px; border-style: solid;"></span>
<a name="l00048"></a>00048 <span class="comment"> * <tr> <td> mrpt::opengl::CGridPlaneXY </td> <td> \image html preview_CGridPlaneXY.png </td> </tr></span>
<a name="l00049"></a>00049 <span class="comment"> * </table></span>
<a name="l00050"></a>00050 <span class="comment"> * </div></span>
<a name="l00051"></a>00051 <span class="comment"> * </span>
<a name="l00052"></a>00052 <span class="comment"> * \ingroup mrpt_opengl_grp</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a>00054 class <a class="code" href="opengl_2include_2mrpt_2opengl_2link__pragmas_8h.html#af6a1c8d5d6b3c8c0af00dbeef88ce269">OPENGL_IMPEXP</a> <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html" title="A grid of lines over the XY plane.">CGridPlaneXY</a> : public <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html" title="A renderizable object suitable for rendering with OpenGL's display lists.">CRenderizableDisplayList</a>
<a name="l00055"></a>00055 {
<a name="l00056"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a013cde6ec55d7c634d5da40422e4f6d5">00056</a> <a class="code" href="_c_serializable_8h.html#a72ab55bf7ae009c89b75715cfa21e84d" title="This declaration must be inserted in all CSerializable classes definition, within the class declarati...">DEFINE_SERIALIZABLE</a>( <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html" title="A grid of lines over the XY plane.">CGridPlaneXY</a> )
<a name="l00057"></a>00057
<a name="l00058"></a>00058 protected:
<a name="l00059"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a3185427dc00022401654631c9b3c7a8d">00059</a> <span class="keywordtype">float</span> m_xMin, m_xMax;
<a name="l00060"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a7f7f6d80fed7c309345d76c2be7b9da9">00060</a> <span class="keywordtype">float</span> m_yMin, m_yMax;
<a name="l00061"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a07087ad14aa7072b3d27746c4d1812ad">00061</a> <span class="keywordtype">float</span> m_plane_z;
<a name="l00062"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#ac078df69991d8708cbb00756a7a9ec1d">00062</a> <span class="keywordtype">float</span> m_frequency;
<a name="l00063"></a>00063
<a name="l00064"></a>00064
<a name="l00065"></a>00065 public:
<a name="l00066"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a9b629492e05a318fec256d0f6959d78b">00066</a> <span class="keywordtype">void</span> setPlaneLimits(<span class="keywordtype">float</span> xmin,<span class="keywordtype">float</span> xmax, <span class="keywordtype">float</span> ymin, <span class="keywordtype">float</span> ymax)
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068 m_xMin=xmin; m_xMax = xmax;
<a name="l00069"></a>00069 m_yMin=ymin; m_yMax = ymax;
<a name="l00070"></a>00070 <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a77f8b97d7f4937b3f0777b76bc0ddf7a" title="Must be called to notify that the object has changed (so, the display list must be updated)...">CRenderizableDisplayList::notifyChange</a>();
<a name="l00071"></a>00071 }
<a name="l00072"></a>00072
<a name="l00073"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a1c82c7a9661507d72630a644bc8266f6">00073</a> <span class="keywordtype">void</span> getPlaneLimits(<span class="keywordtype">float</span> &xmin,<span class="keywordtype">float</span> &xmax, <span class="keywordtype">float</span> &ymin, <span class="keywordtype">float</span> &ymax)<span class="keyword"> const</span>
<a name="l00074"></a>00074 <span class="keyword"> </span>{
<a name="l00075"></a>00075 xmin=m_xMin; xmax=m_xMax;
<a name="l00076"></a>00076 ymin=m_yMin; ymax=m_yMax;
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078
<a name="l00079"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#af33cff7b9cb53f8278defc1018cdf413">00079</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#af33cff7b9cb53f8278defc1018cdf413">setPlaneZcoord</a>(<span class="keywordtype">float</span> z) { <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a77f8b97d7f4937b3f0777b76bc0ddf7a" title="Must be called to notify that the object has changed (so, the display list must be updated)...">CRenderizableDisplayList::notifyChange</a>(); m_plane_z=z; }
<a name="l00080"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#ab6f92496f32dfbf864bbaa4961034fc3">00080</a> <span class="keywordtype">float</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#ab6f92496f32dfbf864bbaa4961034fc3">getPlaneZcoord</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_plane_z; }
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a088125e9b22a88cf91a01ad61e0314fb">00082</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a088125e9b22a88cf91a01ad61e0314fb">setGridFrequency</a>(<span class="keywordtype">float</span> freq) { <a class="code" href="mrpt__macros_8h.html#a47eb5a445c2bf3d9190396510ea9683e">ASSERT_</a>(freq>0); m_frequency=freq; <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a77f8b97d7f4937b3f0777b76bc0ddf7a" title="Must be called to notify that the object has changed (so, the display list must be updated)...">CRenderizableDisplayList::notifyChange</a>(); }
<a name="l00083"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a118acf01ee70ea827c6d23397f706d8b">00083</a> <span class="keywordtype">float</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a118acf01ee70ea827c6d23397f706d8b">getGridFrequency</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_frequency; }
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** Render */</span>
<a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">void</span> render_dl() <span class="keyword">const</span>;
<a name="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"> /** Class factory */</span>
<a name="l00090"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#ab91bf3bc8cbf1c939e3e358574a45f5b">00090</a> <span class="keyword">static</span> <a class="code" href="structmrpt_1_1opengl_1_1_c_grid_plane_x_y_ptr.html">CGridPlaneXYPtr</a> Create(
<a name="l00091"></a>00091 <span class="keywordtype">float</span> xMin,
<a name="l00092"></a>00092 <span class="keywordtype">float</span> xMax,
<a name="l00093"></a>00093 <span class="keywordtype">float</span> yMin,
<a name="l00094"></a>00094 <span class="keywordtype">float</span> yMax,
<a name="l00095"></a>00095 <span class="keywordtype">float</span> z = 0,
<a name="l00096"></a>00096 <span class="keywordtype">float</span> frequency = 1 )
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 <span class="keywordflow">return</span> <a class="code" href="structmrpt_1_1opengl_1_1_c_grid_plane_x_y_ptr.html">CGridPlaneXYPtr</a>( <span class="keyword">new</span> <a class="code" href="namespacemrpt_1_1opengl.html#a2795cb42890012bf3db2e5cf7e549669">CGridPlaneXY</a>(
<a name="l00099"></a>00099 xMin,
<a name="l00100"></a>00100 xMax,
<a name="l00101"></a>00101 yMin,
<a name="l00102"></a>00102 yMax,
<a name="l00103"></a>00103 z,
<a name="l00104"></a>00104 frequency ) );
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment"> /** Constructor</span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#ac55674fd052489d5afe872118464c2b2">00111</a> <a class="code" href="namespacemrpt_1_1opengl.html#a2795cb42890012bf3db2e5cf7e549669">CGridPlaneXY</a>(
<a name="l00112"></a>00112 <span class="keywordtype">float</span> xMin = -10,
<a name="l00113"></a>00113 <span class="keywordtype">float</span> xMax = 10 ,
<a name="l00114"></a>00114 <span class="keywordtype">float</span> yMin = -10,
<a name="l00115"></a>00115 <span class="keywordtype">float</span> yMax = 10,
<a name="l00116"></a>00116 <span class="keywordtype">float</span> z = 0,
<a name="l00117"></a>00117 <span class="keywordtype">float</span> frequency = 1
<a name="l00118"></a>00118 ) :
<a name="l00119"></a>00119 m_xMin(xMin),
<a name="l00120"></a>00120 m_xMax(xMax),
<a name="l00121"></a>00121 m_yMin(yMin),
<a name="l00122"></a>00122 m_yMax(yMax),
<a name="l00123"></a>00123 m_plane_z(z),
<a name="l00124"></a>00124 m_frequency(frequency)
<a name="l00125"></a>00125 {
<a name="l00126"></a>00126 }<span class="comment"></span>
<a name="l00127"></a>00127 <span class="comment"> /** Private, virtual destructor: only can be deleted from smart pointers */</span>
<a name="l00128"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a63ea30506ddc24daac9fa3e4ecc7ed25">00128</a> <span class="keyword">virtual</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_grid_plane_x_y.html#a63ea30506ddc24daac9fa3e4ecc7ed25" title="Private, virtual destructor: only can be deleted from smart pointers.">~CGridPlaneXY</a>() { }
<a name="l00129"></a>00129 };
<a name="l00130"></a>00130
<a name="l00131"></a>00131 } <span class="comment">// end namespace</span>
<a name="l00132"></a>00132
<a name="l00133"></a>00133 } <span class="comment">// End of namespace</span>
<a name="l00134"></a>00134
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
