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

Displays a menu when the right mouse button has been pressed. More...

#include <gui/gui.hh>

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

Public Types

enum  EntityTypes { MODEL, LIGHT, LINK }
 Unique identifiers for the type of entity this menu is attached to. More...
 

Public Member Functions

 ModelRightMenu ()
 Constructor. More...
 
virtual ~ModelRightMenu ()
 Destructor. More...
 
bool Init ()
 Initialize the right menu. More...
 
void Run (const std::string &_entityName, const QPoint &_pt, EntityTypes _type=MODEL)
 Show the right menu. More...
 

Detailed Description

Displays a menu when the right mouse button has been pressed.

Member Enumeration Documentation

Unique identifiers for the type of entity this menu is attached to.

Enumerator
MODEL 

Model.

LIGHT 

Light.

LINK 

Link.

Constructor & Destructor Documentation

gazebo::gui::ModelRightMenu::ModelRightMenu ( )

Constructor.

virtual gazebo::gui::ModelRightMenu::~ModelRightMenu ( )
virtual

Destructor.

Member Function Documentation

bool gazebo::gui::ModelRightMenu::Init ( )

Initialize the right menu.

Returns
True on success.
void gazebo::gui::ModelRightMenu::Run ( const std::string &  _entityName,
const QPoint &  _pt,
EntityTypes  _type = MODEL 
)

Show the right menu.

Parameters
[in]_entityNameName of the entity that is active.
[in]_ptPoint on the GUI that has received the right-click request.
[in]_typeType of the entity clicked.

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