Main MRPT website > C++ reference
MRPT logo

CAxis.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 #ifndef opengl_CAxis_H
00029 #define opengl_CAxis_H
00030 
00031 #include <mrpt/opengl/CRenderizableDisplayList.h>
00032 
00033 namespace mrpt
00034 {
00035         namespace opengl
00036         {
00037                 class OPENGL_IMPEXP CAxis;
00038 
00039                 // This must be added to any CSerializable derived class:
00040                 DEFINE_SERIALIZABLE_PRE_CUSTOM_BASE_LINKAGE( CAxis, CRenderizableDisplayList, OPENGL_IMPEXP )
00041 
00042                 /** Draw a 3D world axis, with coordinate marks at some regular interval
00043                   *  \sa opengl::COpenGLScene
00044                   *  
00045                   *  <div align="center">
00046                   *  <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px; border-style: solid;">
00047                   *  <tr> <td> mrpt::opengl::CAxis </td> <td> \image html preview_CAxis.png </td> </tr>
00048                   *  </table>
00049                   *  </div>
00050                   *  
00051                   */
00052                 class OPENGL_IMPEXP CAxis : public CRenderizableDisplayList
00053                 {
00054                         DEFINE_SERIALIZABLE( CAxis )
00055                 protected:
00056                         float   m_xmin,m_ymin,m_zmin;
00057                         float   m_xmax,m_ymax,m_zmax;
00058                         float   m_frecuency;
00059             float       m_lineWidth;
00060                         bool    m_marks;
00061 
00062                 public:
00063                         void setAxisLimits(float xmin,float ymin, float zmin, float xmax,float ymax, float zmax)
00064                         {
00065                                 m_xmin=xmin; m_ymin=ymin; m_zmin=zmin;
00066                                 m_xmax=xmax; m_ymax=ymax; m_zmax=zmax;
00067                                 CRenderizableDisplayList::notifyChange();
00068                         }
00069 
00070                         void setFrequency(float f) { ASSERT_(f>0); m_frecuency=f; CRenderizableDisplayList::notifyChange(); } //!< Changes the frequency of the "ticks"
00071 
00072                         void setLineWidth(float w) { m_lineWidth=w; CRenderizableDisplayList::notifyChange(); }
00073                         float getLineWidth() const { return  m_lineWidth;}
00074 
00075                         void enableTickMarks(bool v=true) { m_marks=v; CRenderizableDisplayList::notifyChange(); }
00076 
00077 
00078                         /** Class factory  */
00079                         static CAxisPtr Create(
00080                                 float xmin,float ymin, float zmin,
00081                                 float xmax, float ymax,  float zmax,
00082                                 float frecuency = 1, float lineWidth = 3, bool marks=false)
00083                         {
00084                                 return CAxisPtr( new CAxis( xmin,ymin, zmin, xmax,ymax,zmax,frecuency,lineWidth,marks  ) );
00085                         }
00086 
00087                         /** Render
00088                           */
00089                         void  render_dl() const;
00090 
00091         private:
00092                         /** Constructor
00093                           */
00094                         CAxis(
00095                                 float xmin=-1.0f,float ymin=-1.0f, float zmin=-1.0f,
00096                                 float xmax=1.0f, float ymax=1.0f,  float zmax=1.0f,
00097                                 float frecuency = 0.25f, float lineWidth = 3.0f, bool marks=false) :
00098                                 m_xmin(xmin),m_ymin(ymin),m_zmin(zmin),
00099                                 m_xmax(xmax),m_ymax(ymax),m_zmax(zmax),
00100                                 m_frecuency(frecuency),
00101                 m_lineWidth(lineWidth),
00102                                 m_marks(marks)
00103                         {
00104                         }
00105 
00106                         /** Private, virtual destructor: only can be deleted from smart pointers */
00107                         virtual ~CAxis() { }
00108                 };
00109 
00110         } // end namespace
00111 } // End of namespace
00112 
00113 #endif



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