<!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>CTextMessageCapable.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">CTextMessageCapable.h</div> </div>
</div>
<div class="contents">
<a href="_c_text_message_capable_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_CTextMessageCapable_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define opengl_CTextMessageCapable_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="_c_renderizable_8h.html">mrpt/opengl/CRenderizable.h</a>></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="opengl__fonts_8h.html">mrpt/opengl/opengl_fonts.h</a>></span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">namespace </span>mrpt
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">namespace </span>opengl
<a name="l00038"></a>00038 {<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /** Keeps a list of text messages which can be rendered to OpenGL contexts by graphic classes.</span>
<a name="l00040"></a>00040 <span class="comment"> * \ingroup mrpt_opengl_grp</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a>00042 <span class="keyword">class </span><a class="code" href="opengl_2include_2mrpt_2opengl_2link__pragmas_8h.html#af6a1c8d5d6b3c8c0af00dbeef88ce269">OPENGL_IMPEXP</a> CTextMessageCapable
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <span class="keyword">protected</span>:
<a name="l00045"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text_message_capable.html#a47b89e812282c91a4fc0b8d1e08d16fd">00045</a> std<a class="code" href="classstd_1_1map.html">::map<size_t,mrpt::opengl::T2DTextData></a> <a class="code" href="classmrpt_1_1opengl_1_1_c_text_message_capable.html#a47b89e812282c91a4fc0b8d1e08d16fd">m_2D_texts</a>;
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /** Renders the messages to the current opengl rendering context (to be called OUT of MRPT mrpt::opengl render() methods ).</span>
<a name="l00048"></a>00048 <span class="comment"> * (w,h) are the dimensions of the rendering area in pixels.</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050 <span class="keywordtype">void</span> render_text_messages(<span class="keyword">const</span> <span class="keywordtype">int</span> w, <span class="keyword">const</span> <span class="keywordtype">int</span> h) <span class="keyword">const</span>;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">public</span>:
<a name="l00053"></a>00053 <span class="keywordtype">void</span> clearTextMessages();
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /** Add 2D text messages overlapped to the 3D rendered scene. The string will remain displayed in the 3D window</span>
<a name="l00057"></a>00057 <span class="comment"> * until it's changed with subsequent calls to this same method, or all the texts are cleared with clearTextMessages().</span>
<a name="l00058"></a>00058 <span class="comment"> *</span>
<a name="l00059"></a>00059 <span class="comment"> * \param x The X position, interpreted as absolute pixels from the left if X>=1, absolute pixels from the left if X<0 or as a width factor if in the range [0,1[.</span>
<a name="l00060"></a>00060 <span class="comment"> * \param y The Y position, interpreted as absolute pixels from the bottom if Y>=1, absolute pixels from the top if Y<0 or as a height factor if in the range [0,1[.</span>
<a name="l00061"></a>00061 <span class="comment"> * \param text The text string to display.</span>
<a name="l00062"></a>00062 <span class="comment"> * \param color The text color. For example: TColorf(1.0,1.0,1.0)</span>
<a name="l00063"></a>00063 <span class="comment"> * \param unique_index An "index" for this text message, so that subsequent calls with the same index will overwrite this text message instead of creating new ones.</span>
<a name="l00064"></a>00064 <span class="comment"> *</span>
<a name="l00065"></a>00065 <span class="comment"> * You'll need to refresh the display manually with forceRepaint().</span>
<a name="l00066"></a>00066 <span class="comment"> *</span>
<a name="l00067"></a>00067 <span class="comment"> * \sa clearTextMessages</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a>00069 <span class="keywordtype">void</span> addTextMessage(
<a name="l00070"></a>00070 <span class="keyword">const</span> <span class="keywordtype">double</span> x_frac,
<a name="l00071"></a>00071 <span class="keyword">const</span> <span class="keywordtype">double</span> y_frac,
<a name="l00072"></a>00072 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &text,
<a name="l00073"></a>00073 <span class="keyword">const</span> <a class="code" href="structmrpt_1_1utils_1_1_t_colorf.html" title="A RGB color - floats in the range [0,1].">mrpt::utils::TColorf</a> &color = <a class="code" href="structmrpt_1_1utils_1_1_t_colorf.html" title="A RGB color - floats in the range [0,1].">mrpt::utils::TColorf</a>(1.0,1.0,1.0),
<a name="l00074"></a>00074 <span class="keyword">const</span> <span class="keywordtype">size_t</span> unique_index = 0,
<a name="l00075"></a>00075 <span class="keyword">const</span> <a class="code" href="group__mrpt__opengl__grp.html#ga4e54252970d0b0a6dd251335064a2346" title="Existing fonts for 2D texts in mrpt::opengl methods.">mrpt::opengl::TOpenGLFont</a> font = <a class="code" href="group__mrpt__opengl__grp.html#gga4e54252970d0b0a6dd251335064a2346a31ebbbe2889bcca4760b90bba40385b8">mrpt::opengl::MRPT_GLUT_BITMAP_TIMES_ROMAN_24</a>
<a name="l00076"></a>00076 );
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /// \overload with more font parameters - refer to mrpt::opengl::gl_utils::glDrawText()</span>
<a name="l00079"></a>00079 <span class="comment"></span> <span class="keywordtype">void</span> addTextMessage(
<a name="l00080"></a>00080 <span class="keyword">const</span> <span class="keywordtype">double</span> x_frac,
<a name="l00081"></a>00081 <span class="keyword">const</span> <span class="keywordtype">double</span> y_frac,
<a name="l00082"></a>00082 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &text,
<a name="l00083"></a>00083 <span class="keyword">const</span> <a class="code" href="structmrpt_1_1utils_1_1_t_colorf.html" title="A RGB color - floats in the range [0,1].">mrpt::utils::TColorf</a> &color,
<a name="l00084"></a>00084 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &font_name,
<a name="l00085"></a>00085 <span class="keyword">const</span> <span class="keywordtype">double</span> font_size,
<a name="l00086"></a>00086 <span class="keyword">const</span> <a class="code" href="namespacemrpt_1_1opengl.html#a2a3950732480ac3cffe2c391a45fb4ef" title="Different style for vectorized font rendering.">mrpt::opengl::TOpenGLFontStyle</a> font_style = <a class="code" href="namespacemrpt_1_1opengl.html#a2a3950732480ac3cffe2c391a45fb4efa60e199cb9a72174613c2b15a385bc6e0" title="renders glyphs filled with antialiased outlines">mrpt::opengl::NICE</a>,
<a name="l00087"></a>00087 <span class="keyword">const</span> <span class="keywordtype">size_t</span> unique_index = 0,
<a name="l00088"></a>00088 <span class="keyword">const</span> <span class="keywordtype">double</span> font_spacing = 1.5,
<a name="l00089"></a>00089 <span class="keyword">const</span> <span class="keywordtype">double</span> font_kerning = 0.1
<a name="l00090"></a>00090 );
<a name="l00091"></a>00091
<a name="l00092"></a>00092 }; <span class="comment">// end of CTextMessageCapable</span>
<a name="l00093"></a>00093
<a name="l00094"></a>00094 } <span class="comment">// end namespace</span>
<a name="l00095"></a>00095 } <span class="comment">// End of namespace</span>
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <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>
