Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 2223

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.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>CText.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.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&#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>
        <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&#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">
<div class="title">CText.h</div>  </div>
</div>
<div class="contents">
<a href="_c_text_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  &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 
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef opengl_CText_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define opengl_CText_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;<a class="code" href="_c_renderizable_8h.html">mrpt/opengl/CRenderizable.h</a>&gt;</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#a5c3ee8e6240b69213d3371a3a5a64ab3">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_text.html" title="A 2D text (bitmap rendering): it always &quot;faces the observer&quot; despite it&#39;s at some 3D location...">CText</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_text_ptr.html#a7732811415f394f511cff00cc61f1f1e">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_text.html" title="A 2D text (bitmap rendering): it always &quot;faces the observer&quot; despite it&#39;s at some 3D location...">CText</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="l00042"></a>00042 
<a name="l00043"></a>00043                 <span class="comment">/** A 2D text (bitmap rendering): it always &quot;faces the observer&quot; despite it&#39;s at some 3D location.</span>
<a name="l00044"></a>00044 <span class="comment">                  *  Use setString and setFont to change the text displayed by this object.</span>
<a name="l00045"></a>00045 <span class="comment">                  *</span>
<a name="l00046"></a>00046 <span class="comment">                  *  \note All texts appear with the font GLUT_BITMAP_TIMES_ROMAN_10 for now (i.e. setFont is ignored)</span>
<a name="l00047"></a>00047 <span class="comment">                  *  \sa opengl::COpenGLScene</span>
<a name="l00048"></a>00048 <span class="comment">                  *</span>
<a name="l00049"></a>00049 <span class="comment">                  *  &lt;div align=&quot;center&quot;&gt;</span>
<a name="l00050"></a>00050 <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="l00051"></a>00051 <span class="comment">                  *   &lt;tr&gt; &lt;td&gt; mrpt::opengl::CText &lt;/td&gt; &lt;td&gt; \image html preview_CText.png &lt;/td&gt; &lt;/tr&gt;</span>
<a name="l00052"></a>00052 <span class="comment">                  *  &lt;/table&gt;</span>
<a name="l00053"></a>00053 <span class="comment">                  *  &lt;/div&gt;</span>
<a name="l00054"></a>00054 <span class="comment">                  *</span>
<a name="l00055"></a>00055 <span class="comment">                  *  \sa CText3D</span>
<a name="l00056"></a>00056 <span class="comment">                  * \ingroup mrpt_opengl_grp</span>
<a name="l00057"></a>00057 <span class="comment">                  */</span>
<a name="l00058"></a>00058                 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_text.html" title="A 2D text (bitmap rendering): it always &quot;faces the observer&quot; despite it&#39;s at some 3D location...">CText</a> : public <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="l00059"></a>00059                 {
<a name="l00060"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#aad1dc314c281d98851e6052dde977026">00060</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_text.html" title="A 2D text (bitmap rendering): it always &quot;faces the observer&quot; despite it&#39;s at some 3D location...">CText</a> )
<a name="l00061"></a>00061                 protected:
<a name="l00062"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a0f00a78984d3dee0a8759430aca7aee0">00062</a>                         std::<span class="keywordtype">string</span>             m_str;
<a name="l00063"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a49642b3a525514360c8dba51e681d2e5">00063</a>             std::<span class="keywordtype">string</span>         m_fontName;
<a name="l00064"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a745cbdee869be31a44983b1f8a00368b">00064</a>             <span class="keywordtype">int</span>                         m_fontHeight, m_fontWidth;
<a name="l00065"></a>00065 
<a name="l00066"></a>00066                 public:
<a name="l00067"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a4515de9c11c596f2cb9b21f802d922b1">00067</a>                         <span class="keywordtype">void</span> setString( const std::<span class="keywordtype">string</span> &amp;s ) { m_str=s; } <span class="comment">//!&lt; Sets the text to display</span>
<a name="l00068"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a356bfb91a5b363a1b98f09185fd60625">00068</a> <span class="comment"></span>                        std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> <a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a356bfb91a5b363a1b98f09185fd60625" title="Return the current text associated to this label.">getString</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_str; }  <span class="comment">//!&lt; Return the current text associated to this label</span>
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#abefc5b7d24e4b0b03c1ecebea7b4461b">00070</a>                         <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#abefc5b7d24e4b0b03c1ecebea7b4461b" title="Sets the font (It has no effect yet!)">setFont</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &amp;s, <span class="keywordtype">int</span> height ) { m_fontName=s; m_fontHeight=height; } <span class="comment">//!&lt; Sets the font (It has no effect yet!)</span>
<a name="l00071"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a46a74e0c87475cdf70556e8b867f48fe">00071</a> <span class="comment"></span>                        std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> <a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a46a74e0c87475cdf70556e8b867f48fe">getFont</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_fontName; }
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment">                        /** Render */</span>
<a name="l00074"></a>00074                         <span class="keywordtype">void</span>  render() <span class="keyword">const</span>;
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment">                        /** Class factory  */</span>
<a name="l00078"></a><a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a01ede44ab5e288f2181cb22a9d0b1e06">00078</a>                         <span class="keyword">static</span> <a class="code" href="structmrpt_1_1opengl_1_1_c_text_ptr.html">CTextPtr</a> <a class="code" href="classmrpt_1_1opengl_1_1_c_text.html#a01ede44ab5e288f2181cb22a9d0b1e06" title="Class factory.">Create</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &amp;str) { <span class="keywordflow">return</span> <a class="code" href="structmrpt_1_1opengl_1_1_c_text_ptr.html">CTextPtr</a>( <span class="keyword">new</span> <a class="code" href="namespacemrpt_1_1opengl.html#a5c3ee8e6240b69213d3371a3a5a64ab3">CText</a>(str) ); }
<a name="l00079"></a>00079 
<a name="l00080"></a>00080                 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment">                        /** Constructor */</span>
<a name="l00082"></a>00082                         <a class="code" href="namespacemrpt_1_1opengl.html#a5c3ee8e6240b69213d3371a3a5a64ab3">CText</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &amp;str = <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a>(<span class="stringliteral">&quot;&quot;</span>) );
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment">                        /** Private, virtual destructor: only can be deleted from smart pointers */</span>
<a name="l00085"></a>00085                         <span class="keyword">virtual</span> ~<a class="code" href="classmrpt_1_1opengl_1_1_c_text.html" title="A 2D text (bitmap rendering): it always &quot;faces the observer&quot; despite it&#39;s at some 3D location...">CText</a>();
<a name="l00086"></a>00086                 };
<a name="l00087"></a>00087 
<a name="l00088"></a>00088         } <span class="comment">// end namespace</span>
<a name="l00089"></a>00089 
<a name="l00090"></a>00090 } <span class="comment">// End of namespace</span>
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <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>