Pure-virtual base class for objects which give Display subclasses context in which to work. More...
#include <display_context.h>
Public Slots | |
| virtual void | queueRender ()=0 |
| Queues a render. Multiple calls before a render happens will only cause a single render. | |
Public Member Functions | |
| virtual uint32_t | getDefaultVisibilityBit () const =0 |
| virtual DisplayFactory * | getDisplayFactory () const =0 |
| Return a factory for creating Display subclasses based on a class id string. | |
| virtual QString | getFixedFrame () const =0 |
| Return the fixed frame name. | |
| virtual uint64_t | getFrameCount () const =0 |
| Return the current value of the frame count. | |
| virtual FrameManager * | getFrameManager () const =0 |
| Return the FrameManager instance. | |
| virtual DisplayGroup * | getRootDisplayGroup () const =0 |
| virtual Ogre::SceneManager * | getSceneManager () const =0 |
| Returns the Ogre::SceneManager used for the main RenderPanel. | |
| virtual SelectionManager * | getSelectionManager () const =0 |
| Return a pointer to the SelectionManager. | |
| virtual tf::TransformListener * | getTFClient () const =0 |
| Convenience function: returns getFrameManager()->getTFClient(). | |
| virtual ros::CallbackQueueInterface * | getThreadedQueue ()=0 |
| Return a CallbackQueue using a different thread than the main GUI one. | |
| virtual ToolManager * | getToolManager () const =0 |
| Return the ToolManager. | |
| virtual ros::CallbackQueueInterface * | getUpdateQueue ()=0 |
| Return the CallbackQueue using the main GUI thread. | |
| virtual ViewManager * | getViewManager () const =0 |
| Return the ViewManager. | |
| virtual WindowManagerInterface * | getWindowManager () const =0 |
| Return the window manager, if any. | |
| virtual void | handleChar (QKeyEvent *event, RenderPanel *panel)=0 |
| Handle a single key event for a given RenderPanel. | |
| virtual void | handleMouseEvent (const ViewportMouseEvent &event)=0 |
| Handle a mouse event. | |
| virtual void | setStatus (const QString &message)=0 |
| virtual BitAllocator * | visibilityBits ()=0 |
Detailed Description
Pure-virtual base class for objects which give Display subclasses context in which to work.
This interface class mainly exists to enable more isolated unit tests by enabling small mock objects to take the place of the large VisualizationManager implementation class. It also serves to define a narrower, more maintainable API for Display plugins.
Definition at line 76 of file display_context.h.
Member Function Documentation
| virtual uint32_t rviz::DisplayContext::getDefaultVisibilityBit | ( | ) | const [pure virtual] |
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual DisplayFactory* rviz::DisplayContext::getDisplayFactory | ( | ) | const [pure virtual] |
Return a factory for creating Display subclasses based on a class id string.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual QString rviz::DisplayContext::getFixedFrame | ( | ) | const [pure virtual] |
Return the fixed frame name.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual uint64_t rviz::DisplayContext::getFrameCount | ( | ) | const [pure virtual] |
Return the current value of the frame count.
The frame count is just a number which increments each time a frame is rendered. This lets clients check if a new frame has been rendered since the last time they did something.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual FrameManager* rviz::DisplayContext::getFrameManager | ( | ) | const [pure virtual] |
Return the FrameManager instance.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual DisplayGroup* rviz::DisplayContext::getRootDisplayGroup | ( | ) | const [pure virtual] |
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual Ogre::SceneManager* rviz::DisplayContext::getSceneManager | ( | ) | const [pure virtual] |
Returns the Ogre::SceneManager used for the main RenderPanel.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual SelectionManager* rviz::DisplayContext::getSelectionManager | ( | ) | const [pure virtual] |
Return a pointer to the SelectionManager.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual tf::TransformListener* rviz::DisplayContext::getTFClient | ( | ) | const [pure virtual] |
Convenience function: returns getFrameManager()->getTFClient().
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual ros::CallbackQueueInterface* rviz::DisplayContext::getThreadedQueue | ( | ) | [pure virtual] |
Return a CallbackQueue using a different thread than the main GUI one.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual ToolManager* rviz::DisplayContext::getToolManager | ( | ) | const [pure virtual] |
Return the ToolManager.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual ros::CallbackQueueInterface* rviz::DisplayContext::getUpdateQueue | ( | ) | [pure virtual] |
Return the CallbackQueue using the main GUI thread.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual ViewManager* rviz::DisplayContext::getViewManager | ( | ) | const [pure virtual] |
Return the ViewManager.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual WindowManagerInterface* rviz::DisplayContext::getWindowManager | ( | ) | const [pure virtual] |
Return the window manager, if any.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual void rviz::DisplayContext::handleChar | ( | QKeyEvent * | event, |
| RenderPanel * | panel | ||
| ) | [pure virtual] |
Handle a single key event for a given RenderPanel.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual void rviz::DisplayContext::handleMouseEvent | ( | const ViewportMouseEvent & | event | ) | [pure virtual] |
Handle a mouse event.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual void rviz::DisplayContext::queueRender | ( | ) | [pure virtual, slot] |
Queues a render. Multiple calls before a render happens will only cause a single render.
- Note:
- This function can be called from any thread.
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual void rviz::DisplayContext::setStatus | ( | const QString & | message | ) | [pure virtual] |
Set the message displayed in the status bar
Implemented in rviz::VisualizationManager, and rviz::MockContext.
| virtual BitAllocator* rviz::DisplayContext::visibilityBits | ( | ) | [pure virtual] |
Implemented in rviz::VisualizationManager, and rviz::MockContext.
The documentation for this class was generated from the following file: