Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 2f6559b7006594cad03af173263c219e > files > 186

mrpt-doc-0.9.4-0.1.20110110svn2383.fc15.i686.rpm

<!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>The MRPT project: CAxis.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> &gt; <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.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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 id="searchli">
        <div id="MSearchBox" class="MSearchBoxInactive">
          <span 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>
          </span><span class="right"></span>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<h1>CAxis.h</h1>  </div>
</div>
<div class="contents">
<a href="_c_axis_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://mrpt.sourceforge.net/                            |</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  &lt;jlblanco@ctima.uma.es&gt;                     |</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 &lt;http://www.gnu.org/licenses/&gt;.         |</span>
<a name="l00026"></a>00026 <span class="comment">   |                                                                           |</span>
<a name="l00027"></a>00027 <span class="comment">   +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef opengl_CAxis_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define opengl_CAxis_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;<a class="code" href="_c_renderizable_display_list_8h.html">mrpt/opengl/CRenderizableDisplayList.h</a>&gt;</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">namespace </span>mrpt
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035         <span class="keyword">namespace </span>opengl
<a name="l00036"></a>00036         {
<a name="l00037"></a><a class="code" href="namespacemrpt_1_1opengl.html#af6d6df8c41d51920bad5a8d49365e0b8">00037</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_axis.html" title="Draw a 3D world axis, with coordinate marks at some regular interval.">CAxis</a>;
<a name="l00038"></a>00038 
<a name="l00039"></a>00039                 <span class="comment">// This must be added to any CSerializable derived class:</span>
<a name="l00040"></a><a class="code" href="structmrpt_1_1opengl_1_1_c_axis_ptr.html#ac542fa22c36275d28ed014547d48828f">00040</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_axis.html" title="Draw a 3D world axis, with coordinate marks at some regular interval.">CAxis</a>, <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html" title="A renderizable object suitable for rendering with OpenGL&amp;#39;s display lists.">CRenderizableDisplayList</a>, <a class="code" href="opengl_2include_2mrpt_2opengl_2link__pragmas_8h.html#af6a1c8d5d6b3c8c0af00dbeef88ce269">OPENGL_IMPEXP</a> )
<a name="l00041"></a>00041 
<a name="l00042"></a>00042                 <span class="comment">/** Draw a 3D world axis, with coordinate marks at some regular interval</span>
<a name="l00043"></a>00043 <span class="comment">                  *  \sa opengl::COpenGLScene</span>
<a name="l00044"></a>00044 <span class="comment">                  *  </span>
<a name="l00045"></a>00045 <span class="comment">                  *  &lt;div align=&quot;center&quot;&gt;</span>
<a name="l00046"></a>00046 <span class="comment">                  *  &lt;table border=&quot;0&quot; cellspan=&quot;4&quot; cellspacing=&quot;4&quot; style=&quot;border-width: 1px; border-style: solid;&quot;&gt;</span>
<a name="l00047"></a>00047 <span class="comment">                  *  &lt;tr&gt; &lt;td&gt; mrpt::opengl::CAxis &lt;/td&gt; &lt;td&gt; \image html preview_CAxis.png &lt;/td&gt; &lt;/tr&gt;</span>
<a name="l00048"></a>00048 <span class="comment">                  *  &lt;/table&gt;</span>
<a name="l00049"></a>00049 <span class="comment">                  *  &lt;/div&gt;</span>
<a name="l00050"></a>00050 <span class="comment">                  *  </span>
<a name="l00051"></a>00051 <span class="comment">                  */</span>
<a name="l00052"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html">00052</a>                 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_axis.html" title="Draw a 3D world axis, with coordinate marks at some regular interval.">CAxis</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&amp;#39;s display lists.">CRenderizableDisplayList</a>
<a name="l00053"></a>00053                 {
<a name="l00054"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a5c8150688289c63ffa09e5c863150fc0">00054</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_axis.html" title="Draw a 3D world axis, with coordinate marks at some regular interval.">CAxis</a> )
<a name="l00055"></a>00055                 protected:
<a name="l00056"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a083e3b1fd9b862c6f6015980ce8023c1">00056</a>                         <span class="keywordtype">float</span>   m_xmin,m_ymin,m_zmin;
<a name="l00057"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a8d3de19d5cdf52451933ee736d726cd3">00057</a>                         <span class="keywordtype">float</span>   m_xmax,m_ymax,m_zmax;
<a name="l00058"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#ad96c8ad4f1f1a8c6ae96715e49ef9216">00058</a>                         <span class="keywordtype">float</span>   m_frecuency;
<a name="l00059"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a5339259983ac9defcff23ef1240d416f">00059</a>             <span class="keywordtype">float</span>       m_lineWidth;
<a name="l00060"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#ae849854417b79e9a6a589b66ecc28432">00060</a>                         <span class="keywordtype">bool</span>    m_marks;
<a name="l00061"></a>00061 
<a name="l00062"></a>00062                 public:
<a name="l00063"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#ad581098ddc633459a1c1adfd96d054fb">00063</a>                         <span class="keywordtype">void</span> setAxisLimits(<span class="keywordtype">float</span> xmin,<span class="keywordtype">float</span> ymin, <span class="keywordtype">float</span> zmin, <span class="keywordtype">float</span> xmax,<span class="keywordtype">float</span> ymax, <span class="keywordtype">float</span> zmax)
<a name="l00064"></a>00064                         {
<a name="l00065"></a>00065                                 m_xmin=xmin; m_ymin=ymin; m_zmin=zmin;
<a name="l00066"></a>00066                                 m_xmax=xmax; m_ymax=ymax; m_zmax=zmax;
<a name="l00067"></a>00067                                 <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="l00068"></a>00068                         }
<a name="l00069"></a>00069 
<a name="l00070"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a2e5089e0905d4e15dd8f9ffa60fdfb0f">00070</a>                         <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a2e5089e0905d4e15dd8f9ffa60fdfb0f" title="Changes the frequency of the &amp;quot;ticks&amp;quot;.">setFrequency</a>(<span class="keywordtype">float</span> f) { <a class="code" href="mrpt__macros_8h.html#a47eb5a445c2bf3d9190396510ea9683e">ASSERT_</a>(f&gt;0); m_frecuency=f; <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>(); } <span class="comment">//!&lt; Changes the frequency of the &quot;ticks&quot;</span>
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#add1af97fff8aa16160003b5aea8c633b">00072</a>                         <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#add1af97fff8aa16160003b5aea8c633b">setLineWidth</a>(<span class="keywordtype">float</span> w) { m_lineWidth=w; <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="l00073"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a4a58ddb814b05f524abac8b3b216202f">00073</a>                         <span class="keywordtype">float</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a4a58ddb814b05f524abac8b3b216202f">getLineWidth</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>  m_lineWidth;}
<a name="l00074"></a>00074 
<a name="l00075"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a105842ba7f2c6e0c3f6cb29d528a7aa4">00075</a>                         <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a105842ba7f2c6e0c3f6cb29d528a7aa4">enableTickMarks</a>(<span class="keywordtype">bool</span> v=<span class="keyword">true</span>) { m_marks=v; <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="l00076"></a>00076 
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">                        /** Class factory  */</span>
<a name="l00079"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a4b25589f6bc2807c9e246fb3a773f64a">00079</a>                         <span class="keyword">static</span> <a class="code" href="structmrpt_1_1opengl_1_1_c_axis_ptr.html">CAxisPtr</a> Create(
<a name="l00080"></a>00080                                 <span class="keywordtype">float</span> xmin,<span class="keywordtype">float</span> ymin, <span class="keywordtype">float</span> zmin,
<a name="l00081"></a>00081                                 <span class="keywordtype">float</span> xmax, <span class="keywordtype">float</span> ymax,  <span class="keywordtype">float</span> zmax,
<a name="l00082"></a>00082                                 <span class="keywordtype">float</span> frecuency = 1, <span class="keywordtype">float</span> lineWidth = 3, <span class="keywordtype">bool</span> marks=<span class="keyword">false</span>)
<a name="l00083"></a>00083                         {
<a name="l00084"></a>00084                                 <span class="keywordflow">return</span> <a class="code" href="structmrpt_1_1opengl_1_1_c_axis_ptr.html">CAxisPtr</a>( <span class="keyword">new</span> <a class="code" href="namespacemrpt_1_1opengl.html#af6d6df8c41d51920bad5a8d49365e0b8">CAxis</a>( xmin,ymin, zmin, xmax,ymax,zmax,frecuency,lineWidth,marks  ) );
<a name="l00085"></a>00085                         }
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment">                        /** Render</span>
<a name="l00088"></a>00088 <span class="comment">                          */</span>
<a name="l00089"></a>00089                         <span class="keywordtype">void</span>  render_dl() <span class="keyword">const</span>;
<a name="l00090"></a>00090 
<a name="l00091"></a>00091         <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment">                        /** Constructor</span>
<a name="l00093"></a>00093 <span class="comment">                          */</span>
<a name="l00094"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#af243c62f641523701f8118a45984bce5">00094</a>                         <a class="code" href="namespacemrpt_1_1opengl.html#af6d6df8c41d51920bad5a8d49365e0b8">CAxis</a>(
<a name="l00095"></a>00095                                 <span class="keywordtype">float</span> xmin=-1.0f,<span class="keywordtype">float</span> ymin=-1.0f, <span class="keywordtype">float</span> zmin=-1.0f,
<a name="l00096"></a>00096                                 <span class="keywordtype">float</span> xmax=1.0f, <span class="keywordtype">float</span> ymax=1.0f,  <span class="keywordtype">float</span> zmax=1.0f,
<a name="l00097"></a>00097                                 <span class="keywordtype">float</span> frecuency = 0.25f, <span class="keywordtype">float</span> lineWidth = 3.0f, <span class="keywordtype">bool</span> marks=<span class="keyword">false</span>) :
<a name="l00098"></a>00098                                 m_xmin(xmin),m_ymin(ymin),m_zmin(zmin),
<a name="l00099"></a>00099                                 m_xmax(xmax),m_ymax(ymax),m_zmax(zmax),
<a name="l00100"></a>00100                                 m_frecuency(frecuency),
<a name="l00101"></a>00101                 m_lineWidth(lineWidth),
<a name="l00102"></a>00102                                 m_marks(marks)
<a name="l00103"></a>00103                         {
<a name="l00104"></a>00104                         }
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment">                        /** Private, virtual destructor: only can be deleted from smart pointers */</span>
<a name="l00107"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a74ef4cc4e3f3de4c18a7c2b76eeee1ca">00107</a>                         <span class="keyword">virtual</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_axis.html#a74ef4cc4e3f3de4c18a7c2b76eeee1ca" title="Private, virtual destructor: only can be deleted from smart pointers.">~CAxis</a>() { }
<a name="l00108"></a>00108                 };
<a name="l00109"></a>00109 
<a name="l00110"></a>00110         } <span class="comment">// end namespace</span>
<a name="l00111"></a>00111 } <span class="comment">// End of namespace</span>
<a name="l00112"></a>00112 
<a name="l00113"></a>00113 <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.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150">  </td></tr> </table> </body></html>