Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ release will remove the deprecated code.
* Upgraded GUI framework from Qt5 to Qt6. All GUI plugins distributed by gz-gui
have been migrated. This upgrade affects all users' custom Gazebo GUI plugins.
Please see the
[Qt6 Migration tutorial](https://github.com/gazebosim/gz-gui/blob/main/tutorials/09_migration_qt6.md)
[Qt6 Migration tutorial](https://github.com/gazebosim/gz-gui/blob/gz-gui10/tutorials/09_migration_qt6.md)
for information on how to port your Qt5 based plugins to Qt6.

* The environment variable `GZ_GUI_PLUGIN_INSTALL_DIR` is removed. Use
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

Build | Status
-- | --
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-gui/tree/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-gui/tree/main)
Ubuntu Noble | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_gui-ci-main-noble-amd64)](https://build.osrfoundation.org/job/gz_gui-ci-main-noble-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_gui-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/gz_gui-ci-main-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_gui-main-clowin)](https://build.osrfoundation.org/job/gz_gui-main-clowin)
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-gui/tree/gz-gui10/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-gui/tree/gz-gui10)
Ubuntu Noble | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_gui-ci-gz-gui10-noble-amd64)](https://build.osrfoundation.org/job/gz_gui-ci-gz-gui10-noble-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_gui-ci-gz-gui10-homebrew-amd64)](https://build.osrfoundation.org/job/gz_gui-ci-gz-gui10-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_gui-10-cnlwin)](https://build.osrfoundation.org/job/gz_gui-10-cnlwin)

Gazebo GUI builds on top of [Qt](https://www.qt.io/) to provide widgets which are
useful when developing robotics applications, such as a 3D view, plots, dashboard, etc,
Expand Down
4 changes: 2 additions & 2 deletions tutorials/03_plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Here the `topic` command of gz binary is used. In that, we want to echo (`-e`) t

We will walk through the HelloPlugin to see how the Plugin is implemented.

We refer to the files [HelloPlugin.hh](https://github.com/gazebosim/gz-gui/blob/main/examples/plugin/hello_plugin/HelloPlugin.hh) and [HelloPlugin.cc](https://github.com/gazebosim/gz-gui/blob/main/examples/plugin/hello_plugin/HelloPlugin.cc) in `examples/plugin/hello_plugin/` in `gz-gui`.
We refer to the files [HelloPlugin.hh](https://github.com/gazebosim/gz-gui/blob/gz-gui10/examples/plugin/hello_plugin/HelloPlugin.hh) and [HelloPlugin.cc](https://github.com/gazebosim/gz-gui/blob/gz-gui10/examples/plugin/hello_plugin/HelloPlugin.cc) in `examples/plugin/hello_plugin/` in `gz-gui`.

A new plugin should inherit from `gz::gui::Plugin` class.

Expand Down Expand Up @@ -86,7 +86,7 @@ A plugin may require certain configuration files to specify certain parameter va

In this case, we would want the configuration file to hold the message to be printed on the display (here the display is the terminal) when the `Hello, Plugin!` button is clicked.

Thus, the [HelloPlugin.config](https://github.com/gazebosim/gz-gui/blob/main/examples/plugin/hello_plugin/HelloPlugin.config) looks like this:
Thus, the [HelloPlugin.config](https://github.com/gazebosim/gz-gui/blob/gz-gui10/examples/plugin/hello_plugin/HelloPlugin.config) looks like this:

```xml
<plugin filename="HelloPlugin">
Expand Down
2 changes: 1 addition & 1 deletion tutorials/05_style.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ but it is also possible to use others such as Default and Universal. This tutori
focuses on customizing the Material style.

The default style is hardcoded into the
[qtquickcontrols2.conf](https://github.com/gazebosim/gz-gui/blob/main/include/gz/gui/qtquickcontrols2.conf)
[qtquickcontrols2.conf](https://github.com/gazebosim/gz-gui/blob/gz-gui10/include/gz/gui/qtquickcontrols2.conf)
file.

There are a few ways to override the default style:
Expand Down
4 changes: 2 additions & 2 deletions tutorials/07_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ Gazebo GUI accepts the following top-level elements on a config file:
* `filename`: This attribute specifies the plugin library to be loaded.
* `<gz-gui>`: Gazebo GUI processes this block before passing the
config to the plugin. See
[plugin_params.config](https://github.com/gazebosim/gz-gui/blob/main/examples/config/plugin_params.config)
[plugin_params.config](https://github.com/gazebosim/gz-gui/blob/gz-gui10/examples/config/plugin_params.config)
for an example.
* custom elements: Developers can read custom plugin configurations overriding the
[Plugin::LoadConfig](https://gazebosim.org/api/gui/6.0/classignition_1_1gui_1_1Plugin.html#a720646.0af4cd247b994b905559fd4ee)
function, see the
[HelloPlugin](https://github.com/gazebosim/gz-gui/blob/main/examples/plugin/hello_plugin/HelloPlugin.cc)
[HelloPlugin](https://github.com/gazebosim/gz-gui/blob/gz-gui10/examples/plugin/hello_plugin/HelloPlugin.cc)
example.

See the example plugin block below:
Expand Down
2 changes: 1 addition & 1 deletion tutorials/scene.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ will process those and update the 3D scene, and then the `MinimalScene` will
paint the scene to the window.

Follow the instructions in the
[scene_provider example](https://github.com/gazebosim/gz-gui/tree/main/examples/standalone/scene_provider)
[scene_provider example](https://github.com/gazebosim/gz-gui/tree/gz-gui10/examples/standalone/scene_provider)
and see visuals being added and moved on the 3D scene.

### Getting the scene
Expand Down
Loading