Public Member Functions | List of all members
gazebo::gui::RenderWidget Class Reference

#include <RenderWidget.hh>

Inheritance diagram for gazebo::gui::RenderWidget:
Inheritance graph
[legend]

Public Member Functions

 RenderWidget (QWidget *_parent=0)
 
virtual ~RenderWidget ()
 
void AddPlugin (GUIPluginPtr _plugin, sdf::ElementPtr _elem)
 Add a plugin to the render widget. More...
 
void CreateScene (const std::string &_name)
 
void DisplayOverlayMsg (const std::string &_msg, int _duration=-1)
 Display an overlay message. More...
 
std::string GetOverlayMsg () const
 Get the overlay message being displayed. More...
 
TimePanelGetTimePanel () const
 Get the time panel widget. More...
 
TopToolbarGetToolbar () const
 Get the toolbar on top of the render widget. More...
 
void InsertWidget (unsigned int _index, QWidget *_widget)
 Add a widget inside the render widget. More...
 
void RemoveScene (const std::string &_name)
 
void SetOverlaysVisible (const bool _visible)
 Show or hide all the GUI overlays. More...
 
void ShowTimePanel (bool _show)
 Show the time panel. More...
 
void ShowToolbar (const bool _show)
 Set the visibility of the toolbar. More...
 

Constructor & Destructor Documentation

gazebo::gui::RenderWidget::RenderWidget ( QWidget *  _parent = 0)
virtual gazebo::gui::RenderWidget::~RenderWidget ( )
virtual

Member Function Documentation

void gazebo::gui::RenderWidget::AddPlugin ( GUIPluginPtr  _plugin,
sdf::ElementPtr  _elem 
)

Add a plugin to the render widget.

Parameters
[in]_pluginPlugin pointer to add.
[in]_elemPlugin sdf parameters.
void gazebo::gui::RenderWidget::CreateScene ( const std::string &  _name)
void gazebo::gui::RenderWidget::DisplayOverlayMsg ( const std::string &  _msg,
int  _duration = -1 
)

Display an overlay message.

Parameters
[in]_msgMessage to be displayed
[in]_durationDuration in milliseconds
std::string gazebo::gui::RenderWidget::GetOverlayMsg ( ) const

Get the overlay message being displayed.

Returns
Message displayed in the render window
TimePanel* gazebo::gui::RenderWidget::GetTimePanel ( ) const

Get the time panel widget.

Returns
the time panel widget.
TopToolbar* gazebo::gui::RenderWidget::GetToolbar ( ) const

Get the toolbar on top of the render widget.

Returns
Toolbar
void gazebo::gui::RenderWidget::InsertWidget ( unsigned int  _index,
QWidget *  _widget 
)

Add a widget inside the render widget.

Parameters
[in]_indexIndex in the splitter to add the widget at.
[in]_widgetWidget to be added.
void gazebo::gui::RenderWidget::RemoveScene ( const std::string &  _name)
void gazebo::gui::RenderWidget::SetOverlaysVisible ( const bool  _visible)

Show or hide all the GUI overlays.

Parameters
[in]_visibleTrue to show the GUI overlays, false to hide them.
void gazebo::gui::RenderWidget::ShowTimePanel ( bool  _show)

Show the time panel.

[in] _show True to show the panel, false to hide it.

void gazebo::gui::RenderWidget::ShowToolbar ( const bool  _show)

Set the visibility of the toolbar.

Parameters
[in]_showWhether or not to show the toolbar.

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