Skip to content

Builds on top of Qt to provide widgets which are useful when developing robotics applications, such as a 3D view, plots, dashboard, etc, and can be used together in a convenient unified interface.

License

Notifications You must be signed in to change notification settings

gazebosim/gz-gui

Repository files navigation

Gazebo GUI : Graphical interfaces for robotics applications

Maintainer: jenn [AT] openrobotics [DOT] org

GitHub open issues GitHub open pull requests Discourse topics Hex.pm

Build Status
Test coverage codecov
Ubuntu Noble Build Status
Homebrew Build Status
Windows Build Status

Gazebo GUI builds on top of Qt to provide widgets which are useful when developing robotics applications, such as a 3D view, plots, dashboard, etc, and can be used together in a convenient unified interface.

Gazebo GUI ships with several widgets ready to use and offers a plugin interface which can be used to add custom widgets.

Table of Contents

Features

Install

Usage

Documentation

Folder Structure

Contributing

Code of Conduct

Versioning

License

Features

  • Qt-based widgets, with support for both Qt5 widgets and QtQuick
  • Plugin-based interface, so it's easy to add new widgets
  • Several plugins ready to be used
  • 3D scene integration using Gazebo Rendering

Install

See the installation tutorial.

Usage

Take a look at the tutorials for usage instructions and API documentation.

Known issue of command line tools

In the event that the installation is a mix of Debian and from source, command line tools from gz-tools may not work correctly.

A workaround for a single package is to define the environment variable GZ_CONFIG_PATH to point to the location of the Gazebo library installation, where the YAML file for the package is found, such as

export GZ_CONFIG_PATH=/usr/local/share/gz

Multiple paths can be specified using the : delimiter. For example,

export GZ_CONFIG_PATH=/user/local/share/gz/:/path/to/some/other/location

Folder Structure

  • include/gz/gui: Contains all the files which will be installed, such as C++ headers, .qrc, .qss and qml files. Plugin-specific resources go under /plugins; everything in the top-level is meant to be of common use across plugins.

  • src: Contains all the C++ source code and headers which are not installed. Plugin-specific code goes under /plugins.

  • test: All integration, performance and regression tests go here, under their specific folders.

  • examples/standalone: Example code for standalone applications using Gazebo GUI as a library. Each example has instructions in a README file.

  • examples/config: Example configuration files which can be loaded using gz gui -c <path to file>

  • examples/plugin: Example plugins which can be compiled and loaded as explained in this tutorial.

  • tutorials: Markdown files for the tutorials.

  • conf: Files needed by gz-tools.

  • doc: Files used by Doxygen when generating documentation.

Contributing

Please see the contribution guide.

Code of Conduct

Please see CODE_OF_CONDUCT.md.

Versioning

This library uses Semantic Versioning. Additionally, this library is part of the Gazebo project which periodically releases a versioned set of compatible and complimentary libraries. See the Gazebo website for version and release information.

License

This library is licensed under Apache 2.0. See also the LICENSE file.