gazebo::gui Namespace Reference

gui namespace More...

Namespaces

 editor
 
 model
 

Classes

class  AlignWidget
 A gui widget for aligning models. More...
 
class  ApplyWrenchDialog
 Dialog for applying force and torque to a model. More...
 
class  BaseInspectorDialog
 Base Dialog for a specific inspector dialog. More...
 
class  BuildingEditor
 
class  BuildingEditorPalette
 A palette of building items which can be added to the editor. More...
 
class  BuildingEditorWidget
 The parent widget of the building editor, level widget and scale widget. More...
 
class  BuildingMaker
 Create and manage 3D visuals of a building. More...
 
class  BuildingModelManip
 Manipulate a 3D visual associated to a 2D editor item. More...
 
class  CloneWindow
 A dialog window used to set some parameters before cloning a simulation. More...
 
class  CollisionConfig
 A tab for configuring collision properties of a link. More...
 
class  CollisionConfigData
 A class of widgets used for configuring collision properties. More...
 
class  ConfigChildWidget
 A convenience widget that also holds pointers to a list of its child widgets. More...
 
class  ConfigWidget
 A widget generated from a google protobuf message. More...
 
class  Conversions
 Conversions Conversions.hh gui/Conversions.hh. More...
 
class  CurrentTimeItem
 Item which represents the current time within the view. More...
 
class  DataLogger
 A widget that provides data logging functionality. More...
 
class  DeleteAction
 Custom delete action. More...
 
class  DensityConfigWidget
 A widget for configuring density properties. More...
 
class  DirectionalLightMaker
 Used to insert a new directional light into the scene. More...
 
class  DoorItem
 2D representation of a door More...
 
class  EditableLabel
 Editable Label. More...
 
class  Editor
 Base class for editors, such as BuildingEditor and TerrainEditor. More...
 
class  EditorItem
 Base class of an item in the editor. More...
 
class  EditorMaterialListener
 Ogre material listener. More...
 
class  EditorMaterialSwitcher
 Material switcher for the model editor used to toggle the material of the model. More...
 
class  EditorRenderTargetListener
 Ogre render target listener. More...
 
class  EditorView
 Control the editor view and manage contents in the editor scene. More...
 
class  EntityMaker
 To make an entity, base class. More...
 
class  EnumConfigWidget
 A widget for configuring enum values. More...
 
class  Events
 
class  ExportDialog
 Dialog for saving to file. More...
 
class  ExtrudeDialog
 Dialog for saving to file. More...
 
class  FloorItem
 2D representation of a floor. More...
 
class  GeometryConfigWidget
 A widget for configuring geometry properties. More...
 
class  GLWidget
 
class  GrabberHandle
 
class  GraphScene
 A scene of 2D graph nodes and edges. More...
 
class  GraphView
 A view for the graph scene. More...
 
class  GridLines
 2D grid lines. More...
 
class  GroupWidget
 A collapsible widget that holds child widgets. More...
 
class  ImageFrame
 Frame that draws an image when a paintevent is received. More...
 
class  ImagesView
 
class  ImageView
 
class  ImportDialog
 Dialog for saving to file. More...
 
class  ImportImageDialog
 
class  ImportImageView
 Control the import image view and manage contents in the scene. More...
 
class  IncrementalPlot
 A plotting widget that handles incremental addition of data. More...
 
class  InsertModelWidget
 
class  IntrospectionCurveHandler
 Manages and updates curves based on introspection data. More...
 
class  JointControlWidget
 gui/JointControlWidget.hh More...
 
class  JointCreationDialog
 A class to inspect and modify joints. More...
 
class  JointData
 Helper class to store joint data. More...
 
class  JointForceControl
 Widget to control joints via application of force. More...
 
class  JointInspector
 A class to inspect and modify joints. More...
 
class  JointMaker
 Handles the creation of joints in the model editor. More...
 
class  JointPIDPosControl
 Widget to control joints via application of position PID controller. More...
 
class  JointPIDVelControl
 Widget to control joints via application of a velocity PID controller. More...
 
class  LaserView
 
class  LayersWidget
 A widget that manages visualization layers. More...
 
class  Level
 A convenient structure for storing level information. More...
 
class  LevelInspectorDialog
 Dialog for configuring a building level. More...
 
class  LevelWidget
 A widget for adding and changing building levels. More...
 
class  LightMaker
 Used to insert a new light into the scene. More...
 
class  LinkConfig
 A tab for configuring properties of a link. More...
 
class  LinkData
 Helper class to store link data. More...
 
class  LinkInspector
 
class  LogPlayView
 View for the timeline. More...
 
class  LogPlayWidget
 Widget which displays log playback options. More...
 
class  MainWindow
 
class  MeasureItem
 Measurement lines and values. More...
 
class  MEUserCmd
 Class which represents a user command, which can be "undone" and "redone". More...
 
class  MEUserCmdManager
 Class which manages user commands in the model editor. More...
 
class  ModelAlign
 A gui tool for aligning models. More...
 
class  ModelCreator
 Create and manage 3D visuals of a model with links, nested models and joints. More...
 
class  ModelData
 
class  ModelEditor
 Interface to the terrain editor. More...
 
class  ModelEditorPalette
 A palette of model items which can be added to the editor. More...
 
class  ModelListWidget
 
class  ModelMaker
 Used to insert new models into the scene. More...
 
class  ModelManipulator
 Manipulator tool for translating/rotating/scaling models and links. More...
 
class  ModelPluginData
 Helper class to store model plugin data. More...
 
class  ModelPluginInspector
 Inspector for model plugin properties. More...
 
class  ModelRightMenu
 Displays a menu when the right mouse button has been pressed. More...
 
class  ModelSnap
 A gui tool for snapping one model to another. More...
 
class  ModelTreeWidget
 A widget that displays model properties. More...
 
class  NestedModelData
 Helper class to store nested models data. More...
 
class  OculusWindow
 A widget that renders a camera view suitable for the Oculus Rift. More...
 
class  Palette
 A palette for the plot window, where plottable items can be dragged from. More...
 
class  PlotCanvas
 Plot canvas. More...
 
class  PlotCurve
 Plot Curve data. More...
 
class  PlotManager
 A class that connects simulation data with the plotting tool. More...
 
class  PlotTracker
 Mouse hover tracking. More...
 
class  PlotWindow
 Plot window. More...
 
class  PointLightMaker
 Used to insert a new point light into the scene. More...
 
class  RectItem
 2D rectangle. More...
 
class  RenderWidget
 
class  RestUiLoginDialog
 Provides a means to login to a webservice. More...
 
class  RotateHandle
 Handle for rotating an editor item. More...
 
class  SaveEntityDialog
 Dialog for saving to file. More...
 
class  ScaleWidget
 Widget that displays the scale (zoom level) of the editor. More...
 
class  SchematicViewWidget
 The parent widget of the CML editor. More...
 
class  SearchModel
 Customize the proxy model to display search results. More...
 
class  SegmentItem
 2D line segment. More...
 
class  SpaceNav
 Interface to the space navigator joystick. More...
 
class  SplashScreen
 Splash screen that displays an icon and a message. More...
 
class  SpotLightMaker
 Used to insert a new spot light into the scene. More...
 
class  StairsInspectorDialog
 Dialog for configuring a staircase item. More...
 
class  StairsItem
 2D representation of a staircase. More...
 
class  TerrainEditor
 Interface to the terrain editor. More...
 
class  TerrainEditorPalette
 A palette of building items which can be added to the editor. More...
 
class  TextView
 
class  TimePanel
 
class  TimeWidget
 
class  ToolsWidget
 A widget that manages all the tools on the right side of the render widget. More...
 
class  TopicCurveHandler
 Manages and updates curves based on topic data. More...
 
class  TopicSelector
 A widget that provides a list of topics to select from. More...
 
class  TopicView
 Base class for widgets that display topic data. More...
 
class  TopToolbar
 Toolbar on the top of the main window. More...
 
class  UserCmdHistory
 Class which manages user commands in the client side. More...
 
class  VariablePill
 A variable pill. More...
 
class  VariablePillContainer
 A container for holding variable pills. More...
 
class  VideoRecorder
 Helper class for recording the user camera to a video file. More...
 
class  ViewAngleWidget
 A gui widget for changing the camera view angle. More...
 
class  ViewFactory
 The view factory creates GUI widgets to visualize data on a topic. More...
 
class  ViewState
 A class for managing view visualization states. More...
 
class  VisualConfig
 A tab for configuring visual properties of a link. More...
 
class  VisualConfigData
 A class of widgets used for configuring visual properties. More...
 
class  WallInspectorDialog
 Dialog for configuring a wall item. More...
 
class  WallSegmentItem
 2D representation of a wall. More...
 
class  WindowDoorInspectorDialog
 Dialog for configuring a window or door item. More...
 
class  WindowItem
 2D representation of a window. More...
 

Typedefs

using CurveVariableSet = std::set< PlotCurveWeakPtr, std::owner_less< PlotCurveWeakPtr > >
 
using EditorMaterialListenerPtr = std::shared_ptr< EditorMaterialListener >
 
using EditorMaterialSwitcherPtr = std::shared_ptr< EditorMaterialSwitcher >
 
using EditorRenderTargetListenerPtr = std::shared_ptr< EditorRenderTargetListener >
 
typedef boost::shared_ptr< ImageViewImageViewPtr
 
typedef boost::shared_ptr< LaserViewLaserViewPtr
 
using MEUserCmdPtr = std::shared_ptr< MEUserCmd >
 
typedef std::shared_ptr< PlotCurvePlotCurvePtr
 
typedef std::weak_ptr< PlotCurvePlotCurveWeakPtr
 
typedef boost::shared_ptr< TextViewTextViewPtr
 
typedef boost::shared_ptr< TopicViewTopicViewPtr
 
typedef TopicView *(* ViewFactoryFn) (QWidget *_parent)
 

Enumerations

enum  FileType { CSVFile, PDFFile }
 Supported file types. More...
 

Functions

void clear_active_camera ()
 
rendering::UserCameraPtr get_active_camera ()
 
unsigned int get_entity_id (const std::string &_name)
 
MainWindowget_main_window ()
 Return a pointer to the main graphical window. More...
 
std::string get_world ()
 
template<typename T >
getINIProperty (const std::string &_key, const T &_default)
 Get a property from the GUI INI file. More...
 
bool has_entity_name (const std::string &_name)
 
void init ()
 
bool load ()
 Load the graphical interface. More...
 
bool loadINI (boost::filesystem::path _file="")
 Locate and load the INI configuration file. More...
 
bool register_metatypes ()
 Register the Qt metatypes. More...
 
bool run (int _argc, char **_argv)
 
bool saveINI (const boost::filesystem::path &_file)
 Save the configuration parameters to file. More...
 
void set_active_camera (rendering::UserCameraPtr _cam)
 
void set_world (const std::string &_name)
 
template<typename T >
bool setINIProperty (const std::string &_key, const T &_value)
 Set a value in the INI property tree. More...
 
void stop ()
 

Variables

QAction * g_aboutAct
 
QWidgetAction * g_alignAct
 
QAction * g_alignButtonAct
 
QAction * g_arrowAct
 
QAction * g_boxCreateAct
 
QAction * g_cameraOrthoAct
 Enable orthographic projection action. More...
 
QAction * g_cameraPerspectiveAct
 Enable perspective projection action. More...
 
QAction * g_cloneAct
 
QAction * g_copyAct
 
QAction * g_cylinderCreateAct
 
QAction * g_dataLoggerAct
 
DeleteActiong_deleteAct
 Action used to delete a model. More...
 
QAction * g_diagnosticsAct
 
QAction * g_dirLghtCreateAct
 
QAction * g_editBuildingAct
 
QAction * g_editModelAct
 
QAction * g_editTerrainAct
 
QAction * g_fpsAct
 
QAction * g_fullScreenAct
 
QAction * g_hotkeyChartAct
 
QAction * g_newAct
 
QAction * g_openAct
 
QAction * g_orbitAct
 
QAction * g_overlayAct
 
QAction * g_pasteAct
 
QAction * g_pauseAct
 
QAction * g_playAct
 
QAction * g_plotAct
 Action to show/hide the plotting utitlty. More...
 
QAction * g_pointLghtCreateAct
 
QAction * g_quitAct
 
QAction * g_redoAct
 Action to redo last undone user command. More...
 
QAction * g_redoHistoryAct
 Action to open the redo history menu. More...
 
QAction * g_resetAct
 
QAction * g_resetModelsAct
 
QAction * g_resetWorldAct
 
QAction * g_rotateAct
 
QAction * g_saveAct
 
QAction * g_saveAsAct
 
QAction * g_saveCfgAct
 
QAction * g_scaleAct
 
QAction * g_screenshotAct
 
QAction * g_showCollisionsAct
 Action to show/hide collision visuals for all models. More...
 
QAction * g_showCOMAct
 Action to show/hide CoM visuals for all models. More...
 
QAction * g_showContactsAct
 Action to show/hide contact visuals for all models. More...
 
QAction * g_showGridAct
 Action to show/hide the grid over the ground plane. More...
 
QAction * g_showInertiaAct
 Action to show/hide inertia visuals for all models. More...
 
QAction * g_showJointsAct
 Action to show/hide joint visuals for all models. More...
 
QAction * g_showLinkFrameAct
 Action to show/hide link frame visuals for all models. More...
 
QAction * g_showOriginAct
 Action to show/hide the world origin indicator. More...
 
QAction * g_showSkeletonAct
 Action to show/hide skeleton visuals for all models. More...
 
QAction * g_showToolbarsAct
 
QAction * g_snapAct
 
QAction * g_sphereCreateAct
 
QAction * g_spotLghtCreateAct
 
QAction * g_stepAct
 
QAction * g_topicVisAct
 
QAction * g_translateAct
 
QAction * g_transparentAct
 
QAction * g_undoAct
 Action to undo last user command. More...
 
QAction * g_undoHistoryAct
 Action to open the undo history menu. More...
 
QWidgetAction * g_viewAngleAct
 Action to open the view angle widget. More...
 
QAction * g_viewAngleButtonAct
 Action attached to the view angle button. More...
 
QAction * g_viewOculusAct
 
QAction * g_viewWireframeAct
 

Detailed Description

gui namespace

Plotting tool forward declarations and type defines.

GUI model editor forward declarations and type defines.

GUI forward declarations and type defines.

Typedef Documentation

using CurveVariableSet = std::set<PlotCurveWeakPtr, std::owner_less<PlotCurveWeakPtr> >
typedef boost::shared_ptr<ImageView> ImageViewPtr
typedef boost::shared_ptr<LaserView> LaserViewPtr
using MEUserCmdPtr = std::shared_ptr<MEUserCmd>
typedef std::shared_ptr<PlotCurve> PlotCurvePtr
typedef std::weak_ptr<PlotCurve> PlotCurveWeakPtr
typedef boost::shared_ptr<TextView> TextViewPtr
typedef boost::shared_ptr<TopicView> TopicViewPtr
typedef TopicView*(* ViewFactoryFn) (QWidget *_parent)

Enumeration Type Documentation

enum FileType

Supported file types.

Enumerator
CSVFile 

Comma separated value (CSV)

PDFFile 

Portable document format (PDF)

Function Documentation

void gazebo::gui::clear_active_camera ( )
rendering::UserCameraPtr gazebo::gui::get_active_camera ( )
unsigned int gazebo::gui::get_entity_id ( const std::string &  _name)
MainWindow* gazebo::gui::get_main_window ( )

Return a pointer to the main graphical window.

std::string gazebo::gui::get_world ( )
T gazebo::gui::getINIProperty ( const std::string &  _key,
const T &  _default 
)

Get a property from the GUI INI file.

Parameters
[in]_keyString based key[ SECTION.VALUE ]
[in]_defaultDefault value to use if property is not found.
Returns
Property value for the key.

References g_propTree.

bool gazebo::gui::has_entity_name ( const std::string &  _name)
void gazebo::gui::init ( )
bool gazebo::gui::load ( )

Load the graphical interface.

Returns
True on success.
bool gazebo::gui::loadINI ( boost::filesystem::path  _file = "")

Locate and load the INI configuration file.

If the GAZEBO_GUI_INI_FILE environment variable is set and contains valid content, load and return true. If GAZEBO_GUI_INI_FILE is not set, load from ~/.gazebo/gui.ini (a gui.ini file will be created if it doesn't exist) and return true. If GAZEBO_GUI_INI_FILE is set but the path does not exist, or if it exists and contains invalid content, do not load, and return false.

Parameters
[in]_filePath to a gui.ini file. This will override the environment variables.
Returns
True if an INI file was loaded, false otherwise.
bool gazebo::gui::register_metatypes ( )

Register the Qt metatypes.

Returns
True on success.
bool gazebo::gui::run ( int  _argc,
char **  _argv 
)
bool gazebo::gui::saveINI ( const boost::filesystem::path &  _file)

Save the configuration parameters to file.

Parameters
[in]_fileFilename in which to write the values.
Returns
True on success.

Referenced by setINIProperty().

void gazebo::gui::set_active_camera ( rendering::UserCameraPtr  _cam)
void gazebo::gui::set_world ( const std::string &  _name)
bool gazebo::gui::setINIProperty ( const std::string &  _key,
const T &  _value 
)

Set a value in the INI property tree.

Note, this doesn't save properties to disk.

Parameters
[in]_keyKey for the value, such as "geometry.x"
[in]_valueValue for the key
See also
gui::saveINI

References g_propTree, and saveINI().

void gazebo::gui::stop ( )

Variable Documentation

QAction* g_aboutAct
QWidgetAction* g_alignAct
QAction* g_alignButtonAct
QAction* g_arrowAct
QAction* g_boxCreateAct
QAction* g_cameraOrthoAct

Enable orthographic projection action.

QAction* g_cameraPerspectiveAct

Enable perspective projection action.

QAction* g_cloneAct
QAction* g_copyAct
QAction* g_cylinderCreateAct
QAction* g_dataLoggerAct
DeleteAction* g_deleteAct

Action used to delete a model.

Referenced by DeleteAction::Signal().

QAction* g_diagnosticsAct
QAction* g_dirLghtCreateAct
QAction* g_editBuildingAct
QAction* g_editModelAct
QAction* g_editTerrainAct
QAction* g_fpsAct
QAction* g_fullScreenAct
QAction* g_hotkeyChartAct
QAction* g_newAct
QAction* g_openAct
QAction* g_orbitAct
QAction* g_overlayAct
QAction* g_pasteAct
QAction* g_pauseAct
QAction* g_playAct
QAction* g_plotAct

Action to show/hide the plotting utitlty.

QAction* g_pointLghtCreateAct
QAction* g_quitAct
QAction* g_redoAct

Action to redo last undone user command.

QAction* g_redoHistoryAct

Action to open the redo history menu.

QAction* g_resetAct
QAction* g_resetModelsAct
QAction* g_resetWorldAct
QAction* g_rotateAct
QAction* g_saveAct
QAction* g_saveAsAct
QAction* g_saveCfgAct
QAction* g_scaleAct
QAction* g_screenshotAct
QAction* g_showCollisionsAct

Action to show/hide collision visuals for all models.

QAction* g_showCOMAct

Action to show/hide CoM visuals for all models.

QAction* g_showContactsAct

Action to show/hide contact visuals for all models.

QAction* g_showGridAct

Action to show/hide the grid over the ground plane.

QAction* g_showInertiaAct

Action to show/hide inertia visuals for all models.

QAction* g_showJointsAct

Action to show/hide joint visuals for all models.

QAction* g_showLinkFrameAct

Action to show/hide link frame visuals for all models.

QAction* g_showOriginAct

Action to show/hide the world origin indicator.

QAction* g_showSkeletonAct

Action to show/hide skeleton visuals for all models.

QAction* g_showToolbarsAct
QAction* g_snapAct
QAction* g_sphereCreateAct
QAction* g_spotLghtCreateAct
QAction* g_stepAct
QAction* g_topicVisAct
QAction* g_translateAct
QAction* g_transparentAct
QAction* g_undoAct

Action to undo last user command.

QAction* g_undoHistoryAct

Action to open the undo history menu.

QWidgetAction* g_viewAngleAct

Action to open the view angle widget.

QAction* g_viewAngleButtonAct

Action attached to the view angle button.

QAction* g_viewOculusAct
QAction* g_viewWireframeAct