The VisualizationManager class is the central manager class of rviz, holding all the Displays, Tools, ViewControllers, and other managers. More...
#include <visualization_manager.h>
Signals | |
void | configChanged () |
Emitted whenever the display configuration changes. More... | |
void | escapePressed () |
Emitted when ESC key is pressed. More... | |
void | preUpdate () |
Emitted before updating all Displays. More... | |
void | statusUpdate (const QString &message) |
Emitted during file-loading and initialization to indicate progress. More... | |
Public Member Functions | |
void | addDisplay (Display *display, bool enabled) |
Add a display to be managed by this panel. More... | |
Display * | createDisplay (const QString &class_lookup_name, const QString &name, bool enabled) |
Create and add a display to this panel, by class lookup name. More... | |
void | emitStatusUpdate (const QString &message) |
Emits statusUpdate() signal with the given message. More... | |
uint32_t | getDefaultVisibilityBit () const override |
DisplayFactory * | getDisplayFactory () const override |
Return a factory for creating Display subclasses based on a class id string. More... | |
PropertyTreeModel * | getDisplayTreeModel () const |
QString | getFixedFrame () const override |
Return the fixed frame name. More... | |
uint64_t | getFrameCount () const override |
Return the current value of the frame count. More... | |
FrameManager * | getFrameManager () const override |
Return the FrameManager instance. More... | |
virtual QString | getHelpPath () const |
RenderPanel * | getRenderPanel () const |
Return the main RenderPanel. More... | |
DisplayGroup * | getRootDisplayGroup () const override |
double | getROSTime () |
Return the ROS time, in seconds. More... | |
double | getROSTimeElapsed () |
Return the ROS time in seconds since the last reset. More... | |
Ogre::SceneManager * | getSceneManager () const override |
Returns the Ogre::SceneManager used for the main RenderPanel. More... | |
SelectionManager * | getSelectionManager () const override |
Return a pointer to the SelectionManager. More... | |
std::shared_ptr< tf2_ros::Buffer > | getTF2BufferPtr () const override |
Convenience function: returns getFrameManager()->getTF2BufferPtr(). More... | |
tf::TransformListener * | getTFClient () const override |
Convenience function: returns getFrameManager()->getTFClient(). More... | |
ros::CallbackQueueInterface * | getThreadedQueue () override |
Return a CallbackQueue using a different thread than the main GUI one. More... | |
ToolManager * | getToolManager () const override |
Return a pointer to the ToolManager. More... | |
ros::CallbackQueueInterface * | getUpdateQueue () override |
Return the CallbackQueue using the main GUI thread. More... | |
ViewManager * | getViewManager () const override |
Return a pointer to the ViewManager. More... | |
double | getWallClock () |
Return the wall clock time, in seconds since 1970. More... | |
double | getWallClockElapsed () |
Return the wall clock time in seconds since the last reset. More... | |
WindowManagerInterface * | getWindowManager () const override |
Return the window manager, if any. More... | |
void | handleChar (QKeyEvent *event, RenderPanel *panel) override |
Handle a single key event for a given RenderPanel. More... | |
void | handleMouseEvent (const ViewportMouseEvent &event) override |
Handle a mouse event. More... | |
void | initialize () |
Do initialization that wasn't done in constructor. Initializes tool manager, view manager, selection manager. More... | |
void | load (const Config &config) |
Load the properties of each Display and most editable rviz data. More... | |
void | lockRender () |
Lock a mutex to delay calls to Ogre::Root::renderOneFrame(). More... | |
void | notifyConfigChanged () |
Notify this VisualizationManager that something about its display configuration has changed. More... | |
void | queueRender () override |
Queues a render. Multiple calls before a render happens will only cause a single render. More... | |
void | removeAllDisplays () |
Remove and delete all displays. More... | |
void | resetTime () |
Resets the wall and ROS elapsed time to zero and calls resetDisplays(). More... | |
void | save (Config config) const |
Save the properties of each Display and most editable rviz data. More... | |
void | setFixedFrame (const QString &frame) |
Set the coordinate frame we should be transforming all fixed data into. More... | |
virtual void | setHelpPath (const QString &help_path) |
void | setStatus (const QString &message) override |
void | startUpdate () |
Start timers. Creates and starts the update and idle timers, both set to 30Hz (33ms). More... | |
void | stopUpdate () |
void | unlockRender () |
Unlock a mutex, allowing calls to Ogre::Root::renderOneFrame(). More... | |
BitAllocator * | visibilityBits () override |
VisualizationManager (RenderPanel *render_panel, WindowManagerInterface *wm=nullptr) | |
Constructor Creates managers and sets up global properties. More... | |
VisualizationManager (RenderPanel *render_panel, WindowManagerInterface *wm, boost::shared_ptr< tf::TransformListener > tf) | |
~VisualizationManager () override | |
Destructor Stops update timers and destroys all displays, tools, and managers. More... | |
Protected Slots | |
void | onToolChanged (Tool *tool) |
void | onUpdate () |
Call update() on all managed objects. More... | |
Protected Member Functions | |
void | createColorMaterials () |
void | threadedQueueThreadFunc () |
void | updateFrames () |
void | updateTime () |
Private Slots | |
void | updateBackgroundColor () |
void | updateDefaultLightVisible () |
void | updateFixedFrame () |
void | updateFps () |
Private Attributes | |
uint32_t | default_visibility_bit_ |
Ogre::Light * | directional_light_ |
DisplayFactory * | display_factory_ |
QString | help_path_ |
VisualizationManagerPrivate * | private_ |
BitAllocator | visibility_bit_allocator_ |
Additional Inherited Members | |
Public Slots inherited from rviz::DisplayContext |
The VisualizationManager class is the central manager class of rviz, holding all the Displays, Tools, ViewControllers, and other managers.
It keeps the current view controller for the main render window. It has a timer which calls update() on all the displays. It creates and holds pointers to the other manager objects: SelectionManager, FrameManager, the PropertyManager s, and Ogre::SceneManager.
The "protected" members should probably all be "private", as VisualizationManager is not intended to be subclassed.
Definition at line 100 of file visualization_manager.h.
|
explicit |
Constructor Creates managers and sets up global properties.
render_panel | a pointer to the main render panel widget of the app. |
wm | a pointer to the window manager (which is really just a VisualizationFrame, the top-level container widget of rviz). |
tf | a pointer to tf::TransformListener which will be internally used by FrameManager. |
Definition at line 127 of file visualization_manager.cpp.
|
optional |
Definition at line 135 of file visualization_manager.cpp.
|
overrideoptional |
Destructor Stops update timers and destroys all displays, tools, and managers.
Definition at line 237 of file visualization_manager.cpp.
|
optional |
Add a display to be managed by this panel.
display | The display to be added |
Definition at line 495 of file visualization_manager.cpp.
|
optionalsignal |
Emitted whenever the display configuration changes.
|
optionalprotected |
Definition at line 325 of file visualization_manager.cpp.
|
optional |
Create and add a display to this panel, by class lookup name.
class_lookup_name | "lookup name" of the Display subclass, for pluginlib. Should be of the form "packagename/displaynameofclass", like "rviz/Image". |
name | The name of this display instance shown on the GUI, like "Left arm camera". |
enabled | Whether to start enabled |
Definition at line 536 of file visualization_manager.cpp.
|
optional |
Emits statusUpdate() signal with the given message.
Definition at line 507 of file visualization_manager.cpp.
|
optionalsignal |
Emitted when ESC key is pressed.
|
inlineoverrideoptionalvirtual |
Implements rviz::DisplayContext.
Definition at line 361 of file visualization_manager.h.
|
inlineoverrideoptionalvirtual |
Return a factory for creating Display subclasses based on a class id string.
Implements rviz::DisplayContext.
Definition at line 343 of file visualization_manager.h.
|
inlineoptional |
Definition at line 348 of file visualization_manager.h.
|
overrideoptionalvirtual |
Return the fixed frame name.
Implements rviz::DisplayContext.
Definition at line 661 of file visualization_manager.cpp.
|
inlineoverrideoptionalvirtual |
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.
Implements rviz::DisplayContext.
Definition at line 333 of file visualization_manager.h.
|
inlineoverrideoptionalvirtual |
Return the FrameManager instance.
Implements rviz::DisplayContext.
Definition at line 323 of file visualization_manager.h.
|
inlineoptionalvirtual |
Definition at line 377 of file visualization_manager.h.
|
inlineoptional |
Return the main RenderPanel.
Definition at line 220 of file visualization_manager.h.
|
inlineoverrideoptionalvirtual |
Implements rviz::DisplayContext.
Definition at line 356 of file visualization_manager.h.
|
optional |
Return the ROS time, in seconds.
Definition at line 551 of file visualization_manager.cpp.
|
optional |
Return the ROS time in seconds since the last reset.
Definition at line 561 of file visualization_manager.cpp.
|
inlineoverrideoptionalvirtual |
Returns the Ogre::SceneManager used for the main RenderPanel.
Implements rviz::DisplayContext.
Definition at line 212 of file visualization_manager.h.
|
inlineoverrideoptionalvirtual |
Return a pointer to the SelectionManager.
Implements rviz::DisplayContext.
Definition at line 271 of file visualization_manager.h.
|
overrideoptionalvirtual |
Convenience function: returns getFrameManager()->getTF2BufferPtr().
Implements rviz::DisplayContext.
Definition at line 472 of file visualization_manager.cpp.
|
overrideoptionalvirtual |
Convenience function: returns getFrameManager()->getTFClient().
Implements rviz::DisplayContext.
Definition at line 460 of file visualization_manager.cpp.
|
overrideoptionalvirtual |
Return a CallbackQueue using a different thread than the main GUI one.
Implements rviz::DisplayContext.
Definition at line 279 of file visualization_manager.cpp.
|
inlineoverrideoptionalvirtual |
Return a pointer to the ToolManager.
Implements rviz::DisplayContext.
Definition at line 277 of file visualization_manager.h.
|
overrideoptionalvirtual |
Return the CallbackQueue using the main GUI thread.
Implements rviz::DisplayContext.
Definition at line 294 of file visualization_manager.cpp.
|
inlineoverrideoptionalvirtual |
Return a pointer to the ViewManager.
Implements rviz::DisplayContext.
Definition at line 283 of file visualization_manager.h.
|
optional |
Return the wall clock time, in seconds since 1970.
Definition at line 546 of file visualization_manager.cpp.
|
optional |
Return the wall clock time in seconds since the last reset.
Definition at line 556 of file visualization_manager.cpp.
|
inlineoverrideoptionalvirtual |
Return the window manager, if any.
Implements rviz::DisplayContext.
Definition at line 307 of file visualization_manager.h.
|
overrideoptionalvirtual |
Handle a single key event for a given RenderPanel.
If the key is Escape, switches to the default Tool (via getDefaultTool()). All other key events are passed to the current Tool (via getCurrentTool()).
Implements rviz::DisplayContext.
Definition at line 625 of file visualization_manager.cpp.
|
overrideoptionalvirtual |
Handle a mouse event.
This just copies the given event into an event queue. The events in the queue are processed by onUpdate() which is called from the main thread by a timer every 33ms.
Implements rviz::DisplayContext.
Definition at line 586 of file visualization_manager.cpp.
|
optional |
Do initialization that wasn't done in constructor. Initializes tool manager, view manager, selection manager.
Definition at line 267 of file visualization_manager.cpp.
|
optional |
Load the properties of each Display and most editable rviz data.
This is what is called when loading a "*.rviz" file.
config | The Config object to read from. Expected to be a Config::Map type. |
Definition at line 512 of file visualization_manager.cpp.
|
optional |
Lock a mutex to delay calls to Ogre::Root::renderOneFrame().
Definition at line 284 of file visualization_manager.cpp.
|
optional |
Notify this VisualizationManager that something about its display configuration has changed.
Definition at line 644 of file visualization_manager.cpp.
|
optionalprotectedslot |
Definition at line 649 of file visualization_manager.cpp.
|
optionalprotectedslot |
Call update() on all managed objects.
This is the central place where update() is called on most rviz objects. Display objects, the FrameManager, the current ViewController, the SelectionManager, PropertyManager. Also calls ros::spinOnce(), so any callbacks on the global CallbackQueue get called from here as well.
It is called at 30Hz from the update timer.
Definition at line 342 of file visualization_manager.cpp.
|
optionalsignal |
Emitted before updating all Displays.
|
overrideoptionalvirtual |
Queues a render. Multiple calls before a render happens will only cause a single render.
Implements rviz::DisplayContext.
Definition at line 337 of file visualization_manager.cpp.
|
optional |
Remove and delete all displays.
Definition at line 502 of file visualization_manager.cpp.
|
optional |
Resets the wall and ROS elapsed time to zero and calls resetDisplays().
Definition at line 477 of file visualization_manager.cpp.
|
optional |
Save the properties of each Display and most editable rviz data.
This is what is called when saving a "*.vcg" file.
config | The object to write to. |
Definition at line 528 of file visualization_manager.cpp.
|
optional |
Set the coordinate frame we should be transforming all fixed data into.
frame | The name of the frame – must match the frame name broadcast to libTF |
Definition at line 666 of file visualization_manager.cpp.
|
inlineoptionalvirtual |
Definition at line 373 of file visualization_manager.h.
|
overrideoptionalvirtual |
Set the message displayed in the status bar
Implements rviz::DisplayContext.
Definition at line 671 of file visualization_manager.cpp.
|
optional |
Start timers. Creates and starts the update and idle timers, both set to 30Hz (33ms).
Definition at line 299 of file visualization_manager.cpp.
|
optionalsignal |
Emitted during file-loading and initialization to indicate progress.
|
optional |
Definition at line 305 of file visualization_manager.cpp.
|
optionalprotected |
Definition at line 632 of file visualization_manager.cpp.
|
optional |
Unlock a mutex, allowing calls to Ogre::Root::renderOneFrame().
Definition at line 289 of file visualization_manager.cpp.
|
privateslot |
Definition at line 566 of file visualization_manager.cpp.
|
privateslot |
Definition at line 581 of file visualization_manager.cpp.
|
privateslot |
Definition at line 653 of file visualization_manager.cpp.
|
privateslot |
Definition at line 573 of file visualization_manager.cpp.
|
optionalprotected |
Definition at line 423 of file visualization_manager.cpp.
|
optionalprotected |
Definition at line 406 of file visualization_manager.cpp.
|
inlineoverrideoptionalvirtual |
Implements rviz::DisplayContext.
Definition at line 366 of file visualization_manager.h.
|
protected |
Definition at line 446 of file visualization_manager.h.
|
protected |
Definition at line 437 of file visualization_manager.h.
|
private |
Definition at line 471 of file visualization_manager.h.
|
private |
Definition at line 474 of file visualization_manager.h.
|
private |
Definition at line 469 of file visualization_manager.h.
|
protected |
Definition at line 427 of file visualization_manager.h.
|
protected |
Frame to transform fixed data to.
Definition at line 434 of file visualization_manager.h.
|
protected |
Definition at line 436 of file visualization_manager.h.
|
protected |
Definition at line 454 of file visualization_manager.h.
|
protected |
Definition at line 458 of file visualization_manager.h.
|
protected |
Definition at line 449 of file visualization_manager.h.
|
protected |
Definition at line 433 of file visualization_manager.h.
|
protected |
Definition at line 435 of file visualization_manager.h.
|
private |
Definition at line 473 of file visualization_manager.h.
|
protected |
Stores how long it's been since the last update.
Definition at line 422 of file visualization_manager.h.
|
protected |
Definition at line 423 of file visualization_manager.h.
|
protected |
Definition at line 460 of file visualization_manager.h.
|
optionalprotected |
Ogre Root.
Definition at line 418 of file visualization_manager.h.
|
private |
Definition at line 470 of file visualization_manager.h.
|
protected |
Definition at line 439 of file visualization_manager.h.
|
protected |
Definition at line 453 of file visualization_manager.h.
|
protected |
Definition at line 428 of file visualization_manager.h.
|
protected |
Definition at line 442 of file visualization_manager.h.
|
protected |
Definition at line 444 of file visualization_manager.h.
|
protected |
Ogre scene manager associated with this panel.
Definition at line 419 of file visualization_manager.h.
|
protected |
Definition at line 451 of file visualization_manager.h.
|
protected |
Definition at line 425 of file visualization_manager.h.
|
protected |
Definition at line 448 of file visualization_manager.h.
|
protected |
Definition at line 430 of file visualization_manager.h.
|
protected |
Display::update is called on each display whenever this timer fires.
Definition at line 421 of file visualization_manager.h.
|
protected |
Definition at line 431 of file visualization_manager.h.
|
private |
Definition at line 472 of file visualization_manager.h.
|
protected |
Definition at line 441 of file visualization_manager.h.
|
protected |
Definition at line 443 of file visualization_manager.h.
|
protected |
Definition at line 456 of file visualization_manager.h.