Files | Namespaces | Classes | Enumerations | Functions | Variables | Signals
Gazebo_gui

Files

file  GuiTypes.hh
 default namespace for gazebo
 

Namespaces

 gazebo::gui
 gui namespace
 

Classes

class  gazebo::gui::ApplyWrenchDialog
 Dialog for applying force and torque to a model. More...
 
class  gazebo::gui::BaseInspectorDialog
 Base Dialog for a specific inspector dialog. More...
 
class  gazebo::gui::BuildingEditorPalette
 A palette of building items which can be added to the editor. More...
 
class  gazebo::gui::BuildingEditorWidget
 The parent widget of the building editor, level widget and scale widget. More...
 
class  gazebo::gui::BuildingMaker
 Create and manage 3D visuals of a building. More...
 
class  gazebo::gui::BuildingModelManip
 Manipulate a 3D visual associated to a 2D editor item. More...
 
class  gazebo::gui::CloneWindow
 A dialog window used to set some parameters before cloning a simulation. More...
 
class  gazebo::gui::CollisionConfig
 A tab for configuring collision properties of a link. More...
 
class  gazebo::gui::CollisionConfigData
 A class of widgets used for configuring collision properties. More...
 
class  gazebo::gui::ConfigChildWidget
 A convenience widget that also holds pointers to a list of its child widgets. More...
 
class  gazebo::gui::ConfigWidget
 A widget generated from a google protobuf message. More...
 
class  gazebo::gui::Conversions
 Conversions Conversions.hh gui/Conversions.hh. More...
 
class  gazebo::gui::DataLogger
 A widget that provides data logging functionality. More...
 
class  gazebo::gui::DoorItem
 2D representation of a door More...
 
class  gazebo::gui::EditorItem
 Base class of an item in the editor. More...
 
class  gazebo::gui::EditorView
 Control the editor view and manage contents in the editor scene. More...
 
class  gazebo::gui::EntityMaker
 To make an entity, base class. More...
 
class  gazebo::gui::EnumConfigWidget
 A widget for configuring enum values. More...
 
class  gazebo::gui::ExtrudeDialog
 Dialog for saving to file. More...
 
class  gazebo::gui::FloorItem
 2D representation of a floor. More...
 
class  gazebo::gui::GeometryConfigWidget
 A widget for configuring geometry properties. More...
 
class  gazebo::gui::GridLines
 2D grid lines. More...
 
class  gazebo::gui::GroupWidget
 A collapsible widget that holds child widgets. More...
 
class  gazebo::gui::HotkeyDialog
 Dialog displaying the keyboard shortcuts. More...
 
class  gazebo::gui::ImportDialog
 Dialog for saving to file. More...
 
class  gazebo::gui::ImportImageDialog
 
class  gazebo::gui::ImportImageView
 Control the import image view and manage contents in the scene. More...
 
class  gazebo::gui::JointMaker
 Handles the creation of joints in the model editor. More...
 
class  gazebo::gui::LevelInspectorDialog
 Dialog for configuring a building level. More...
 
class  gazebo::gui::LevelWidget
 A widget for adding and changing building levels. More...
 
class  gazebo::gui::LinkConfig
 A tab for configuring properties of a link. More...
 
class  gazebo::gui::MeasureItem
 Measurement lines and values. More...
 
class  gazebo::gui::ModelCreator
 Create and manage 3D visuals of a model with links and joints. More...
 
class  gazebo::gui::ModelEditorPalette
 A palette of model items which can be added to the editor. More...
 
class  gazebo::gui::ModelPluginInspector
 Inspector for model plugin properties. More...
 
class  gazebo::gui::ModelTreeWidget
 A widget that displays model properties. More...
 
class  gazebo::gui::OculusWindow
 A widget that renders a camera view suitable for the Oculus Rift. More...
 
class  gazebo::gui::RectItem
 2D rectangle. More...
 
class  gazebo::gui::RotateHandle
 Handle for rotating an editor item. More...
 
class  gazebo::gui::SaveDialog
 Dialog for saving to file. More...
 
class  gazebo::gui::ScaleWidget
 Widget that displays the scale (zoom level) of the editor. More...
 
class  gazebo::gui::SegmentItem
 2D line segment. More...
 
class  gazebo::gui::StairsInspectorDialog
 Dialog for configuring a staircase item. More...
 
class  gazebo::gui::StairsItem
 2D representation of a staircase. More...
 
class  gazebo::gui::TerrainEditorPalette
 A palette of building items which can be added to the editor. More...
 
class  gazebo::gui::ToolsWidget
 A widget that manages all the tools on the right side of the render widget. More...
 
class  gazebo::gui::TopicSelector
 A widget that provides a list of topics to select from. More...
 
class  gazebo::gui::VisualConfig
 A tab for configuring visual properties of a link. More...
 
class  gazebo::gui::VisualConfigData
 A class of widgets used for configuring visual properties. More...
 
class  gazebo::gui::WallInspectorDialog
 Dialog for configuring a wall item. More...
 
class  gazebo::gui::WallSegmentItem
 2D representation of a wall. More...
 
class  gazebo::gui::WindowDoorInspectorDialog
 Dialog for configuring a window or door item. More...
 
class  gazebo::gui::WindowItem
 2D representation of a window. More...
 

Enumerations

enum  gazebo::gui::EditorView::DrawModes {
  gazebo::gui::EditorView::NONE, gazebo::gui::EditorView::WALL, gazebo::gui::EditorView::WINDOW, gazebo::gui::EditorView::DOOR,
  gazebo::gui::EditorView::STAIRS, gazebo::gui::EditorView::COLOR, gazebo::gui::EditorView::TEXTURE
}
 Unique identifiers for all drawing modes within the editor. More...
 
enum  gazebo::gui::ModelCreator::EntityType {
  gazebo::gui::ModelCreator::ENTITY_NONE, gazebo::gui::ModelCreator::ENTITY_BOX, gazebo::gui::ModelCreator::ENTITY_SPHERE, gazebo::gui::ModelCreator::ENTITY_CYLINDER,
  gazebo::gui::ModelCreator::ENTITY_MESH, gazebo::gui::ModelCreator::ENTITY_POLYLINE, gazebo::gui::ModelCreator::ENTITY_MODEL
}
 
enum  gazebo::gui::JointMaker::JointType {
  gazebo::gui::JointMaker::JOINT_NONE, gazebo::gui::JointMaker::JOINT_FIXED, gazebo::gui::JointMaker::JOINT_SLIDER, gazebo::gui::JointMaker::JOINT_HINGE,
  gazebo::gui::JointMaker::JOINT_HINGE2, gazebo::gui::JointMaker::JOINT_SCREW, gazebo::gui::JointMaker::JOINT_UNIVERSAL, gazebo::gui::JointMaker::JOINT_BALL,
  gazebo::gui::JointMaker::JOINT_GEARBOX
}
 
enum  gazebo::gui::ApplyWrenchDialog::Mode { gazebo::gui::ApplyWrenchDialog::NONE = 0, gazebo::gui::ApplyWrenchDialog::FORCE = 1, gazebo::gui::ApplyWrenchDialog::TORQUE = 2 }
 
enum  gazebo::gui::WindowDoorInspectorDialog::mode { gazebo::gui::WindowDoorInspectorDialog::WINDOW, gazebo::gui::WindowDoorInspectorDialog::DOOR }
 Dialog modes. More...
 
enum  gazebo::gui::RectItem::ResizeFlags { gazebo::gui::RectItem::NONE = 0x00, gazebo::gui::RectItem::ITEM_WIDTH = 0x01, gazebo::gui::RectItem::ITEM_HEIGHT = 0x02 }
 Resize flags used to indicate which dimension can be resized. More...
 
enum  gazebo::gui::SaveDialog::SaveMode { gazebo::gui::SaveDialog::MODEL, gazebo::gui::SaveDialog::BUILDING }
 Unique identifiers for all dialog modes. More...
 
enum  gazebo::gui::ModelCreator::SaveState { gazebo::gui::ModelCreator::NEVER_SAVED, gazebo::gui::ModelCreator::ALL_SAVED, gazebo::gui::ModelCreator::UNSAVED_CHANGES }
 Save states for the model editor. More...
 

Functions

 gazebo::gui::CloneWindow::CloneWindow (QWidget *_parent=0)
 Constructor. More...
 
 gazebo::gui::ConfigChildWidget::ConfigChildWidget ()
 Constructor;. More...
 
 gazebo::gui::ConfigWidget::ConfigWidget ()
 Constructor. More...
 
 gazebo::gui::EntityMaker::EntityMaker (EntityMakerPrivate &_dataPtr)
 Constructor used by inherited classes. More...
 
 gazebo::gui::ModelEditorPalette::ModelEditorPalette (QWidget *_parent=0)
 Constructor. More...
 
 gazebo::gui::ModelTreeWidget::ModelTreeWidget (QWidget *_parent=0)
 Constructor. More...
 
 gazebo::gui::OculusWindow::OculusWindow (int _x, int _y, const std::string &_visual, QWidget *_parent=0)
 Constructor. More...
 
 gazebo::gui::TerrainEditorPalette::TerrainEditorPalette (QWidget *_parent=0)
 Constructor. More...
 
virtual gazebo::gui::CloneWindow::~CloneWindow ()
 Destructor. More...
 
 gazebo::gui::ConfigWidget::~ConfigWidget ()
 Destructor. More...
 
virtual gazebo::gui::EntityMaker::~EntityMaker ()
 Destructor. More...
 
 gazebo::gui::ModelEditorPalette::~ModelEditorPalette ()
 Destructor. More...
 
 gazebo::gui::ModelTreeWidget::~ModelTreeWidget ()=default
 Destructor. More...
 
virtual gazebo::gui::OculusWindow::~OculusWindow ()
 Destructor. More...
 
 gazebo::gui::TerrainEditorPalette::~TerrainEditorPalette ()
 Destructor. More...
 
bool gazebo::gui::ConfigWidget::AddConfigChildWidget (const std::string &_name, ConfigChildWidget *_child)
 Register a child widget as a child of this widget, so it can be updated. More...
 
void gazebo::gui::ModelEditorPalette::AddItem (QWidget *_item, const std::string &_category="Other")
 Add an item to the model editor palette. More...
 
bool gazebo::gui::ConfigWidget::AddItemEnumWidget (const std::string &_name, const std::string &_itemText)
 Add an item to a child enum widget. More...
 
bool gazebo::gui::ConfigWidget::BoolWidgetValue (const std::string &_name) const
 Get a bool value from a child widget. More...
 
bool gazebo::gui::ConfigWidget::ClearEnumWidget (const std::string &_name)
 Remove all items from a child enum widget. More...
 
common::Color gazebo::gui::ConfigWidget::ColorWidgetValue (const std::string &_name) const
 Get a color value from a child widget. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::ConfigChildWidgetByName (const std::string &_name) const
 Get a config child widget by its name. More...
 
unsigned int gazebo::gui::ConfigWidget::ConfigChildWidgetCount () const
 Get the number of child widgets. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateBoolWidget (const std::string &_key, const int _level=0)
 Create a widget for configuring a bool value. More...
 
bool gazebo::gui::OculusWindow::CreateCamera ()
 Initialize Oculus and create a camera. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateColorWidget (const std::string &_key, const int _level=0)
 Create a widget for configuring a color value. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateDoubleWidget (const std::string &_key, const int _level=0)
 Create a widget for configuring a double value. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateEnumWidget (const std::string &_key, const std::vector< std::string > &_values, const int _level=0)
 Create a widget for configuring an enum value. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateGeometryWidget (const std::string &_key, const int _level=0)
 Create a widget for configuring a geometry value. More...
 
GroupWidget * gazebo::gui::ConfigWidget::CreateGroupWidget (const std::string &_name, ConfigChildWidget *_childWidget, const int _level=0)
 Create a widget which has a button header which collapses the field widget. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateIntWidget (const std::string &_key, const int _level=0)
 Create a widget for configuring an integer value. More...
 
void gazebo::gui::ModelEditorPalette::CreateJoint (const std::string &_type)
 Add a joint to the model. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreatePoseWidget (const std::string &_key, const int _level=0)
 Create a widget for configuring a pose value. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateStringWidget (const std::string &_key, const int _level=0, const std::string &_type="line")
 Create a widget for configuring a string value. More...
 
virtual void gazebo::gui::EntityMaker::CreateTheEntity ()=0
 Creates the entity. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateUIntWidget (const std::string &_key, const int _level=0)
 Create a widget for configuring an unsigned integer value. More...
 
ConfigChildWidget * gazebo::gui::ConfigWidget::CreateVector3dWidget (const std::string &_key, const int _level=0)
 Create a widget for configuring a vector3 value. More...
 
double gazebo::gui::ConfigWidget::DoubleWidgetValue (const std::string &_name) const
 Get a double value from a child widget. More...
 
virtual ignition::math::Vector3d gazebo::gui::EntityMaker::EntityPosition () const
 Returns the entity world position. More...
 
std::string gazebo::gui::ConfigWidget::EnumWidgetValue (const std::string &_name) const
 Get an enum value from a child widget. More...
 
std::string gazebo::gui::ConfigWidget::GeometryWidgetValue (const std::string &_name, ignition::math::Vector3d &_dimensions, std::string &_uri) const
 Get a geometry value from a child widget. More...
 
bool gazebo::gui::ConfigWidget::GetBoolWidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get a bool value from a child widget. More...
 
common::Color gazebo::gui::ConfigWidget::GetColorWidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get a color value from a child widget. More...
 
double gazebo::gui::ConfigWidget::GetDoubleWidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get a double value from a child widget. More...
 
std::string gazebo::gui::ConfigWidget::GetEnumWidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get an enum value from a child widget. More...
 
std::string gazebo::gui::ConfigWidget::GetGeometryWidgetValue (const std::string &_name, math::Vector3 &_dimensions, std::string &_uri) const GAZEBO_DEPRECATED(7.0)
 Get a geometry value from a child widget. More...
 
std::string gazebo::gui::ConfigWidget::GetHumanReadableKey (const std::string &_key) GAZEBO_DEPRECATED(7.0)
 Create a human readable key, capitalizing the first letter and removing characters like "_". More...
 
int gazebo::gui::ConfigWidget::GetIntWidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get an integer value from a child widget. More...
 
ModelCreator * gazebo::gui::ModelEditorPalette::GetModelCreator ()
 Get the model creator. More...
 
google::protobuf::Message * gazebo::gui::ConfigWidget::GetMsg () GAZEBO_DEPRECATED(7.0)
 Get the updated message. More...
 
int gazebo::gui::CloneWindow::GetPort () GAZEBO_DEPRECATED(7.0)
 Get the port for the new gzserver specified by the user. More...
 
math::Pose gazebo::gui::ConfigWidget::GetPoseWidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get a pose value from a child widget. More...
 
void gazebo::gui::ConfigWidget::GetRangeFromKey (const std::string &_key, double &_min, double &_max) GAZEBO_DEPRECATED(7.0)
 Returns the range for a given key. More...
 
std::string gazebo::gui::ConfigWidget::GetStringWidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get a string value from a child widget. More...
 
unsigned int gazebo::gui::ConfigWidget::GetUIntWidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get an unsigned integer value from a child widget. More...
 
std::string gazebo::gui::ConfigWidget::GetUnitFromKey (const std::string &_key, const std::string &_jointType="") GAZEBO_DEPRECATED(7.0)
 Returns the unit for a given key. More...
 
math::Vector3 gazebo::gui::ConfigWidget::GetVector3WidgetValue (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get a vector3 value from a child widget. More...
 
bool gazebo::gui::ConfigWidget::GetWidgetReadOnly (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get whether a child widget is read-only. More...
 
bool gazebo::gui::ConfigWidget::GetWidgetVisible (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
 Get whether a child widget is visible. More...
 
std::string gazebo::gui::ConfigWidget::HumanReadableKey (const std::string &_key) const
 Create a human readable key, capitalizing the first letter and removing characters like "_". More...
 
void gazebo::gui::ConfigWidget::InsertLayout (QLayout *_layout, int _pos)
 Insert a layout into the config widget's layout at a specific position. More...
 
void gazebo::gui::ModelEditorPalette::InsertWidget (unsigned int _index, QWidget *_widget)
 Add a widget inside the model editor palette widget. More...
 
int gazebo::gui::ConfigWidget::IntWidgetValue (const std::string &_name) const
 Get an integer value from a child widget. More...
 
bool gazebo::gui::CloneWindow::IsValidPort () const
 True if the stored port is a valid one. More...
 
void gazebo::gui::OculusWindow::keyPressEvent (QKeyEvent *_event)
 
void gazebo::gui::ConfigWidget::Load (const google::protobuf::Message *_msg)
 Load from a google protobuf message. More...
 
google::protobuf::Message * gazebo::gui::ConfigWidget::Msg ()
 Get the updated message. More...
 
virtual void gazebo::gui::EntityMaker::OnMouseMove (const common::MouseEvent &_event)
 Callback when moving mouse. More...
 
virtual void gazebo::gui::EntityMaker::OnMouseRelease (const common::MouseEvent &_event)
 Callback when mouse button is released. More...
 
int gazebo::gui::CloneWindow::Port () const
 Get the port for the new gzserver specified by the user. More...
 
ignition::math::Pose3d gazebo::gui::ConfigWidget::PoseWidgetValue (const std::string &_name) const
 Get a pose value from a child widget. More...
 
void gazebo::gui::ConfigWidget::RangeFromKey (const std::string &_key, double &_min, double &_max) const
 Returns the range for a given key. More...
 
bool gazebo::gui::ConfigWidget::RemoveItemEnumWidget (const std::string &_name, const std::string &_itemText)
 Remove an item from a child enum widget. More...
 
void gazebo::gui::ModelEditorPalette::RemoveWidget (QWidget *_widget)
 Remove a widget from the model editor palette widget. More...
 
virtual void gazebo::gui::OculusWindow::resizeEvent (QResizeEvent *_e)
 
bool gazebo::gui::ConfigWidget::SetBoolWidgetValue (const std::string &_name, bool _value)
 Set a bool value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetColorWidgetValue (const std::string &_name, const common::Color &_value)
 Set a color value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetDoubleWidgetValue (const std::string &_name, double _value)
 Set a double value to a child widget. More...
 
virtual void gazebo::gui::EntityMaker::SetEntityPosition (const ignition::math::Vector3d &_pos)
 Sets the entity world position. More...
 
bool gazebo::gui::ConfigWidget::SetEnumWidgetValue (const std::string &_name, const std::string &_value)
 Set an enum value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetGeometryWidgetValue (const std::string &_name, const std::string &_value, const math::Vector3 &_dimensions, const std::string &_uri="") GAZEBO_DEPRECATED(7.0)
 Set a geometry value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetGeometryWidgetValue (const std::string &_name, const std::string &_value, const ignition::math::Vector3d &_dimensions, const std::string &_uri="")
 Set a geometry value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetIntWidgetValue (const std::string &_name, int _value)
 Set an integer value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetPoseWidgetValue (const std::string &_name, const math::Pose &_value) GAZEBO_DEPRECATED(7.0)
 Set a pose value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetPoseWidgetValue (const std::string &_name, const ignition::math::Pose3d &_value)
 Set a pose value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetStringWidgetValue (const std::string &_name, const std::string &_value)
 Set a string value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetUIntWidgetValue (const std::string &_name, unsigned int _value)
 Set an unsigned integer value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetVector3dWidgetValue (const std::string &_name, const ignition::math::Vector3d &_value)
 Set a vector3 value to a child widget. More...
 
bool gazebo::gui::ConfigWidget::SetVector3WidgetValue (const std::string &_name, const math::Vector3 &_value) GAZEBO_DEPRECATED(7.0)
 Set a vector3 value to a child widget. More...
 
void gazebo::gui::ConfigWidget::SetWidgetReadOnly (const std::string &_name, bool _readOnly)
 Set whether a child widget should be read-only. More...
 
void gazebo::gui::ConfigWidget::SetWidgetVisible (const std::string &_name, bool _visible)
 Set whether a child widget should be visible. More...
 
virtual void gazebo::gui::OculusWindow::showEvent (QShowEvent *_e)
 
virtual void gazebo::gui::EntityMaker::Start ()
 Start the maker. More...
 
virtual void gazebo::gui::EntityMaker::Stop ()
 Stop the maker. More...
 
std::string gazebo::gui::ConfigWidget::StringWidgetValue (const std::string &_name) const
 Get a string value from a child widget. More...
 
static QString gazebo::gui::ConfigWidget::StyleSheet (const std::string &_type, const int _level=0)
 Get a style sheet in string format, to be applied to a child config widget with setStyleSheet. More...
 
unsigned int gazebo::gui::ConfigWidget::UIntWidgetValue (const std::string &_name) const
 Get an unsigned integer value from a child widget. More...
 
std::string gazebo::gui::ConfigWidget::UnitFromKey (const std::string &_key, const std::string &_jointType="") const
 Returns the unit for a given key. More...
 
void gazebo::gui::ConfigWidget::UpdateFromMsg (const google::protobuf::Message *_msg)
 Update the widgets from a message. More...
 
ignition::math::Vector3d gazebo::gui::ConfigWidget::Vector3dWidgetValue (const std::string &_name) const
 Get a vector3 value from a child widget. More...
 
bool gazebo::gui::ConfigWidget::WidgetReadOnly (const std::string &_name) const
 Get whether a child widget is read-only. More...
 
bool gazebo::gui::ConfigWidget::WidgetVisible (const std::string &_name) const
 Get whether a child widget is visible. More...
 

Variables

static const std::vector< QString > gazebo::gui::ConfigWidget::bgColors
 List of colors used for the background of widgets according to their level. More...
 
static const QString gazebo::gui::ConfigWidget::blueColor
 Blue color used for "blue" or "z" fields. More...
 
QWidget * gazebo::gui::GroupWidget::childWidget
 Child widget that can be collapsed or expanded. More...
 
EntityMakerPrivate * gazebo::gui::EntityMaker::dataPtr
 
QStackedWidget * gazebo::gui::GeometryConfigWidget::geomDimensionWidget
 A stacked widget containing widgets for configuring geometry dimensions. More...
 
QWidget * gazebo::gui::GeometryConfigWidget::geomFilenameButton
 A button for selecting the mesh filename. More...
 
QWidget * gazebo::gui::GeometryConfigWidget::geomFilenameLabel
 A label for the mesh filename widget. More...
 
QWidget * gazebo::gui::GeometryConfigWidget::geomFilenameLineEdit
 A line edit for editing the mesh filename. More...
 
QWidget * gazebo::gui::GeometryConfigWidget::geomLengthLabel
 A label for the length widget. More...
 
QWidget * gazebo::gui::GeometryConfigWidget::geomLengthSpinBox
 A spin box for configuring the length of the geometry. More...
 
QWidget * gazebo::gui::GeometryConfigWidget::geomLengthUnitLabel
 A label for the unit of the length widget. More...
 
static const QString gazebo::gui::ConfigWidget::greenColor
 Green color used for "green" or "y" fields. More...
 
GroupWidget * gazebo::gui::ConfigChildWidget::groupWidget
 Pointer to group widget. More...
 
std::string gazebo::gui::ConfigChildWidget::key
 Widget's key value. More...
 
std::map< QWidget *, QLabel * > gazebo::gui::ConfigChildWidget::mapWidgetToUnit
 Map a widget to the label holding its unit value. More...
 
static const QString gazebo::gui::ConfigWidget::redColor
 Red color used for "red" or "x" fields. More...
 
std::string gazebo::gui::ConfigChildWidget::scopedName
 Widget's scoped name within parent config widget. More...
 
static const std::vector< QString > gazebo::gui::ConfigWidget::widgetColors
 List of colors used for widget areas according to their level. More...
 
std::vector< QWidget * > gazebo::gui::ConfigChildWidget::widgets
 List of widgets holding values, such as Spins and LineEdits. More...
 

Signals

void gazebo::gui::ConfigWidget::BoolValueChanged (const QString &_name, const bool _value)
 Signal that a bool config widget's value has changed. More...
 
void gazebo::gui::ConfigWidget::ColorValueChanged (const QString &_name, const gazebo::common::Color &_value)
 Signal that a color config widget's value has changed. More...
 
void gazebo::gui::ConfigWidget::DoubleValueChanged (const QString &_name, const double _value)
 Signal that a double config widget's value has changed. More...
 
void gazebo::gui::EnumConfigWidget::EnumValueChanged (const QString &_value)
 brief Signal an enum value change event. More...
 
void gazebo::gui::ConfigWidget::EnumValueChanged (const QString &_name, const QString &_value)
 Signal that an enum config widget's enum value has changed. More...
 
void gazebo::gui::ConfigWidget::GeometryValueChanged (const std::string &_name, const std::string &_value, const ignition::math::Vector3d &_dimensions, const std::string &_uri)
 Signal that a geometry config widget's value has changed. More...
 
void gazebo::gui::ConfigWidget::IntValueChanged (const QString &_name, const int _value)
 Signal that an int config widget's value has changed. More...
 
void gazebo::gui::ConfigWidget::PoseValueChanged (const QString &_name, const ignition::math::Pose3d &_pose)
 Signal that a pose config widget's value has changed. More...
 
void gazebo::gui::ConfigWidget::StringValueChanged (const QString &_name, const std::string &_value)
 Signal that a string config widget's value has changed. More...
 
void gazebo::gui::ConfigWidget::UIntValueChanged (const QString &_name, const unsigned int _value)
 Signal that a uint config widget's value has changed. More...
 
void gazebo::gui::ConfigWidget::Vector3dValueChanged (const QString &_name, const ignition::math::Vector3d &_value)
 Signal that a vector3 config widget's value has changed. More...
 

Detailed Description

Enumeration Type Documentation

Unique identifiers for all drawing modes within the editor.

Enumerator
NONE 

None mode.

WALL 

Wall mode.

WINDOW 

Window mode.

DOOR 

Door mode.

STAIRS 

Stairs mode.

COLOR 

Color mode.

TEXTURE 

Texture mode.

Enumerator
ENTITY_NONE 

none

ENTITY_BOX 

Box.

ENTITY_SPHERE 

Sphere.

ENTITY_CYLINDER 

Cylinder.

ENTITY_MESH 

Imported 3D mesh.

ENTITY_POLYLINE 

Extruded polyline.

ENTITY_MODEL 

Nested model.

Enumerator
JOINT_NONE 

none

JOINT_FIXED 

Fixed joint.

JOINT_SLIDER 

Slider joint.

JOINT_HINGE 

Hinge joint.

JOINT_HINGE2 

Hinge2 joint.

JOINT_SCREW 

Screw joint.

JOINT_UNIVERSAL 

Universal joint.

JOINT_BALL 

Ball joint.

JOINT_GEARBOX 

Gearbox joint.

Enumerator
NONE 

None.

FORCE 

Force.

TORQUE 

Torque.

Dialog modes.

Enumerator
WINDOW 

Window mode.

DOOR 

Door mode.

Resize flags used to indicate which dimension can be resized.

Enumerator
NONE 

No dimensions.

ITEM_WIDTH 

Width.

ITEM_HEIGHT 

Height.

Unique identifiers for all dialog modes.

Enumerator
MODEL 

Save model.

BUILDING 

Save building.

Save states for the model editor.

Enumerator
NEVER_SAVED 
ALL_SAVED 
UNSAVED_CHANGES 

Function Documentation

gazebo::gui::CloneWindow::CloneWindow ( QWidget *  _parent = 0)

Constructor.

Parameters
[in]_parentParent widget pointer.
gazebo::gui::ConfigChildWidget::ConfigChildWidget ( )
inline

Constructor;.

gazebo::gui::ConfigWidget::ConfigWidget ( )

Constructor.

gazebo::gui::EntityMaker::EntityMaker ( EntityMakerPrivate _dataPtr)
protected

Constructor used by inherited classes.

Parameters
[in]_dataPtrPointer to private data.
gazebo::gui::ModelEditorPalette::ModelEditorPalette ( QWidget *  _parent = 0)

Constructor.

Parameters
[in]_parentParent QWidget.
gazebo::gui::ModelTreeWidget::ModelTreeWidget ( QWidget *  _parent = 0)

Constructor.

Parameters
[in]_parentParent QWidget.
gazebo::gui::OculusWindow::OculusWindow ( int  _x,
int  _y,
const std::string &  _visual,
QWidget *  _parent = 0 
)

Constructor.

gazebo::gui::TerrainEditorPalette::TerrainEditorPalette ( QWidget *  _parent = 0)

Constructor.

Parameters
[in]_parentParent QWidget.
virtual gazebo::gui::CloneWindow::~CloneWindow ( )
virtual

Destructor.

gazebo::gui::ConfigWidget::~ConfigWidget ( )

Destructor.

virtual gazebo::gui::EntityMaker::~EntityMaker ( )
virtual

Destructor.

gazebo::gui::ModelEditorPalette::~ModelEditorPalette ( )

Destructor.

gazebo::gui::ModelTreeWidget::~ModelTreeWidget ( )
default

Destructor.

virtual gazebo::gui::OculusWindow::~OculusWindow ( )
virtual

Destructor.

gazebo::gui::TerrainEditorPalette::~TerrainEditorPalette ( )

Destructor.

bool gazebo::gui::ConfigWidget::AddConfigChildWidget ( const std::string &  _name,
ConfigChildWidget _child 
)

Register a child widget as a child of this widget, so it can be updated.

Note that the widget is not automatically added to a layout.

Parameters
[in]_nameUnique name to indentify the child within this widget
[in]_childChild widget to be added. It doesn't need to be a ConfigChildWidget.
Returns
True if child successfully added.
void gazebo::gui::ModelEditorPalette::AddItem ( QWidget *  _item,
const std::string &  _category = "Other" 
)

Add an item to the model editor palette.

Parameters
[in]_Itemitem to add.
[in]_categoryCategory to add the item too.
bool gazebo::gui::ConfigWidget::AddItemEnumWidget ( const std::string &  _name,
const std::string &  _itemText 
)

Add an item to a child enum widget.

Parameters
[in]_nameName of the child widget.
[in]_itemTextEnum text value.
Returns
True if the item is added successfully.
bool gazebo::gui::ConfigWidget::BoolWidgetValue ( const std::string &  _name) const

Get a bool value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Bool value.
bool gazebo::gui::ConfigWidget::ClearEnumWidget ( const std::string &  _name)

Remove all items from a child enum widget.

Parameters
[in]_nameName of the child widget.
Returns
True if successful.
common::Color gazebo::gui::ConfigWidget::ColorWidgetValue ( const std::string &  _name) const

Get a color value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Color value.
ConfigChildWidget* gazebo::gui::ConfigWidget::ConfigChildWidgetByName ( const std::string &  _name) const

Get a config child widget by its name.

Parameters
[in]_nameScoped name of the child widget.
Returns
The child widget with the given name or NULL if it wasn't found.
unsigned int gazebo::gui::ConfigWidget::ConfigChildWidgetCount ( ) const

Get the number of child widgets.

Returns
The number of child widgets.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreateBoolWidget ( const std::string &  _key,
const int  _level = 0 
)

Create a widget for configuring a bool value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
bool gazebo::gui::OculusWindow::CreateCamera ( )

Initialize Oculus and create a camera.

Returns
True when Oculus is connected and the camera was created.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreateColorWidget ( const std::string &  _key,
const int  _level = 0 
)

Create a widget for configuring a color value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreateDoubleWidget ( const std::string &  _key,
const int  _level = 0 
)

Create a widget for configuring a double value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreateEnumWidget ( const std::string &  _key,
const std::vector< std::string > &  _values,
const int  _level = 0 
)

Create a widget for configuring an enum value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_valuesA list of enum values in string.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreateGeometryWidget ( const std::string &  _key,
const int  _level = 0 
)

Create a widget for configuring a geometry value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
GroupWidget* gazebo::gui::ConfigWidget::CreateGroupWidget ( const std::string &  _name,
ConfigChildWidget _childWidget,
const int  _level = 0 
)

Create a widget which has a button header which collapses the field widget.

Parameters
[in]_nameHeader name.
[out]_childWidgetWidget which will be collapsed.
[in]_levelLevel of the widget in the tree.
Returns
The group widget.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreateIntWidget ( const std::string &  _key,
const int  _level = 0 
)

Create a widget for configuring an integer value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
void gazebo::gui::ModelEditorPalette::CreateJoint ( const std::string &  _type)

Add a joint to the model.

Parameters
[in]_typeType of joint to add.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreatePoseWidget ( const std::string &  _key,
const int  _level = 0 
)

Create a widget for configuring a pose value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreateStringWidget ( const std::string &  _key,
const int  _level = 0,
const std::string &  _type = "line" 
)

Create a widget for configuring a string value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
[in]_typeType of string widget, such as "line" or "plain".
Returns
The newly created widget.
virtual void gazebo::gui::EntityMaker::CreateTheEntity ( )
protectedpure virtual

Creates the entity.

Implemented in gazebo::gui::LightMaker.

ConfigChildWidget* gazebo::gui::ConfigWidget::CreateUIntWidget ( const std::string &  _key,
const int  _level = 0 
)

Create a widget for configuring an unsigned integer value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
ConfigChildWidget* gazebo::gui::ConfigWidget::CreateVector3dWidget ( const std::string &  _key,
const int  _level = 0 
)

Create a widget for configuring a vector3 value.

Parameters
[in]_keyA key that is used as a label for the widget.
[in]_levelLevel of the widget in the tree.
Returns
The newly created widget.
double gazebo::gui::ConfigWidget::DoubleWidgetValue ( const std::string &  _name) const

Get a double value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Double value.
virtual ignition::math::Vector3d gazebo::gui::EntityMaker::EntityPosition ( ) const
virtual

Returns the entity world position.

Returns
Entity's position in the world frame.

Reimplemented in gazebo::gui::ModelMaker, and gazebo::gui::LightMaker.

std::string gazebo::gui::ConfigWidget::EnumWidgetValue ( const std::string &  _name) const

Get an enum value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Enum value.
std::string gazebo::gui::ConfigWidget::GeometryWidgetValue ( const std::string &  _name,
ignition::math::Vector3d &  _dimensions,
std::string &  _uri 
) const

Get a geometry value from a child widget.

Parameters
[in]_nameName of the child widget.
[out]_dimensionsDimensions of geometry.
[out]_uriURI of the geometry mesh, if any.
Returns
Type of geometry.
bool gazebo::gui::ConfigWidget::GetBoolWidgetValue ( const std::string &  _name) const

Get a bool value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Bool value.
Deprecated:
See BoolWidgetValue(const std::string &_name) const
common::Color gazebo::gui::ConfigWidget::GetColorWidgetValue ( const std::string &  _name) const

Get a color value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Color value.
Deprecated:
See ColorWidgetValue(const std::string &_name) const
double gazebo::gui::ConfigWidget::GetDoubleWidgetValue ( const std::string &  _name) const

Get a double value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Double value.
Deprecated:
See DoubleWidgetValue(const std::string &_name) const
std::string gazebo::gui::ConfigWidget::GetEnumWidgetValue ( const std::string &  _name) const

Get an enum value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Enum value.
Deprecated:
See EnumWidgetValue(const std::string &_name)
std::string gazebo::gui::ConfigWidget::GetGeometryWidgetValue ( const std::string &  _name,
math::Vector3 _dimensions,
std::string &  _uri 
) const

Get a geometry value from a child widget.

Parameters
[in]_nameName of the child widget.
[out]_dimensionsDimensions of geometry.
[out]_uriURI of the geometry mesh, if any.
Returns
Type of geometry.
Deprecated:
See GeometryWidgetValue() function that accepts an ignition math object.
std::string gazebo::gui::ConfigWidget::GetHumanReadableKey ( const std::string &  _key)

Create a human readable key, capitalizing the first letter and removing characters like "_".

Parameters
[in]_keyNon-human-readable key.
Returns
Human-readable key.
Deprecated:
See HumanReadableKey(const std::string &_key) const
int gazebo::gui::ConfigWidget::GetIntWidgetValue ( const std::string &  _name) const

Get an integer value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Integer value.
Deprecated:
See IntWidgetValue(const std::string &_name) const
ModelCreator* gazebo::gui::ModelEditorPalette::GetModelCreator ( )

Get the model creator.

Returns
a pointer to the model creator.
google::protobuf::Message* gazebo::gui::ConfigWidget::GetMsg ( )

Get the updated message.

Returns
Updated message.
Deprecated:
See Msg().
int gazebo::gui::CloneWindow::GetPort ( )

Get the port for the new gzserver specified by the user.

Returns
The port for the new gzserver.
Deprecated:
See Port() const
math::Pose gazebo::gui::ConfigWidget::GetPoseWidgetValue ( const std::string &  _name) const

Get a pose value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Pose value.
Deprecated:
See PoseWidgetValue(const std::string &_name) const
void gazebo::gui::ConfigWidget::GetRangeFromKey ( const std::string &  _key,
double &  _min,
double &  _max 
)

Returns the range for a given key.

For example, the key "transparency" returns min == 0, max == 1.

Parameters
[in]_keyThe key.
[out]_minThe minimum value.
[out]_maxThe maximum value.
Deprecated:
See RangeFromKey(const std::string &_key, double &_min, double &_max) const
std::string gazebo::gui::ConfigWidget::GetStringWidgetValue ( const std::string &  _name) const

Get a string value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
String value.
Deprecated:
See StringWidgetValue(const std::string &_name) const
unsigned int gazebo::gui::ConfigWidget::GetUIntWidgetValue ( const std::string &  _name) const

Get an unsigned integer value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Unsigned integer value.
Deprecated:
See UIntWidgetValue(const std::string &_name) const
std::string gazebo::gui::ConfigWidget::GetUnitFromKey ( const std::string &  _key,
const std::string &  _jointType = "" 
)

Returns the unit for a given key.

For example, the key "mass" returns "kg".

Parameters
[in]_keyThe key.
[in]_jointTypeIn case the field belongs to a joint, the joint's type.
Returns
The unit.
Deprecated:
See UnitFromKey(const std::string &_key, const std::string &_jointType = "") const
math::Vector3 gazebo::gui::ConfigWidget::GetVector3WidgetValue ( const std::string &  _name) const

Get a vector3 value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Vector3 value.
Deprecated:
See Vector3dWidgetValue(const std::string &_name) const
bool gazebo::gui::ConfigWidget::GetWidgetReadOnly ( const std::string &  _name) const

Get whether a child widget is read-only.

Parameters
[in]_nameName of the child widget.
Returns
True if the widget is read-only.
Deprecated:
See WidgetReadOnly(const std::string &_name) const
bool gazebo::gui::ConfigWidget::GetWidgetVisible ( const std::string &  _name) const

Get whether a child widget is visible.

Parameters
[in]_nameName of the child widget.
Returns
True if the widget is visible.
Deprecated:
See WidgetVisible(const std::string &_name) const
std::string gazebo::gui::ConfigWidget::HumanReadableKey ( const std::string &  _key) const

Create a human readable key, capitalizing the first letter and removing characters like "_".

Parameters
[in]_keyNon-human-readable key.
Returns
Human-readable key.
void gazebo::gui::ConfigWidget::InsertLayout ( QLayout *  _layout,
int  _pos 
)

Insert a layout into the config widget's layout at a specific position.

Parameters
[in]_layoutThe layout to be inserted.
[in]_posThe position to insert at, 0 being the top.
void gazebo::gui::ModelEditorPalette::InsertWidget ( unsigned int  _index,
QWidget *  _widget 
)

Add a widget inside the model editor palette widget.

Parameters
[in]_indexIndex in the splitter to insert the widget at.
[in]_widgetWidget to be added.
int gazebo::gui::ConfigWidget::IntWidgetValue ( const std::string &  _name) const

Get an integer value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Integer value.
bool gazebo::gui::CloneWindow::IsValidPort ( ) const

True if the stored port is a valid one.

A valid port is an integer number in the 1025-65535 range.

Returns
True when the port is valid or false otherwise.
void gazebo::gui::OculusWindow::keyPressEvent ( QKeyEvent *  _event)
protected
void gazebo::gui::ConfigWidget::Load ( const google::protobuf::Message *  _msg)

Load from a google protobuf message.

Parameters
[in]_msgMessage to load from.
google::protobuf::Message* gazebo::gui::ConfigWidget::Msg ( )

Get the updated message.

Returns
Updated message.
virtual void gazebo::gui::EntityMaker::OnMouseMove ( const common::MouseEvent _event)
virtual

Callback when moving mouse.

Parameters
[in]_eventMouseEvent object
virtual void gazebo::gui::EntityMaker::OnMouseRelease ( const common::MouseEvent _event)
virtual

Callback when mouse button is released.

Parameters
[in]_eventMouseEvent object
int gazebo::gui::CloneWindow::Port ( ) const

Get the port for the new gzserver specified by the user.

Returns
The port for the new gzserver.
ignition::math::Pose3d gazebo::gui::ConfigWidget::PoseWidgetValue ( const std::string &  _name) const

Get a pose value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Pose value.
void gazebo::gui::ConfigWidget::RangeFromKey ( const std::string &  _key,
double &  _min,
double &  _max 
) const

Returns the range for a given key.

For example, the key "transparency" returns min == 0, max == 1.

Parameters
[in]_keyThe key.
[out]_minThe minimum value.
[out]_maxThe maximum value.
bool gazebo::gui::ConfigWidget::RemoveItemEnumWidget ( const std::string &  _name,
const std::string &  _itemText 
)

Remove an item from a child enum widget.

Parameters
[in]_nameName of the child widget.
[in]_itemTextText of the enum value.
Returns
True if the item is removed successfully.
void gazebo::gui::ModelEditorPalette::RemoveWidget ( QWidget *  _widget)

Remove a widget from the model editor palette widget.

Parameters
[in]_widgetWidget to be added.
virtual void gazebo::gui::OculusWindow::resizeEvent ( QResizeEvent *  _e)
protectedvirtual
bool gazebo::gui::ConfigWidget::SetBoolWidgetValue ( const std::string &  _name,
bool  _value 
)

Set a bool value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
bool gazebo::gui::ConfigWidget::SetColorWidgetValue ( const std::string &  _name,
const common::Color _value 
)

Set a color value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
bool gazebo::gui::ConfigWidget::SetDoubleWidgetValue ( const std::string &  _name,
double  _value 
)

Set a double value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
virtual void gazebo::gui::EntityMaker::SetEntityPosition ( const ignition::math::Vector3d &  _pos)
protectedvirtual

Sets the entity world position.

Parameters
[in]_posNew position in the world frame.

Reimplemented in gazebo::gui::ModelMaker, and gazebo::gui::LightMaker.

bool gazebo::gui::ConfigWidget::SetEnumWidgetValue ( const std::string &  _name,
const std::string &  _value 
)

Set an enum value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
bool gazebo::gui::ConfigWidget::SetGeometryWidgetValue ( const std::string &  _name,
const std::string &  _value,
const math::Vector3 _dimensions,
const std::string &  _uri = "" 
)

Set a geometry value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueType of geometry.
[in]_dimensionsDimensions of geometry.
Returns
True if the value is set successfully.
Deprecated:
See SetGeometryWidgetValue(const std::string &_name, const std::string &_value, const ignition::math::Vector3d &_dimensions, const std::string &_uri = "")
bool gazebo::gui::ConfigWidget::SetGeometryWidgetValue ( const std::string &  _name,
const std::string &  _value,
const ignition::math::Vector3d &  _dimensions,
const std::string &  _uri = "" 
)

Set a geometry value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueType of geometry.
[in]_dimensionsDimensions of geometry.
Returns
True if the value is set successfully.
bool gazebo::gui::ConfigWidget::SetIntWidgetValue ( const std::string &  _name,
int  _value 
)

Set an integer value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
bool gazebo::gui::ConfigWidget::SetPoseWidgetValue ( const std::string &  _name,
const math::Pose _value 
)

Set a pose value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
Deprecated:
See SetPoseWidgetValue(const std::string &_name, const ignition::math::Pose3d &_value)
bool gazebo::gui::ConfigWidget::SetPoseWidgetValue ( const std::string &  _name,
const ignition::math::Pose3d &  _value 
)

Set a pose value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
bool gazebo::gui::ConfigWidget::SetStringWidgetValue ( const std::string &  _name,
const std::string &  _value 
)

Set a string value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
bool gazebo::gui::ConfigWidget::SetUIntWidgetValue ( const std::string &  _name,
unsigned int  _value 
)

Set an unsigned integer value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
bool gazebo::gui::ConfigWidget::SetVector3dWidgetValue ( const std::string &  _name,
const ignition::math::Vector3d &  _value 
)

Set a vector3 value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
bool gazebo::gui::ConfigWidget::SetVector3WidgetValue ( const std::string &  _name,
const math::Vector3 _value 
)

Set a vector3 value to a child widget.

Parameters
[in]_nameName of the child widget.
[in]_valueValue to set to.
Returns
True if the value is set successfully.
Deprecated:
See SetVector3dWidgetValue(const std::string &_name, const ignition::math::Vector3 &_value)
void gazebo::gui::ConfigWidget::SetWidgetReadOnly ( const std::string &  _name,
bool  _readOnly 
)

Set whether a child widget should be read-only.

Parameters
[in]_nameName of the child widget.
[in]_visibleTrue to set the widget to be read-only.
void gazebo::gui::ConfigWidget::SetWidgetVisible ( const std::string &  _name,
bool  _visible 
)

Set whether a child widget should be visible.

Parameters
[in]_nameName of the child widget.
[in]_visibleTrue to set the widget to be visible.
virtual void gazebo::gui::OculusWindow::showEvent ( QShowEvent *  _e)
protectedvirtual
virtual void gazebo::gui::EntityMaker::Start ( )
virtual

Start the maker.

Reimplemented in gazebo::gui::LightMaker.

virtual void gazebo::gui::EntityMaker::Stop ( )
virtual

Stop the maker.

Reimplemented in gazebo::gui::ModelMaker, and gazebo::gui::LightMaker.

std::string gazebo::gui::ConfigWidget::StringWidgetValue ( const std::string &  _name) const

Get a string value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
String value.
static QString gazebo::gui::ConfigWidget::StyleSheet ( const std::string &  _type,
const int  _level = 0 
)
static

Get a style sheet in string format, to be applied to a child config widget with setStyleSheet.

Parameters
[in]_typeType of style sheet, such as "warning", "active", "normal".
[in]_levelLevel of widget in the tree.
Returns
Style sheet as string. Returns an empty string if _type is unknown.
unsigned int gazebo::gui::ConfigWidget::UIntWidgetValue ( const std::string &  _name) const

Get an unsigned integer value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Unsigned integer value.
std::string gazebo::gui::ConfigWidget::UnitFromKey ( const std::string &  _key,
const std::string &  _jointType = "" 
) const

Returns the unit for a given key.

For example, the key "mass" returns "kg".

Parameters
[in]_keyThe key.
[in]_jointTypeIn case the field belongs to a joint, the joint's type.
Returns
The unit.
void gazebo::gui::ConfigWidget::UpdateFromMsg ( const google::protobuf::Message *  _msg)

Update the widgets from a message.

Parameters
[in]_msgMessage used for updating the widgets.
ignition::math::Vector3d gazebo::gui::ConfigWidget::Vector3dWidgetValue ( const std::string &  _name) const

Get a vector3 value from a child widget.

Parameters
[in]_nameName of the child widget.
Returns
Vector3 value.
bool gazebo::gui::ConfigWidget::WidgetReadOnly ( const std::string &  _name) const

Get whether a child widget is read-only.

Parameters
[in]_nameName of the child widget.
Returns
True if the widget is read-only.
bool gazebo::gui::ConfigWidget::WidgetVisible ( const std::string &  _name) const

Get whether a child widget is visible.

Parameters
[in]_nameName of the child widget.
Returns
True if the widget is visible.

Variable Documentation

const std::vector<QString> gazebo::gui::ConfigWidget::bgColors
static

List of colors used for the background of widgets according to their level.

const QString gazebo::gui::ConfigWidget::blueColor
static

Blue color used for "blue" or "z" fields.

QWidget* gazebo::gui::GroupWidget::childWidget

Child widget that can be collapsed or expanded.

EntityMakerPrivate* gazebo::gui::EntityMaker::dataPtr
protected
QStackedWidget* gazebo::gui::GeometryConfigWidget::geomDimensionWidget

A stacked widget containing widgets for configuring geometry dimensions.

QWidget* gazebo::gui::GeometryConfigWidget::geomFilenameButton

A button for selecting the mesh filename.

QWidget* gazebo::gui::GeometryConfigWidget::geomFilenameLabel

A label for the mesh filename widget.

QWidget* gazebo::gui::GeometryConfigWidget::geomFilenameLineEdit

A line edit for editing the mesh filename.

QWidget* gazebo::gui::GeometryConfigWidget::geomLengthLabel

A label for the length widget.

QWidget* gazebo::gui::GeometryConfigWidget::geomLengthSpinBox

A spin box for configuring the length of the geometry.

QWidget* gazebo::gui::GeometryConfigWidget::geomLengthUnitLabel

A label for the unit of the length widget.

const QString gazebo::gui::ConfigWidget::greenColor
static

Green color used for "green" or "y" fields.

GroupWidget* gazebo::gui::ConfigChildWidget::groupWidget

Pointer to group widget.

NULL if this widget is not contained inside a group widget.

std::string gazebo::gui::ConfigChildWidget::key

Widget's key value.

std::map<QWidget *, QLabel *> gazebo::gui::ConfigChildWidget::mapWidgetToUnit

Map a widget to the label holding its unit value.

const QString gazebo::gui::ConfigWidget::redColor
static

Red color used for "red" or "x" fields.

std::string gazebo::gui::ConfigChildWidget::scopedName

Widget's scoped name within parent config widget.

const std::vector<QString> gazebo::gui::ConfigWidget::widgetColors
static

List of colors used for widget areas according to their level.

std::vector<QWidget *> gazebo::gui::ConfigChildWidget::widgets

List of widgets holding values, such as Spins and LineEdits.

Signals

void gazebo::gui::ConfigWidget::BoolValueChanged ( const QString &  _name,
const bool  _value 
)
signal

Signal that a bool config widget's value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew bool.
void gazebo::gui::ConfigWidget::ColorValueChanged ( const QString &  _name,
const gazebo::common::Color _value 
)
signal

Signal that a color config widget's value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew color.
void gazebo::gui::ConfigWidget::DoubleValueChanged ( const QString &  _name,
const double  _value 
)
signal

Signal that a double config widget's value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew double.
void gazebo::gui::EnumConfigWidget::EnumValueChanged ( const QString &  _value)
signal

brief Signal an enum value change event.

Parameters
[in]_valueNew enum value in string.
void gazebo::gui::ConfigWidget::EnumValueChanged ( const QString &  _name,
const QString &  _value 
)
signal

Signal that an enum config widget's enum value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew enum value string.
void gazebo::gui::ConfigWidget::GeometryValueChanged ( const std::string &  _name,
const std::string &  _value,
const ignition::math::Vector3d &  _dimensions,
const std::string &  _uri 
)
signal

Signal that a geometry config widget's value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew geometry name, such as "box".
[in]_dimensionsNew dimensions.
[in]_uriNew uri, for meshes.
void gazebo::gui::ConfigWidget::IntValueChanged ( const QString &  _name,
const int  _value 
)
signal

Signal that an int config widget's value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew int.
void gazebo::gui::ConfigWidget::PoseValueChanged ( const QString &  _name,
const ignition::math::Pose3d &  _pose 
)
signal

Signal that a pose config widget's value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_poseNew pose.
void gazebo::gui::ConfigWidget::StringValueChanged ( const QString &  _name,
const std::string &  _value 
)
signal

Signal that a string config widget's value has changed.

Note that only single line widgets will emit signals, so plain text widgets don't emit signals.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew string.
void gazebo::gui::ConfigWidget::UIntValueChanged ( const QString &  _name,
const unsigned int  _value 
)
signal

Signal that a uint config widget's value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew uint.
void gazebo::gui::ConfigWidget::Vector3dValueChanged ( const QString &  _name,
const ignition::math::Vector3d &  _value 
)
signal

Signal that a vector3 config widget's value has changed.

Parameters
[in]_nameScoped name of widget.
[in]_valueNew vector3.