<!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>CRenderizableDisplayList.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">CRenderizableDisplayList.h</div> </div>
</div>
<div class="contents">
<a href="_c_renderizable_display_list_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 <span class="preprocessor">#ifndef opengl_CRenderizableDisplayList_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define opengl_CRenderizableDisplayList_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="_c_renderizable_8h.html">mrpt/opengl/CRenderizable.h</a>></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="_c_renderizable_display_list_8h.html#a8f5d4c566e747ecfe0918dadec0ecb8d">00037</a> <span class="preprocessor"> #define INVALID_DISPLAY_LIST_ID static_cast<unsigned int>(-1)</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<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_renderizable_display_list_ptr.html#ae93357efe47740742894caa6d5099457">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_renderizable_display_list.html" title="A renderizable object suitable for rendering with OpenGL's display lists.">CRenderizableDisplayList</a>, <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable.html" title="The base class of 3D objects that can be directly rendered through OpenGL.">CRenderizable</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">/** A renderizable object suitable for rendering with OpenGL's display lists.</span>
<a name="l00043"></a>00043 <span class="comment"> * The idea is to use the derived classes' ::render() method to save all the primitives</span>
<a name="l00044"></a>00044 <span class="comment"> * into one display list, then in subsequent rendering events, just execute the list.</span>
<a name="l00045"></a>00045 <span class="comment"> * This method is normally faster since it avoids the bottleneck between CPU-GPU. On the </span>
<a name="l00046"></a>00046 <span class="comment"> * other hand, it demands more memory on the graphic card.</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * Instructions for implementing derived classes:</span>
<a name="l00049"></a>00049 <span class="comment"> * - Each time the object is modified is some way that modifies its appearance, you must call notifyChange()</span>
<a name="l00050"></a>00050 <span class="comment"> * - Implement the rendering method: render_dl(), calling to OpenGL primitives as usual. They'll be saved in a display list transparently.</span>
<a name="l00051"></a>00051 <span class="comment"> *</span>
<a name="l00052"></a>00052 <span class="comment"> * \sa mrpt::opengl::CRenderizable</span>
<a name="l00053"></a>00053 <span class="comment"> * \ingroup mrpt_opengl_grp</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a>00055 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_renderizable_display_list.html" title="A renderizable object suitable for rendering with OpenGL's display lists.">CRenderizableDisplayList</a> : public mrpt::opengl::<a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable.html" title="The base class of 3D objects that can be directly rendered through OpenGL.">CRenderizable</a>
<a name="l00056"></a>00056 {
<a name="l00057"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a6fec28a53e20dfc1c4d046c26f9f7b48">00057</a> <a class="code" href="_c_serializable_8h.html#a5876f72cf51bfb66a82bf81cc493febc" title="This declaration must be inserted in virtual CSerializable classes definition:">DEFINE_VIRTUAL_SERIALIZABLE</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 name="l00058"></a>00058
<a name="l00059"></a>00059 private:
<a name="l00060"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a25b55ee018d920c18d7ecbcd1f658d42">00060</a> mutable <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_dl; <span class="comment">//!< Display list ID, for derived classes that want to use it (it's automatically deleted and freed on destruction of this base class).</span>
<a name="l00061"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#ab454a1f15f482de7a97c74875811b84d">00061</a> <span class="comment"></span> mutable <span class="keywordtype">bool</span> m_dl_recreate; <span class="comment">//!< If using display lists, this is true when the list must be updated (the object changes, it's the first rendering, etc...).</span>
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 protected:<span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment"> /** @name Methods accesible or implemented by derived classes </span>
<a name="l00065"></a>00065 <span class="comment"> @{ */</span>
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** Must be called to notify that the object has changed (so, the display list must be updated) */</span>
<a name="l00068"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a77f8b97d7f4937b3f0777b76bc0ddf7a">00068</a> EIGEN_STRONG_INLINE <span class="keywordtype">void</span> notifyChange()<span class="keyword"> const </span>{ m_dl_recreate=<span class="keyword">true</span>;}
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /** Derived classes must implement this method to the render the object. */</span>
<a name="l00071"></a>00071 <span class="keyword">virtual</span> <span class="keywordtype">void</span> render_dl() <span class="keyword">const</span> = 0;
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /** Optional: If the object has some state in which creating a display list is NOT preferred over direct rendering, </span>
<a name="l00074"></a>00074 <span class="comment"> * implement this method and return "true" in those cases. */</span>
<a name="l00075"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a828f34d2f5a3eba229a302559afe739e">00075</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a828f34d2f5a3eba229a302559afe739e" title="Optional: If the object has some state in which creating a display list is NOT preferred over direct ...">should_skip_display_list_cache</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
<a name="l00076"></a>00076
<a name="l00077"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#af46e56b5e7da5e276b8a0999b5e74354">00077</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> readFromStreamRender(<a class="code" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,..Please see the deriv...">mrpt::utils::CStream</a> &in)
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable.html#aa7af150bcbffbc865a570cf38206a561">CRenderizable::readFromStreamRender</a>(in);
<a name="l00080"></a>00080 notifyChange();
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /** @} */</span>
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">public</span>:
<a name="l00086"></a>00086 <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="l00087"></a>00087 <span class="keyword">virtual</span> ~<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="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"> /** Interface for the stlplus smart pointer class. */</span>
<a name="l00090"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#ac164cb1d2cf682778ce52967cbd56469">00090</a> <span class="keyword">inline</span> <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> * clone()<span class="keyword"> const</span>
<a name="l00091"></a>00091 <span class="keyword"> </span>{
<a name="l00092"></a>00092 <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><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>*<span class="keyword">></span>( this->duplicate() );
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment"> /** Render the object, regenerating the display list if needed, otherwise just calling it. */</span>
<a name="l00096"></a>00096 <span class="keyword">virtual</span> <span class="keywordtype">void</span> render() <span class="keyword">const</span>;
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /** @name Changes the appearance of the object to render (methods from CRenderizable that need to be redefined)</span>
<a name="l00100"></a>00100 <span class="comment"> @{ */</span>
<a name="l00101"></a>00101
<a name="l00102"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a304be3e5e73240ab0ee8cc77bb877eaf">00102</a> <span class="keyword">virtual</span> CRenderizable& <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a304be3e5e73240ab0ee8cc77bb877eaf" title="Color components in the range [0,255].">setColorR_u8</a>(<span class="keyword">const</span> uint8_t r) {m_color.R=r; notifyChange(); <span class="keywordflow">return</span> *<span class="keyword">this</span>;} <span class="comment">//!<Color components in the range [0,255] \return a ref to this</span>
<a name="l00103"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#ac92b3c352df68d167130b09da64141dd">00103</a> <span class="comment"></span> <span class="keyword">virtual</span> CRenderizable& <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#ac92b3c352df68d167130b09da64141dd" title="Color components in the range [0,255].">setColorG_u8</a>(<span class="keyword">const</span> uint8_t g) {m_color.G=g; notifyChange(); <span class="keywordflow">return</span> *<span class="keyword">this</span>;} <span class="comment">//!<Color components in the range [0,255] \return a ref to this</span>
<a name="l00104"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a6b5c21bb51fd83f87b9c0b26aeccd396">00104</a> <span class="comment"></span> <span class="keyword">virtual</span> CRenderizable& <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a6b5c21bb51fd83f87b9c0b26aeccd396" title="Color components in the range [0,255].">setColorB_u8</a>(<span class="keyword">const</span> uint8_t b) {m_color.B=b; notifyChange(); <span class="keywordflow">return</span> *<span class="keyword">this</span>;} <span class="comment">//!<Color components in the range [0,255] \return a ref to this</span>
<a name="l00105"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#ae0fe1daca727da3508f674992cc33827">00105</a> <span class="comment"></span> <span class="keyword">virtual</span> CRenderizable& <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#ae0fe1daca727da3508f674992cc33827" title="Color components in the range [0,255].">setColorA_u8</a>(<span class="keyword">const</span> uint8_t a) {m_color.A=a; notifyChange(); <span class="keywordflow">return</span> *<span class="keyword">this</span>;} <span class="comment">//!<Color components in the range [0,255] \return a ref to this</span>
<a name="l00106"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a3f3f905f1ac3cc0e4df7fe72700fc050">00106</a> <span class="comment"></span> <span class="keyword">virtual</span> CRenderizable& <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable_display_list.html#a3f3f905f1ac3cc0e4df7fe72700fc050" title="Changes the default object color.">setColor_u8</a>( <span class="keyword">const</span> <a class="code" href="structmrpt_1_1utils_1_1_t_color.html" title="A RGB color - 8bit.">mrpt::utils::TColor</a> &c) { <a class="code" href="classmrpt_1_1opengl_1_1_c_renderizable.html#a6036b02181fce4b99ca279b700a23861">CRenderizable::setColor_u8</a>(c); notifyChange(); <span class="keywordflow">return</span> *<span class="keyword">this</span>; } <span class="comment">//!< Changes the default object color \return a ref to this</span>
<a name="l00107"></a>00107 <span class="comment"></span><span class="comment"></span>
<a name="l00108"></a>00108 <span class="comment"> /** @} */</span>
<a name="l00109"></a>00109
<a name="l00110"></a>00110 };
<a name="l00111"></a>00111
<a name="l00112"></a>00112 } <span class="comment">// end namespace</span>
<a name="l00113"></a>00113
<a name="l00114"></a>00114 } <span class="comment">// End of namespace</span>
<a name="l00115"></a>00115
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <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>
