Inheritance diagram for gazebo::gui::RenderWidget:

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...

TimePanel *	GetTimePanel () const
	Get the time panel widget. More...

QToolBar *	GetToolbar () 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]	_plugin	Plugin pointer to add.
[in]	_elem	Plugin 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]	_msg	Message to be displayed
[in]	_duration	Duration in milliseconds

std::string gazebo::gui::RenderWidget::GetOverlayMsg ( ) const

Get the overlay message being displayed.

TimePanel* gazebo::gui::RenderWidget::GetTimePanel ( ) const

Get the time panel widget.

QToolBar* gazebo::gui::RenderWidget::GetToolbar ( ) const

Get the toolbar on top of the render widget.

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

Add a widget inside the render widget.

Parameters

[in]	_widget	Widget to be added.
[in]	_index	Index in the splitter to add the widget at.

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] _visible True 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] _show Whether or not to show the toolbar.

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