Main MRPT website > C++ reference
MRPT logo

CText.h

Go to the documentation of this file.
00001 /* +---------------------------------------------------------------------------+
00002    |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
00003    |                                                                           |
00004    |                   http://mrpt.sourceforge.net/                            |
00005    |                                                                           |
00006    |   Copyright (C) 2005-2011  University of Malaga                           |
00007    |                                                                           |
00008    |    This software was written by the Machine Perception and Intelligent    |
00009    |      Robotics Lab, University of Malaga (Spain).                          |
00010    |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
00011    |                                                                           |
00012    |  This file is part of the MRPT project.                                   |
00013    |                                                                           |
00014    |     MRPT is free software: you can redistribute it and/or modify          |
00015    |     it under the terms of the GNU General Public License as published by  |
00016    |     the Free Software Foundation, either version 3 of the License, or     |
00017    |     (at your option) any later version.                                   |
00018    |                                                                           |
00019    |   MRPT is distributed in the hope that it will be useful,                 |
00020    |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |
00021    |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |
00022    |     GNU General Public License for more details.                          |
00023    |                                                                           |
00024    |     You should have received a copy of the GNU General Public License     |
00025    |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
00026    |                                                                           |
00027    +---------------------------------------------------------------------------+ */
00028 
00029 #ifndef opengl_CText_H
00030 #define opengl_CText_H
00031 
00032 #include <mrpt/opengl/CRenderizable.h>
00033 
00034 namespace mrpt
00035 {
00036         namespace opengl
00037         {
00038                 class OPENGL_IMPEXP CText;
00039 
00040                 // This must be added to any CSerializable derived class:
00041                 DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE_LINKAGE( CText, CRenderizable, OPENGL_IMPEXP )
00042 
00043                 /** A 2D text (bitmap rendering): it always "faces the observer" despite it's at some 3D location.
00044                   *  Use setString and setFont to change the text displayed by this object.
00045                   *
00046                   *  \note All texts appear with the font GLUT_BITMAP_TIMES_ROMAN_10 for now (i.e. setFont is ignored)
00047                   *  \sa opengl::COpenGLScene
00048                   *  
00049                   *  <div align="center">
00050                   *  <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px; border-style: solid;">
00051                   *   <tr> <td> mrpt::opengl::CText </td> <td> \image html preview_CText.png </td> </tr>
00052                   *  </table>
00053                   *  </div>
00054                   *  
00055                   */
00056                 class OPENGL_IMPEXP CText : public CRenderizable
00057                 {
00058                         DEFINE_SERIALIZABLE( CText )
00059                 protected:
00060                         std::string             m_str;
00061             std::string         m_fontName;
00062             int                         m_fontHeight, m_fontWidth;
00063 
00064                 public:
00065                         void setString( const std::string &s ) { m_str=s; } //!< Sets the text to display
00066                         std::string getString() const { return m_str; }  //!< Return the current text associated to this label
00067 
00068                         void setFont(const std::string &s, int height ) { m_fontName=s; m_fontHeight=height; } //!< Sets the font (It has no effect yet!)
00069                         std::string getFont() const { return m_fontName; }
00070 
00071                         /** Render */
00072                         void  render() const;
00073 
00074 
00075                         /** Class factory  */
00076                         static CTextPtr Create(const std::string &str) { return CTextPtr( new CText(str) ); }
00077 
00078                 private:
00079                         /** Constructor */
00080                         CText( const std::string &str = std::string("") );
00081 
00082                         /** Private, virtual destructor: only can be deleted from smart pointers */
00083                         virtual ~CText();
00084                 };
00085 
00086         } // end namespace
00087 
00088 } // End of namespace
00089 
00090 
00091 #endif



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN:exported at Tue Jan 25 21:56:31 UTC 2011