Public Slots | Public Member Functions | List of all members
rviz::DisplayContext Class Referenceabstract

Pure-virtual base class for objects which give Display subclasses context in which to work. More...

#include <display_context.h>

Inheritance diagram for rviz::DisplayContext:
Inheritance graph
[legend]

Public Slots

virtual void queueRender ()=0
 Queues a render. Multiple calls before a render happens will only cause a single render. More...
 

Public Member Functions

virtual uint32_t getDefaultVisibilityBit () const =0
 
virtual DisplayFactorygetDisplayFactory () const =0
 Return a factory for creating Display subclasses based on a class id string. More...
 
virtual QString getFixedFrame () const =0
 Return the fixed frame name. More...
 
virtual uint64_t getFrameCount () const =0
 Return the current value of the frame count. More...
 
virtual FrameManagergetFrameManager () const =0
 Return the FrameManager instance. More...
 
virtual DisplayGroupgetRootDisplayGroup () const =0
 
virtual Ogre::SceneManager * getSceneManager () const =0
 Returns the Ogre::SceneManager used for the main RenderPanel. More...
 
virtual SelectionManagergetSelectionManager () const =0
 Return a pointer to the SelectionManager. More...
 
virtual std::shared_ptr< tf2_ros::BuffergetTF2BufferPtr () const =0
 Convenience function: returns getFrameManager()->getTF2BufferPtr(). More...
 
virtual tf::TransformListenergetTFClient () const =0
 Convenience function: returns getFrameManager()->getTFClient(). More...
 
virtual ros::CallbackQueueInterfacegetThreadedQueue ()=0
 Return a CallbackQueue using a different thread than the main GUI one. More...
 
virtual ToolManagergetToolManager () const =0
 Return the ToolManager. More...
 
virtual ros::CallbackQueueInterfacegetUpdateQueue ()=0
 Return the CallbackQueue using the main GUI thread. More...
 
virtual ViewManagergetViewManager () const =0
 Return the ViewManager. More...
 
virtual WindowManagerInterfacegetWindowManager () const =0
 Return the window manager, if any. More...
 
virtual void handleChar (QKeyEvent *event, RenderPanel *panel)=0
 Handle a single key event for a given RenderPanel. More...
 
virtual void handleMouseEvent (const ViewportMouseEvent &event)=0
 Handle a mouse event. More...
 
virtual void setStatus (const QString &message)=0
 
virtual BitAllocatorvisibilityBits ()=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 81 of file display_context.h.

Member Function Documentation

◆ getDefaultVisibilityBit()

virtual uint32_t rviz::DisplayContext::getDefaultVisibilityBit ( ) const
pure virtual

◆ getDisplayFactory()

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.

◆ getFixedFrame()

virtual QString rviz::DisplayContext::getFixedFrame ( ) const
pure virtual

Return the fixed frame name.

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ getFrameCount()

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.

◆ getFrameManager()

virtual FrameManager* rviz::DisplayContext::getFrameManager ( ) const
pure virtual

Return the FrameManager instance.

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ getRootDisplayGroup()

virtual DisplayGroup* rviz::DisplayContext::getRootDisplayGroup ( ) const
pure virtual

◆ getSceneManager()

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.

◆ getSelectionManager()

virtual SelectionManager* rviz::DisplayContext::getSelectionManager ( ) const
pure virtual

Return a pointer to the SelectionManager.

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ getTF2BufferPtr()

virtual std::shared_ptr<tf2_ros::Buffer> rviz::DisplayContext::getTF2BufferPtr ( ) const
pure virtual

Convenience function: returns getFrameManager()->getTF2BufferPtr().

Implemented in rviz::VisualizationManager.

◆ getTFClient()

virtual tf::TransformListener* rviz::DisplayContext::getTFClient ( ) const
pure virtual

Convenience function: returns getFrameManager()->getTFClient().

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ getThreadedQueue()

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.

◆ getToolManager()

virtual ToolManager* rviz::DisplayContext::getToolManager ( ) const
pure virtual

Return the ToolManager.

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ getUpdateQueue()

virtual ros::CallbackQueueInterface* rviz::DisplayContext::getUpdateQueue ( )
pure virtual

Return the CallbackQueue using the main GUI thread.

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ getViewManager()

virtual ViewManager* rviz::DisplayContext::getViewManager ( ) const
pure virtual

Return the ViewManager.

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ getWindowManager()

virtual WindowManagerInterface* rviz::DisplayContext::getWindowManager ( ) const
pure virtual

Return the window manager, if any.

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ handleChar()

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.

◆ handleMouseEvent()

virtual void rviz::DisplayContext::handleMouseEvent ( const ViewportMouseEvent event)
pure virtual

Handle a mouse event.

Implemented in rviz::VisualizationManager, and rviz::MockContext.

◆ queueRender

virtual void rviz::DisplayContext::queueRender ( )
pure virtualslot

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.

◆ setStatus()

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.

◆ visibilityBits()

virtual BitAllocator* rviz::DisplayContext::visibilityBits ( )
pure virtual

The documentation for this class was generated from the following file:


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Aug 15 2022 02:05:17