Abstract class for SensorDataGLWidget plugins that paint some kind of 3D data using OpenGL. More...
#include <PainterPlugin.h>
Public Slots | |
| virtual void | nodeSelected () |
| Called when the host widget changes it lookAt node in the scenegraph. | |
| virtual void | nodeSelected (std::string nodeName) |
| Do the message processing. Has to be reimplemented in derived classes. | |
| void | setParent (QGLWidget *parentWidget) |
| Called by parent widget. The painter class can then access functions of the parent, e.g. for text rendering. | |
Public Member Functions | |
| std::string | getName () |
| bool | isVisible () |
| bool | needsRedraw () |
| If the needsRedraw flag is set to true after processing a message, the host widget will know it neeeds to redraw the scene. | |
| virtual void | paint (float next2DLayer)=0 |
| this is called by the host widget (e.g. SensorDataGLWidget) and should contain the OpenGL drawing routines | |
| PainterPlugin () | |
| The constructor. | |
| void | setName (std::string name) |
| Specifies the name that is displayed e.g. in the options dialogue. | |
| void | setVisible (bool visible) |
| specifies if this plugin is currently active. | |
| void | wasRedrawn () |
| ~PainterPlugin () | |
| The destructor. | |
Protected Member Functions | |
| void | requestRedraw () |
| request a redraw on the next OpenGL update | |
Protected Attributes | |
| QGLWidget * | m_ParentWidget |
Private Attributes | |
| std::string | m_Name |
| bool | m_NeedsRedraw |
| bool | m_Visible |
Detailed Description
Abstract class for SensorDataGLWidget plugins that paint some kind of 3D data using OpenGL.
Definition at line 24 of file PainterPlugin.h.
Constructor & Destructor Documentation
The constructor.
The destructor.
Member Function Documentation
| std::string PainterPlugin::getName | ( | void | ) | [inline] |
Definition at line 45 of file PainterPlugin.h.
| bool PainterPlugin::isVisible | ( | ) | [inline] |
Definition at line 41 of file PainterPlugin.h.
| bool PainterPlugin::needsRedraw | ( | ) | [inline] |
If the needsRedraw flag is set to true after processing a message, the host widget will know it neeeds to redraw the scene.
Definition at line 48 of file PainterPlugin.h.
| virtual void PainterPlugin::nodeSelected | ( | ) | [inline, virtual, slot] |
Called when the host widget changes it lookAt node in the scenegraph.
Definition at line 54 of file PainterPlugin.h.
| virtual void PainterPlugin::nodeSelected | ( | std::string | nodeName | ) | [inline, virtual, slot] |
Do the message processing. Has to be reimplemented in derived classes.
Called when the host widget follows another node in the scenegraph
Reimplemented in ImagePainter.
Definition at line 60 of file PainterPlugin.h.
| virtual void PainterPlugin::paint | ( | float | next2DLayer | ) | [pure virtual] |
this is called by the host widget (e.g. SensorDataGLWidget) and should contain the OpenGL drawing routines
Implemented in ImagePainter, PersonParticlePainter, LaserScan3DPainter, NewLaserDataPainter, RGBDepthPainter, PersonPainter, SceneGraphPainter, SilhouettePainter, SkeletonPainter, MapPainter, ParticlePainter, RobotPosesPainter, ParticleGridPainter, PathPainter, POIPainter, RobotPainter, SonarPainter, and TofPainter.
| void PainterPlugin::requestRedraw | ( | ) | [inline, protected] |
request a redraw on the next OpenGL update
Definition at line 69 of file PainterPlugin.h.
| void PainterPlugin::setName | ( | std::string | name | ) | [inline] |
Specifies the name that is displayed e.g. in the options dialogue.
Definition at line 44 of file PainterPlugin.h.
| void PainterPlugin::setParent | ( | QGLWidget * | parentWidget | ) | [inline, slot] |
Called by parent widget. The painter class can then access functions of the parent, e.g. for text rendering.
Definition at line 64 of file PainterPlugin.h.
| void PainterPlugin::setVisible | ( | bool | visible | ) | [inline] |
specifies if this plugin is currently active.
Definition at line 40 of file PainterPlugin.h.
| void PainterPlugin::wasRedrawn | ( | ) | [inline] |
Definition at line 49 of file PainterPlugin.h.
Member Data Documentation
std::string PainterPlugin::m_Name [private] |
Definition at line 77 of file PainterPlugin.h.
bool PainterPlugin::m_NeedsRedraw [private] |
Definition at line 79 of file PainterPlugin.h.
QGLWidget* PainterPlugin::m_ParentWidget [protected] |
Definition at line 71 of file PainterPlugin.h.
bool PainterPlugin::m_Visible [private] |
Definition at line 75 of file PainterPlugin.h.
The documentation for this class was generated from the following file: