Events Class Reference

#include <GuiEvents.hh>

Static Public Member Functions
template<typename T >
static event::ConnectionPtr	ConnectAlignMode (T _subscriber)
	Connect a signal to the align mode signal. More...
template<typename T >
static event::ConnectionPtr	ConnectCreateEntity (T _subscriber)
	Connect a signal the add entity signal. More...
template<typename T >
static event::ConnectionPtr	ConnectEditModel (T _subscriber)
	Connect a signal to the edit model signal. More...
template<typename T >
static event::ConnectionPtr	ConnectFollow (T _subscriber)
	Connect a signal to the follow signal. More...
template<typename T >
static event::ConnectionPtr	ConnectFPS (T _subscriber)
	Connect a signal to the view FPS signal. More...
template<typename T >
static event::ConnectionPtr	ConnectFullScreen (T _subscriber)
	Connect a signal to the fullscreen signal. More...
template<typename T >
static event::ConnectionPtr	ConnectInputStepSize (T _subscriber)
	Connect a signal to the input step size signal. More...
template<typename T >
static event::ConnectionPtr	ConnectKeyPress (T _subscriber)
	Connect a signal to the view KeyPress signal. More...
template<typename T >
static event::ConnectionPtr	ConnectLeftPaneVisibility (T _subscriber)
	Connect a signal to toggle the GUI's left hand pane signal. More...
template<typename T >
static event::ConnectionPtr	ConnectLightUpdate (T _subscriber)
	Connect a signal to the light update signal. More...
template<typename T >
static event::ConnectionPtr	ConnectMainWindowReady (T _subscriber)
	Connect a signal to the main window ready signal. More...
template<typename T >
static event::ConnectionPtr	ConnectManipMode (T _subscriber)
	Connect a signal to the manip mode signal. More...
template<typename T >
static event::ConnectionPtr	ConnectModelUpdate (T _subscriber)
	Connect a signal to the model update signal. More...
template<typename T >
static event::ConnectionPtr	ConnectMoveEntity (T _subscriber)
	Connect a signal to the move entity event. More...
template<typename T >
static event::ConnectionPtr	ConnectMoveMode (T _subscriber)
	Connect a signal to the move mode signal. More...
template<typename T >
static event::ConnectionPtr	ConnectOrbit (T _subscriber)
	Connect a signal to the view Orbit signal. More...
template<typename T >
static event::ConnectionPtr	ConnectScaleEntity (T _subscriber)
	Connect a signal to the scale entity signal. More...
template<typename T >
static event::ConnectionPtr	ConnectShowToolbars (T _subscriber)
	Connect a signal to the show toolbars signal. More...
template<typename T >
static event::ConnectionPtr	ConnectWindowMode (T _subscriber)
	Connect a signal to the window mode signal. More...
static void	DisconnectAlignMode (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the align mode signal. More...
static void	DisconnectCreateEntity (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from add entity signal. More...
static void	DisconnectEditModel (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the edit model signal. More...
static void	DisconnectFollow (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the follow signal. More...
static void	DisconnectFPS (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the view FPS signal. More...
static void	DisconnectFullScreen (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the fullscreen signal. More...
static void	DisconnectInputStepSize (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the input step size signal. More...
static void	DisconnectKeyPress (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the view KeyPress signal. More...
static void	DisconnectLeftPaneVisibility (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal to toggle the GUI's left hand pane signal. More...
static void	DisconnectLightUpdate (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the light update signal. More...
static void	DisconnectMainWindowReady (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the main window ready signal. More...
static void	DisconnectManipMode (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the manip mode signal. More...
static void	DisconnectModelUpdate (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the model update signal. More...
static void	DisconnectMoveEntity (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the move entity event. More...
static void	DisconnectMoveMode (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the move mode signal. More...
static void	DisconnectOrbit (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the view Orbit signal. More...
static void	DisconnectScaleEntity (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the scale entity signal. More...
static void	DisconnectShowToolbars (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the show toolbars signal. More...
static void	DisconnectWindowMode (event::ConnectionPtr _subscriber) GAZEBO_DEPRECATED(8.0)
	Disconnect a signal from the window mode signal. More...

Static Public Attributes
static event::EventT< void(std::string, std::string, std::string, bool, bool)>	alignMode
	indicates the user is aligning objects More...
static event::EventT< void(std::string, std::string)>	createEntity
	indicates an entity has been created More...
static event::EventT< void(const std::string &)>	editModel
	Event triggered when the user selects edit a model. More...
static event::EventT< void(const std::string &)>	follow
	Event triggered when the user follows a model. More...
static event::EventT< void()>	fps
	An event to enable first-person-shooter view control. More...
static event::EventT< void(bool)>	fullScreen
	An event to trigger full screen mode. More...
static event::EventT< void(int)>	inputStepSize
	Step size changed event. More...
static event::EventT< void(std::string)>	keyPress
	Event triggered when a key is pressed. More...
static event::EventT< void(bool)>	leftPaneVisibility
	Used to set whether the GUI's left pane is visible. More...
static event::EventT< void(const msgs::Light &)>	lightUpdate
	An event to notify light updates. More...
static event::EventT< void()>	mainWindowReady
	Main window ready event. More...
static event::EventT< void(std::string)>	manipMode
	indicates the user is manipulating an object More...
static event::EventT< void(const msgs::Model &)>	modelUpdate
	indicates a model has been updated More...
static event::EventT< void(const std::string &, const ignition::math::Pose3d &, const bool)>	moveEntity
	Move entity event. More...
static event::EventT< void(bool)>	moveMode
	Indicates the user is moving the camera. More...
static event::EventT< void()>	orbit
	An event to enable orbit view control. More...
static event::EventT< void(const std::string &, const ignition::math::Vector3d &)>	scaleEntity
	Scale entity event. More...
static event::EventT< void(bool)>	showToolbars
	An event to trigger show toolbars. More...
static event::EventT< void(const std::string &)>	windowMode
	Event triggered when changing window mode. More...

Member Function Documentation

static event::ConnectionPtr ConnectAlignMode ( T  _subscriber )

inlinestatic

Connect a signal to the align mode signal.

References Events::alignMode, and EventT< T >::Connect().

static event::ConnectionPtr ConnectCreateEntity ( T  _subscriber )

inlinestatic

Connect a signal the add entity signal.

References EventT< T >::Connect(), and Events::createEntity.

static event::ConnectionPtr ConnectEditModel ( T  _subscriber )

inlinestatic

Connect a signal to the edit model signal.

References EventT< T >::Connect(), and Events::editModel.

static event::ConnectionPtr ConnectFollow ( T  _subscriber )

inlinestatic

Connect a signal to the follow signal.

References EventT< T >::Connect(), and Events::follow.

static event::ConnectionPtr ConnectFPS ( T  _subscriber )

inlinestatic

Connect a signal to the view FPS signal.

References EventT< T >::Connect(), and Events::fps.

static event::ConnectionPtr ConnectFullScreen ( T  _subscriber )

inlinestatic

Connect a signal to the fullscreen signal.

References EventT< T >::Connect(), and Events::fullScreen.

static event::ConnectionPtr ConnectInputStepSize ( T  _subscriber )

inlinestatic

Connect a signal to the input step size signal.

References EventT< T >::Connect(), and Events::inputStepSize.

static event::ConnectionPtr ConnectKeyPress ( T  _subscriber )

inlinestatic

Connect a signal to the view KeyPress signal.

References EventT< T >::Connect(), and Events::keyPress.

static event::ConnectionPtr ConnectLeftPaneVisibility ( T  _subscriber )

inlinestatic

Connect a signal to toggle the GUI's left hand pane signal.

References EventT< T >::Connect(), and Events::leftPaneVisibility.

static event::ConnectionPtr ConnectLightUpdate ( T  _subscriber )

inlinestatic

Connect a signal to the light update signal.

References EventT< T >::Connect(), and Events::lightUpdate.

static event::ConnectionPtr ConnectMainWindowReady ( T  _subscriber )

inlinestatic

Connect a signal to the main window ready signal.

References EventT< T >::Connect(), and Events::mainWindowReady.

static event::ConnectionPtr ConnectManipMode ( T  _subscriber )

inlinestatic

Connect a signal to the manip mode signal.

References EventT< T >::Connect(), and Events::manipMode.

static event::ConnectionPtr ConnectModelUpdate ( T  _subscriber )

inlinestatic

Connect a signal to the model update signal.

References EventT< T >::Connect(), and Events::modelUpdate.

static event::ConnectionPtr ConnectMoveEntity ( T  _subscriber )

inlinestatic

Connect a signal to the move entity event.

References EventT< T >::Connect(), and Events::moveEntity.

static event::ConnectionPtr ConnectMoveMode ( T  _subscriber )

inlinestatic

Connect a signal to the move mode signal.

References EventT< T >::Connect(), and Events::moveMode.

static event::ConnectionPtr ConnectOrbit ( T  _subscriber )

inlinestatic

Connect a signal to the view Orbit signal.

References EventT< T >::Connect(), and Events::orbit.

static event::ConnectionPtr ConnectScaleEntity ( T  _subscriber )

inlinestatic

Connect a signal to the scale entity signal.

References EventT< T >::Connect(), and Events::scaleEntity.

static event::ConnectionPtr ConnectShowToolbars ( T  _subscriber )

inlinestatic

Connect a signal to the show toolbars signal.

References EventT< T >::Connect(), and Events::showToolbars.

static event::ConnectionPtr ConnectWindowMode ( T  _subscriber )

inlinestatic

Connect a signal to the window mode signal.

References EventT< T >::Connect(), and Events::windowMode.

static void DisconnectAlignMode ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the align mode signal.

Deprecated:

Use event::~Connection to disconnect

References Events::alignMode, and EventT< T >::Disconnect().

static void DisconnectCreateEntity ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from add entity signal.

Deprecated:

Use event::~Connection to disconnect

References Events::createEntity, and EventT< T >::Disconnect().

static void DisconnectEditModel ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the edit model signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::editModel.

static void DisconnectFollow ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the follow signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::follow.

static void DisconnectFPS ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the view FPS signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::fps.

static void DisconnectFullScreen ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the fullscreen signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::fullScreen.

static void DisconnectInputStepSize ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the input step size signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::inputStepSize.

static void DisconnectKeyPress ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the view KeyPress signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::keyPress.

static void DisconnectLeftPaneVisibility ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal to toggle the GUI's left hand pane signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::leftPaneVisibility.

static void DisconnectLightUpdate ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the light update signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::lightUpdate.

static void DisconnectMainWindowReady ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the main window ready signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::mainWindowReady.

static void DisconnectManipMode ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the manip mode signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::manipMode.

static void DisconnectModelUpdate ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the model update signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::modelUpdate.

static void DisconnectMoveEntity ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the move entity event.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::moveEntity.

static void DisconnectMoveMode ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the move mode signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::moveMode.

static void DisconnectOrbit ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the view Orbit signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::orbit.

static void DisconnectScaleEntity ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the scale entity signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::scaleEntity.

static void DisconnectShowToolbars ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the show toolbars signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::showToolbars.

static void DisconnectWindowMode ( event::ConnectionPtr  _subscriber )

inlinestatic

Disconnect a signal from the window mode signal.

Deprecated:

Use event::~Connection to disconnect

References EventT< T >::Disconnect(), and Events::windowMode.

Member Data Documentation

event::EventT<void (std::string, std::string, std::string, bool, bool)> alignMode

static

indicates the user is aligning objects

Referenced by Events::ConnectAlignMode(), and Events::DisconnectAlignMode().

event::EventT<void (std::string, std::string)> createEntity

static

indicates an entity has been created

Referenced by Events::ConnectCreateEntity(), and Events::DisconnectCreateEntity().

event::EventT<void (const std::string &)> editModel

static

Event triggered when the user selects edit a model.

The model name is given as the function parameter.

Referenced by Events::ConnectEditModel(), and Events::DisconnectEditModel().

event::EventT<void (const std::string &)> follow

static

Event triggered when the user follows a model.

The model name is given as the function parameter.

Referenced by Events::ConnectFollow(), and Events::DisconnectFollow().

event::EventT<void ()> fps

static

An event to enable first-person-shooter view control.

Referenced by Events::ConnectFPS(), and Events::DisconnectFPS().

event::EventT<void (bool)> fullScreen

static

An event to trigger full screen mode.

Referenced by Events::ConnectFullScreen(), and Events::DisconnectFullScreen().

event::EventT<void (int)> inputStepSize

static

Step size changed event.

Referenced by Events::ConnectInputStepSize(), and Events::DisconnectInputStepSize().

event::EventT<void (std::string)> keyPress

static

Event triggered when a key is pressed.

Referenced by Events::ConnectKeyPress(), and Events::DisconnectKeyPress().

event::EventT<void (bool)> leftPaneVisibility

static

Used to set whether the GUI's left pane is visible.

Referenced by Events::ConnectLeftPaneVisibility(), and Events::DisconnectLeftPaneVisibility().

event::EventT<void (const msgs::Light &)> lightUpdate

static

An event to notify light updates.

Referenced by Events::ConnectLightUpdate(), and Events::DisconnectLightUpdate().

event::EventT<void ()> mainWindowReady

static

Main window ready event.

Referenced by Events::ConnectMainWindowReady(), and Events::DisconnectMainWindowReady().

event::EventT<void (std::string)> manipMode

static

indicates the user is manipulating an object

Referenced by Events::ConnectManipMode(), and Events::DisconnectManipMode().

event::EventT<void (const msgs::Model &)> modelUpdate

static

indicates a model has been updated

Referenced by Events::ConnectModelUpdate(), and Events::DisconnectModelUpdate().

event::EventT<void (const std::string &, const ignition::math::Pose3d &, const bool)> moveEntity

static

Move entity event.

Parameters: Entity name, new pose, flag indicating whether the pose is final.

Referenced by Events::ConnectMoveEntity(), and Events::DisconnectMoveEntity().

event::EventT<void (bool)> moveMode

static

Indicates the user is moving the camera.

Referenced by Events::ConnectMoveMode(), and Events::DisconnectMoveMode().

event::EventT<void ()> orbit

static

An event to enable orbit view control.

Referenced by Events::ConnectOrbit(), and Events::DisconnectOrbit().

event::EventT<void (const std::string &, const ignition::math::Vector3d &)> scaleEntity

static

Scale entity event.

Referenced by Events::ConnectScaleEntity(), and Events::DisconnectScaleEntity().

event::EventT<void (bool)> showToolbars

static

An event to trigger show toolbars.

Referenced by Events::ConnectShowToolbars(), and Events::DisconnectShowToolbars().

event::EventT<void (const std::string &)> windowMode

static

Event triggered when changing window mode.

Possible modes are: "Simulation", "ModelEditor", "LogPlayback"

Referenced by Events::ConnectWindowMode(), and Events::DisconnectWindowMode().

---

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

• GuiEvents.hh