#include <MainWindow.hh>

Inheritance diagram for gazebo::gui::MainWindow:

Public Slots
void	Pause ()
	Pause simulation. More...

void	Play ()
	Play simulation. More...

Signals
void	AddPlugins ()
	A signal to trigger loading of GUI plugins. More...

void	Close ()
	A signal to indicate the main window is about to close. More...

Public Member Functions
	MainWindow ()
	Constructor. More...

virtual	~MainWindow ()
	Destructor. More...

void	AddMenu (QMenu *_menu)
	Add a menu to the main window menu bar. More...

void	AddToLeftColumn (const std::string &_name, QWidget *_widget)
	Add a widget to the left column stack of widgets. More...

QAction *	CloneAction (QAction _action, QObject _parent)
	Create a new action with information from the given action, such as text and tooltip. More...

gui::Editor *	Editor (const std::string &_name) const
	Get an editor by name. More...

unsigned int	EntityId (const std::string &_name)
	Get an entity id. More...

gui::Editor *	GetEditor (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
	Get an editor by name. More...

gui::RenderWidget *	GetRenderWidget () const GAZEBO_DEPRECATED(7.0)
	Get a pointer to the render widget. More...

bool	HasEntityName (const std::string &_name)
	Has an entity name. More...

void	Init ()
	Initialization. More...

bool	IsPaused () const
	Returns the state of the simulation, true if paused. More...

void	Load ()
	Load the mainwindow. More...

gui::RenderWidget *	RenderWidget () const
	Get a pointer to the render widget. More...

void	SetLeftPaneVisibility (bool _on)
	Set whether the left pane is visible. More...

void	ShowLeftColumnWidget (const std::string &_name="default")
	Show a widget in the left column. More...

void	ShowMenuBar (QMenuBar *_bar=NULL)
	Show a custom menubar. More...

Protected Member Functions
void	closeEvent (QCloseEvent *_event)

Constructor & Destructor Documentation

gazebo::gui::MainWindow::MainWindow ( )

Constructor.

virtual gazebo::gui::MainWindow::~MainWindow ( )

virtual

Destructor.

Member Function Documentation

void gazebo::gui::MainWindow::AddMenu ( QMenu * _menu )

Add a menu to the main window menu bar.

Parameters

[in] _menu Menu to be added.

void gazebo::gui::MainWindow::AddPlugins ( )

signal

A signal to trigger loading of GUI plugins.

void gazebo::gui::MainWindow::AddToLeftColumn	(	const std::string &	_name,
		QWidget *	_widget
	)

Add a widget to the left column stack of widgets.

Parameters

[in]	_name	Name of the widget
[in]	_widget	Pointer to the widget to add.

QAction* gazebo::gui::MainWindow::CloneAction	(	QAction *	_action,
		QObject *	_parent
	)

Create a new action with information from the given action, such as text and tooltip.

The new action triggers the original action and follows its checked state. This is used for example to have the "same" action on the main window menu and the model editor menu, since an action can't be added to 2 different menus.

Parameters

[in]	_action	Action to be cloned.
[in]	_parent	Parent for the new action.

Returns: The new action.

void gazebo::gui::MainWindow::Close ( )

signal

A signal to indicate the main window is about to close.

void gazebo::gui::MainWindow::closeEvent ( QCloseEvent * _event )

protected

gui::Editor* gazebo::gui::MainWindow::Editor ( const std::string & _name ) const

Get an editor by name.

Parameters

[in] _name Name of the editor.

Returns: Pointer to the editor.

unsigned int gazebo::gui::MainWindow::EntityId ( const std::string & _name )

Get an entity id.

Parameters

[in] _name The name of the entity

Returns: The entity id

gui::Editor* gazebo::gui::MainWindow::GetEditor ( const std::string & _name ) const

Get an editor by name.

Parameters

[in] _name Name of the editor.

Returns: Pointer to the editor.

Deprecated:: See Editor(const std::string &_name) const.

gui::RenderWidget* gazebo::gui::MainWindow::GetRenderWidget ( ) const

Get a pointer to the render widget.

Returns: A pointer to the render widget.

Deprecated:: See RenderWidget() const.

bool gazebo::gui::MainWindow::HasEntityName ( const std::string & _name )

Has an entity name.

Parameters

[in] _name The entity name

Returns: True if the entity has a name

void gazebo::gui::MainWindow::Init ( )

Initialization.

bool gazebo::gui::MainWindow::IsPaused ( ) const

Returns the state of the simulation, true if paused.

Returns: True if paused, false otherwise.

void gazebo::gui::MainWindow::Load ( )

Load the mainwindow.

void gazebo::gui::MainWindow::Pause ( )

slot

Pause simulation.

void gazebo::gui::MainWindow::Play ( )

slot

Play simulation.

gui::RenderWidget* gazebo::gui::MainWindow::RenderWidget ( ) const

Get a pointer to the render widget.

Returns: A pointer to the render widget.

void gazebo::gui::MainWindow::SetLeftPaneVisibility ( bool _on )

Set whether the left pane is visible.

Parameters

[in] _on True to show the left pane, false to hide.

void gazebo::gui::MainWindow::ShowLeftColumnWidget ( const std::string & _name = "default" )

Show a widget in the left column.

See Also: AddToLeftColumn

Parameters

[in] _name Name of the widge to show. The widget must have been added using AddToLeftColumn. The string "default" will show the main tab.

void gazebo::gui::MainWindow::ShowMenuBar ( QMenuBar * _bar = NULL )

Show a custom menubar.

If NULL is used, the default menubar is shown.

Parameters

[in] _bar The menubar to show. NULL will show the default menubar.

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

MainWindow.hh

Public Slots

Signals

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation