##

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

## ConnectAlignMode()

static event::ConnectionPtr ConnectAlignMode | ( | T | _subscriber | ) |

inline static

Connect a signal to the align mode signal.

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

## ConnectCreateEntity()

static event::ConnectionPtr ConnectCreateEntity | ( | T | _subscriber | ) |

inline static

Connect a signal the add entity signal.

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

## ConnectEditModel()

static event::ConnectionPtr ConnectEditModel | ( | T | _subscriber | ) |

inline static

Connect a signal to the edit model signal.

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

## ConnectFollow()

static event::ConnectionPtr ConnectFollow | ( | T | _subscriber | ) |

inline static

Connect a signal to the follow signal.

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

## ConnectFPS()

static event::ConnectionPtr ConnectFPS | ( | T | _subscriber | ) |

inline static

Connect a signal to the view FPS signal.

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

## ConnectFullScreen()

static event::ConnectionPtr ConnectFullScreen | ( | T | _subscriber | ) |

inline static

Connect a signal to the fullscreen signal.

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

## ConnectInputStepSize()

static event::ConnectionPtr ConnectInputStepSize | ( | T | _subscriber | ) |

inline static

Connect a signal to the input step size signal.

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

## ConnectKeyPress()

static event::ConnectionPtr ConnectKeyPress | ( | T | _subscriber | ) |

inline static

Connect a signal to the view KeyPress signal.

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

## ConnectLeftPaneVisibility()

static event::ConnectionPtr ConnectLeftPaneVisibility | ( | T | _subscriber | ) |

inline static

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

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

## ConnectLightUpdate()

static event::ConnectionPtr ConnectLightUpdate | ( | T | _subscriber | ) |

inline static

Connect a signal to the light update signal.

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

## ConnectMainWindowReady()

static event::ConnectionPtr ConnectMainWindowReady | ( | T | _subscriber | ) |

inline static

Connect a signal to the main window ready signal.

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

## ConnectManipMode()

static event::ConnectionPtr ConnectManipMode | ( | T | _subscriber | ) |

inline static

Connect a signal to the manip mode signal.

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

## ConnectModelUpdate()

static event::ConnectionPtr ConnectModelUpdate | ( | T | _subscriber | ) |

inline static

Connect a signal to the model update signal.

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

## ConnectMoveEntity()

static event::ConnectionPtr ConnectMoveEntity | ( | T | _subscriber | ) |

inline static

Connect a signal to the move entity event.

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

## ConnectMoveMode()

static event::ConnectionPtr ConnectMoveMode | ( | T | _subscriber | ) |

inline static

Connect a signal to the move mode signal.

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

## ConnectOrbit()

static event::ConnectionPtr ConnectOrbit | ( | T | _subscriber | ) |

inline static

Connect a signal to the view Orbit signal.

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

## ConnectScaleEntity()

static event::ConnectionPtr ConnectScaleEntity | ( | T | _subscriber | ) |

inline static

Connect a signal to the scale entity signal.

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

## ConnectShowToolbars()

static event::ConnectionPtr ConnectShowToolbars | ( | T | _subscriber | ) |

inline static

Connect a signal to the show toolbars signal.

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

## ConnectWindowMode()

static event::ConnectionPtr ConnectWindowMode | ( | T | _subscriber | ) |

inline static

Connect a signal to the window mode signal.

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

## Member Data Documentation

## alignMode

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

static

indicates the user is aligning objects

Referenced by Events::ConnectAlignMode().

## createEntity

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

static

indicates an entity has been created

Referenced by Events::ConnectCreateEntity().

## editModel

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

## follow

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

## fps

event::EventT<void ()> fps

static

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

Referenced by Events::ConnectFPS().

## fullScreen

event::EventT<void (bool)> fullScreen

static

An event to trigger full screen mode.

Referenced by Events::ConnectFullScreen().

## inputStepSize

event::EventT<void (int)> inputStepSize

static

Step size changed event.

Referenced by Events::ConnectInputStepSize().

## keyPress

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

static

Event triggered when a key is pressed.

Referenced by Events::ConnectKeyPress().

## leftPaneVisibility

event::EventT<void (bool)> leftPaneVisibility

static

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

Referenced by Events::ConnectLeftPaneVisibility().

## lightUpdate

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

static

An event to notify light updates.

Referenced by Events::ConnectLightUpdate().

## mainWindowReady

event::EventT<void ()> mainWindowReady

static

Main window ready event.

Referenced by Events::ConnectMainWindowReady().

## manipMode

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

static

indicates the user is manipulating an object

Referenced by Events::ConnectManipMode().

## modelUpdate

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

static

indicates a model has been updated

Referenced by Events::ConnectModelUpdate().

## moveEntity

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

## moveMode

event::EventT<void (bool)> moveMode

static

Indicates the user is moving the camera.

Referenced by Events::ConnectMoveMode().

## orbit

event::EventT<void ()> orbit

static

An event to enable orbit view control.

Referenced by Events::ConnectOrbit().

## scaleEntity

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

static

Scale entity event.

Referenced by Events::ConnectScaleEntity().

## showToolbars

event::EventT<void (bool)> showToolbars

static

An event to trigger show toolbars.

Referenced by Events::ConnectShowToolbars().

## windowMode

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

static

Event triggered when changing window mode.

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

Referenced by Events::ConnectWindowMode().

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

- GuiEvents.hh