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::BoxMaker
	to make a box 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::BuildingItem
	Base class of a items that have building level properties such as the level number and level height. 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	CloneConfig
	A dialog window used to set some parameters before cloning a simulation. More...

class	gazebo::gui::CloneWindow

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::CylinderMaker
	to make a cylinder 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::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
	Joint visualization. More...

class	gazebo::gui::LevelInspectorDialog
	Dialog for configuring a building level. More...

class	gazebo::gui::LevelWidget

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::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::WindowItem
	2D representation of a window. More...

Typedefs
typedef boost::function< void(const math::Vector3 &pos, const math::Vector3 &scale)>	gazebo::gui::EntityMaker::CreateCallback

Functions
	gazebo::gui::BoxMaker::BoxMaker ()
	Constructor. More...

	gazebo::gui::CloneWindow::CloneWindow (QWidget *_parent=0)
	Constructor. More...

	gazebo::gui::ConfigChildWidget::ConfigChildWidget ()
	Constructor;. More...

	gazebo::gui::ConfigWidget::ConfigWidget ()
	Constructor. More...

	gazebo::gui::CylinderMaker::CylinderMaker ()
	Constructor. More...

	gazebo::gui::EntityMaker::EntityMaker ()
	Constructor. More...

	gazebo::gui::ModelEditorPalette::ModelEditorPalette (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::BoxMaker::~BoxMaker ()
	Deconstructor. More...

virtual	gazebo::gui::CloneWindow::~CloneWindow ()
	Destructor. More...

	gazebo::gui::ConfigWidget::~ConfigWidget ()
	Destructor. More...

virtual	gazebo::gui::CylinderMaker::~CylinderMaker ()
	Deconstructor. More...

virtual	gazebo::gui::EntityMaker::~EntityMaker ()
	Destructor. More...

	gazebo::gui::ModelEditorPalette::~ModelEditorPalette ()
	Destructor. More...

virtual	gazebo::gui::OculusWindow::~OculusWindow ()
	Destructor. More...

	gazebo::gui::TerrainEditorPalette::~TerrainEditorPalette ()
	Destructor. 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::OculusWindow::CreateCamera ()
	Initialize Oculus and create a camera. More...

void	gazebo::gui::ModelEditorPalette::CreateJoint (const std::string &_type)
	Add a joint to the model. More...

virtual void	gazebo::gui::EntityMaker::CreateTheEntity ()=0
	Creates the entity. More...

bool	gazebo::gui::ConfigWidget::GetBoolWidgetValue (const std::string &_name) const
	Get a bool value from a child widget. More...

common::Color	gazebo::gui::ConfigWidget::GetColorWidgetValue (const std::string &_name) const
	Get a color value from a child widget. More...

double	gazebo::gui::ConfigWidget::GetDoubleWidgetValue (const std::string &_name) const
	Get a double value from a child widget. More...

std::string	gazebo::gui::ConfigWidget::GetEnumWidgetValue (const std::string &_name) const
	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
	Get a geometry value from a child widget. More...

std::string	gazebo::gui::ConfigWidget::GetHumanReadableKey (const std::string &_key)
	Create a human readable key, capitalizing the first letter and removing characters like "_". More...

int	gazebo::gui::ConfigWidget::GetIntWidgetValue (const std::string &_name) const
	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 ()
	Get the updated message. More...

int	gazebo::gui::CloneWindow::GetPort ()
	Get the port for the new gzserver specified by the user. More...

math::Pose	gazebo::gui::ConfigWidget::GetPoseWidgetValue (const std::string &_name) const
	Get a pose value from a child widget. More...

void	gazebo::gui::ConfigWidget::GetRangeFromKey (const std::string &_key, double &_min, double &_max)
	Returns the range for a given key. For example, the key. More...

std::string	gazebo::gui::CylinderMaker::GetSDFString ()
	Get the SDF information for the cylinder. More...

std::string	gazebo::gui::BoxMaker::GetSDFString ()
	Get the SDF information for the box. More...

math::Vector3	gazebo::gui::EntityMaker::GetSnappedPoint (math::Vector3 _p)
	Get a point snapped to a grid. More...

std::string	gazebo::gui::ConfigWidget::GetStringWidgetValue (const std::string &_name) const
	Get a string value from a child widget. More...

unsigned int	gazebo::gui::ConfigWidget::GetUIntWidgetValue (const std::string &_name) const
	Get an unsigned integer value from a child widget. More...

std::string	gazebo::gui::ConfigWidget::GetUnitFromKey (const std::string &_key, const std::string &_jointType="")
	Returns the unit for a given key. More...

math::Vector3	gazebo::gui::ConfigWidget::GetVector3WidgetValue (const std::string &_name) const
	Get a vector3 value from a child widget. More...

bool	gazebo::gui::ConfigWidget::GetWidgetReadOnly (const std::string &_name) const
	Get whether a child widget is read-only. More...

bool	gazebo::gui::ConfigWidget::GetWidgetVisible (const std::string &_name) const
	Get whether a child widget is visible. More...

virtual bool	gazebo::gui::CylinderMaker::IsActive () const
	Documentation inherited. More...

virtual bool	gazebo::gui::BoxMaker::IsActive () const
	Documentation inherited. More...

virtual bool	gazebo::gui::EntityMaker::IsActive () const =0
	Checks if entity is active. More...

bool	gazebo::gui::CloneWindow::IsValidPort ()
	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...

virtual void	gazebo::gui::CylinderMaker::OnMouseDrag (const common::MouseEvent &_event)
	Documentation inherited. More...

virtual void	gazebo::gui::BoxMaker::OnMouseDrag (const common::MouseEvent &_event)
	Documentation inherited. More...

virtual void	gazebo::gui::EntityMaker::OnMouseDrag (const common::MouseEvent &_event)
	Callback for dragging with mouse. More...

virtual void	gazebo::gui::CylinderMaker::OnMouseMove (const common::MouseEvent &_event)
	Documentation inherited. More...

virtual void	gazebo::gui::BoxMaker::OnMouseMove (const common::MouseEvent &_event)
	Documentation inherited. More...

virtual void	gazebo::gui::EntityMaker::OnMouseMove (const common::MouseEvent &_event)
	Callback when moving mouse. More...

virtual void	gazebo::gui::CylinderMaker::OnMousePush (const common::MouseEvent &_event)
	Documentation inherited. More...

virtual void	gazebo::gui::BoxMaker::OnMousePush (const common::MouseEvent &_event)
	Documentation inherited. More...

virtual void	gazebo::gui::EntityMaker::OnMousePush (const common::MouseEvent &_event)
	Callback for pushing entity with mouse. More...

virtual void	gazebo::gui::CylinderMaker::OnMouseRelease (const common::MouseEvent &_event)
	Documentation inherited. More...

virtual void	gazebo::gui::BoxMaker::OnMouseRelease (const common::MouseEvent &_event)
	Documentation inherited. More...

virtual void	gazebo::gui::EntityMaker::OnMouseRelease (const common::MouseEvent &_event)
	Callback for releasing mouse button. 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...

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="")
	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)
	Set a pose value to a child widget. More...

static void	gazebo::gui::EntityMaker::SetSnapToGrid (bool _snap)
	Set whether to snap to grid. 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::SetVector3WidgetValue (const std::string &_name, const math::Vector3 &_value)
	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::CylinderMaker::Start (const rendering::UserCameraPtr _camera)
	Documentation inherited. More...

virtual void	gazebo::gui::BoxMaker::Start (const rendering::UserCameraPtr _camera)
	Documentation inherited. More...

virtual void	gazebo::gui::EntityMaker::Start (const rendering::UserCameraPtr _camera)=0

virtual void	gazebo::gui::CylinderMaker::Stop ()
	Documentation inherited. More...

virtual void	gazebo::gui::BoxMaker::Stop ()
	Documentation inherited. More...

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

void	gazebo::gui::ConfigWidget::UpdateFromMsg (const google::protobuf::Message *_msg)
	Update the widgets from a message. More...

Variables
rendering::UserCameraPtr	gazebo::gui::EntityMaker::camera

QWidget *	gazebo::gui::GroupWidget::childWidget
	Child widget that can be collapsed or expanded. More...

CreateCallback	gazebo::gui::EntityMaker::createCB

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

GroupWidget *	gazebo::gui::ConfigChildWidget::groupWidget
	Pointer to group widget. More...

std::string	gazebo::gui::ConfigChildWidget::key
	Widget's key value. More...

transport::PublisherPtr	gazebo::gui::EntityMaker::makerPub

std::map< QWidget , QLabel >	gazebo::gui::ConfigChildWidget::mapWidgetToUnit
	Map a widget to the label holding its unit value. More...

transport::NodePtr	gazebo::gui::EntityMaker::node

transport::PublisherPtr	gazebo::gui::EntityMaker::requestPub

transport::PublisherPtr	gazebo::gui::EntityMaker::visPub

std::vector< QWidget * >	gazebo::gui::ConfigChildWidget::widgets
	List of widgets holding values, such as Spins and LineEdits. More...

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

Detailed Description

Typedef Documentation

typedef boost::function<void(const math::Vector3 &pos, const math::Vector3 &scale)> gazebo::gui::EntityMaker::CreateCallback

Function Documentation

gazebo::gui::BoxMaker::BoxMaker ( )

Constructor.

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

Constructor.

Parameters

[in] _parent Parent widget pointer.

gazebo::gui::ConfigChildWidget::ConfigChildWidget ( )

inline

Constructor;.

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

Constructor.

gazebo::gui::CylinderMaker::CylinderMaker ( )

Constructor.

gazebo::gui::EntityMaker::EntityMaker ( )

Constructor.

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

Constructor.

Parameters

[in] _parent Parent 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] _parent Parent QWidget.

virtual gazebo::gui::BoxMaker::~BoxMaker ( )

virtual

Deconstructor.

virtual gazebo::gui::CloneWindow::~CloneWindow ( )

virtual

Destructor.

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

Destructor.

virtual gazebo::gui::CylinderMaker::~CylinderMaker ( )

virtual

Deconstructor.

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

virtual

Destructor.

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

Destructor.

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

virtual

Destructor.

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

Destructor.

void gazebo::gui::ModelEditorPalette::AddItem	(	QWidget *	_item,
		const std::string &	_category = `"Other"`
	)

Add an item to the model editor palette.

Parameters

[in]	_Item	item to add.
[in]	_category	Category to add the item too.

bool gazebo::gui::OculusWindow::CreateCamera ( )

Initialize Oculus and create a camera.

Returns: True when Oculus is connected and the camera was created.

void gazebo::gui::ModelEditorPalette::CreateJoint ( const std::string & _type )

Add a joint to the model.

Parameters

[in] _type Type of joint to add.

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

protectedpure virtual

Creates the entity.

Implemented in gazebo::gui::LightMaker, and gazebo::gui::SphereMaker.

bool gazebo::gui::ConfigWidget::GetBoolWidgetValue ( const std::string & _name ) const

Get a bool value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: Bool value.

common::Color gazebo::gui::ConfigWidget::GetColorWidgetValue ( const std::string & _name ) const

Get a color value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: Color value.

double gazebo::gui::ConfigWidget::GetDoubleWidgetValue ( const std::string & _name ) const

Get a double value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: Double value.

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

Get an enum value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: Enum value.

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]	_name	Name of the child widget.
[out]	_dimensions	Dimensions of geometry.

Returns: Type of geometry.

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] _key Non-human-readable key.

Returns: Human-redadable key.

int gazebo::gui::ConfigWidget::GetIntWidgetValue ( const std::string & _name ) const

Get an integer value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: Integer value.

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.

int gazebo::gui::CloneWindow::GetPort ( )

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

Returns: The port for the new gzserver.

math::Pose gazebo::gui::ConfigWidget::GetPoseWidgetValue ( const std::string & _name ) const

Get a pose value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: Pose value.

void gazebo::gui::ConfigWidget::GetRangeFromKey	(	const std::string &	_key,
		double &	_min,
		double &	_max
	)

Returns the range for a given key. For example, the key.

Parameters

[in]	_key	The key.
[out]	_min	The minimum value.
[out]	_max	The maximum value.

std::string gazebo::gui::CylinderMaker::GetSDFString ( )

Get the SDF information for the cylinder.

Returns: The SDF as a string.

std::string gazebo::gui::BoxMaker::GetSDFString ( )

Get the SDF information for the box.

Returns: The SDF as a string.

math::Vector3 gazebo::gui::EntityMaker::GetSnappedPoint ( math::Vector3 _p )

protected

Get a point snapped to a grid.

Parameters

[in] _p input point to be snapped

Returns: math::Vector3 with the point on the grid

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

Get a string value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: String value.

unsigned int gazebo::gui::ConfigWidget::GetUIntWidgetValue ( const std::string & _name ) const

Get an unsigned integer value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: Unsigned integer value.

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]	_key	The key.
[in]	_jointType	In case the field belongs to a joint, the joint's type.

Returns: The unit.

math::Vector3 gazebo::gui::ConfigWidget::GetVector3WidgetValue ( const std::string & _name ) const

Get a vector3 value from a child widget.

Parameters

[in] _name Name of the child widget.

Returns: Vector3 value.

bool gazebo::gui::ConfigWidget::GetWidgetReadOnly ( const std::string & _name ) const

Get whether a child widget is read-only.

Parameters

[in] _name Name of the child widget.

Returns: True if the widget is read-only.

bool gazebo::gui::ConfigWidget::GetWidgetVisible ( const std::string & _name ) const

Get whether a child widget is visible.

Parameters

[in] _name Name of the child widget.

Returns: True if the widget is visible.

virtual bool gazebo::gui::CylinderMaker::IsActive ( ) const

virtual

Documentation inherited.

Implements gazebo::gui::EntityMaker.

virtual bool gazebo::gui::BoxMaker::IsActive ( ) const

virtual

Documentation inherited.

Implements gazebo::gui::EntityMaker.

virtual bool gazebo::gui::EntityMaker::IsActive ( ) const

pure virtual

Checks if entity is active.

Implemented in gazebo::gui::BuildingMaker, gazebo::gui::BoxMaker, gazebo::gui::ModelMaker, gazebo::gui::CylinderMaker, gazebo::gui::SphereMaker, gazebo::gui::MeshMaker, and gazebo::gui::LightMaker.

bool gazebo::gui::CloneWindow::IsValidPort ( )

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] _msg Message to load from.

virtual void gazebo::gui::CylinderMaker::OnMouseDrag ( const common::MouseEvent & _event )

virtual

Documentation inherited.

Reimplemented from gazebo::gui::EntityMaker.

virtual void gazebo::gui::BoxMaker::OnMouseDrag ( const common::MouseEvent & _event )

virtual

Documentation inherited.

Reimplemented from gazebo::gui::EntityMaker.

virtual void gazebo::gui::EntityMaker::OnMouseDrag ( const common::MouseEvent & _event )

virtual

Callback for dragging with mouse.

Parameters

[in] _event MouseEvent object

Reimplemented in gazebo::gui::BoxMaker, gazebo::gui::CylinderMaker, gazebo::gui::ModelMaker, gazebo::gui::LightMaker, gazebo::gui::SphereMaker, and gazebo::gui::MeshMaker.

virtual void gazebo::gui::CylinderMaker::OnMouseMove ( const common::MouseEvent & _event )

virtual

Documentation inherited.

Reimplemented from gazebo::gui::EntityMaker.

virtual void gazebo::gui::BoxMaker::OnMouseMove ( const common::MouseEvent & _event )

virtual

Documentation inherited.

Reimplemented from gazebo::gui::EntityMaker.

virtual void gazebo::gui::EntityMaker::OnMouseMove ( const common::MouseEvent & _event )

virtual

Callback when moving mouse.

Parameters

[in] _event MouseEvent object

Reimplemented in gazebo::gui::BoxMaker, gazebo::gui::CylinderMaker, gazebo::gui::ModelMaker, gazebo::gui::MeshMaker, and gazebo::gui::LightMaker.

virtual void gazebo::gui::CylinderMaker::OnMousePush ( const common::MouseEvent & _event )

virtual

Documentation inherited.

Reimplemented from gazebo::gui::EntityMaker.

virtual void gazebo::gui::BoxMaker::OnMousePush ( const common::MouseEvent & _event )

virtual

Documentation inherited.

Reimplemented from gazebo::gui::EntityMaker.

virtual void gazebo::gui::EntityMaker::OnMousePush ( const common::MouseEvent & _event )

virtual

Callback for pushing entity with mouse.

Parameters

[in] _event MouseEvent object

Reimplemented in gazebo::gui::BoxMaker, gazebo::gui::CylinderMaker, gazebo::gui::ModelMaker, gazebo::gui::SphereMaker, gazebo::gui::MeshMaker, and gazebo::gui::LightMaker.

virtual void gazebo::gui::CylinderMaker::OnMouseRelease ( const common::MouseEvent & _event )

virtual

Documentation inherited.

Reimplemented from gazebo::gui::EntityMaker.

virtual void gazebo::gui::BoxMaker::OnMouseRelease ( const common::MouseEvent & _event )

virtual

Documentation inherited.

Reimplemented from gazebo::gui::EntityMaker.

virtual void gazebo::gui::EntityMaker::OnMouseRelease ( const common::MouseEvent & _event )

virtual

Callback for releasing mouse button.

Parameters

[in] _event MouseEvent object

Reimplemented in gazebo::gui::BoxMaker, gazebo::gui::CylinderMaker, gazebo::gui::ModelMaker, gazebo::gui::LightMaker, gazebo::gui::SphereMaker, and gazebo::gui::MeshMaker.

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]	_name	Name of the child widget.
[in]	_value	Value 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]	_name	Name of the child widget.
[in]	_value	Value 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]	_name	Name of the child widget.
[in]	_value	Value to set to.

Returns: True if the value is set successfully.

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

Set an enum value to a child widget.

Parameters

[in]	_name	Name of the child widget.
[in]	_value	Value 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]	_name	Name of the child widget.
[in]	_value	Type of geometry.
[in]	_dimensions	Dimensions 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]	_name	Name of the child widget.
[in]	_value	Value 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]	_name	Name of the child widget.
[in]	_value	Value to set to.

Returns: True if the value is set successfully.

static void gazebo::gui::EntityMaker::SetSnapToGrid ( bool _snap )

static

Set whether to snap to grid.

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

Set a string value to a child widget.

Parameters

[in]	_name	Name of the child widget.
[in]	_value	Value 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]	_name	Name of the child widget.
[in]	_value	Value 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]	_name	Name of the child widget.
[in]	_value	Value to set to.

Returns: True if the value is set successfully.

void gazebo::gui::ConfigWidget::SetWidgetReadOnly	(	const std::string &	_name,
		bool	_readOnly
	)

Set whether a child widget should be read-only.

Parameters

[in]	_name	Name of the child widget.
[in]	_visible	True 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]	_name	Name of the child widget.
[in]	_visible	True to set the widget to be visible.

virtual void gazebo::gui::OculusWindow::showEvent ( QShowEvent * _e )

protectedvirtual

virtual void gazebo::gui::CylinderMaker::Start ( const rendering::UserCameraPtr _camera )

virtual

Documentation inherited.

Implements gazebo::gui::EntityMaker.

virtual void gazebo::gui::BoxMaker::Start ( const rendering::UserCameraPtr _camera )

virtual

Documentation inherited.

Implements gazebo::gui::EntityMaker.

virtual void gazebo::gui::EntityMaker::Start ( const rendering::UserCameraPtr _camera )

pure virtual

Parameters

[in] _camera Pointer to the user camera

Implemented in gazebo::gui::BuildingMaker, gazebo::gui::BoxMaker, gazebo::gui::ModelMaker, gazebo::gui::CylinderMaker, gazebo::gui::SphereMaker, gazebo::gui::LightMaker, and gazebo::gui::MeshMaker.

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

virtual

Documentation inherited.

Implements gazebo::gui::EntityMaker.

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

virtual

Documentation inherited.

Implements gazebo::gui::EntityMaker.

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

pure virtual

Implemented in gazebo::gui::BuildingMaker, gazebo::gui::BoxMaker, gazebo::gui::ModelMaker, gazebo::gui::CylinderMaker, gazebo::gui::SphereMaker, gazebo::gui::MeshMaker, and gazebo::gui::LightMaker.

void gazebo::gui::ConfigWidget::UpdateFromMsg ( const google::protobuf::Message * _msg )

Update the widgets from a message.

Parameters

[in] _msg Message used for updating the widgets.

Variable Documentation

rendering::UserCameraPtr gazebo::gui::EntityMaker::camera

protected

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

Child widget that can be collapsed or expanded.

CreateCallback gazebo::gui::EntityMaker::createCB

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.

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.

transport::PublisherPtr gazebo::gui::EntityMaker::makerPub

protected

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

Map a widget to the label holding its unit value.

transport::NodePtr gazebo::gui::EntityMaker::node

protected

transport::PublisherPtr gazebo::gui::EntityMaker::requestPub

protected

transport::PublisherPtr gazebo::gui::EntityMaker::visPub

protected

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

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

Signals

void gazebo::gui::EnumConfigWidget::EnumValueChanged ( const QString & _value )

signal

brief Signal an enum value change event.

Parameters

[in] _value New 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]	_name	Scoped name of widget.
[in]	_name	New enum value string.

Files

Namespaces

Classes

Typedefs

Functions

Variables

Signals

Detailed Description

Typedef Documentation

Function Documentation

Variable Documentation

Signals