Skip to content

Commit f2ed93d

Browse files
Extension of the GUI documentation (gazebosim#299)
* grouped images under tutorials directory, added extra screenshots, reworded some lines for clarity, removed the pre-release tag under the --version explanation
1 parent a5cb541 commit f2ed93d

File tree

11 files changed

+29
-19
lines changed

11 files changed

+29
-19
lines changed

garden/GUI_tutorial.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,44 +17,47 @@ gz sim shapes.sdf
1717

1818
`gz sim` will run the latest version of Gazebo you have installed.
1919
You can check if you have more than one version of Gazebo installed by running `gz sim --versions`.
20-
For example, if you have Garden, Fortress and Dome installed, `--versions` might return:
20+
For example, if you have Garden (7.x.x), Fortress (6.x.x) and Edifice (5.x.x) installed, `--versions` might return:
2121

2222
```bash
23-
7.0.0~pre1
23+
7.0.0
2424
6.0.0
2525
5.0.0
2626
```
2727

2828
To ensure you're working with Garden, include the `--force-version` directive when starting up:
2929

3030
```bash
31-
gz sim --force-version 7.0.0~pre1 shapes.sdf
31+
gz sim --force-version 7.0.0 shapes.sdf
3232
```
3333

3434
## GUI
3535

3636
After running `shapes.sdf`, you should see the following screen:
3737

38-
![shapes.sdf](img/shapes.png)
38+
![shapes.sdf](tutorials/gui/shapes.png)
3939

4040
The interface consists of several sections:
4141

42-
### The Toolbar
43-
44-
The toolbar along the top of the GUI contains two buttons, a file menu button on the left (horizontal stripes), and a plugins button on the right (vertical ellipsis).
42+
### The Toolbars
4543

44+
The toolbar along the top of the GUI contains two buttons, a file menu button (![menu button](tutorials/gui/menu_btn.png)) on the left, and a plugins button (![plugins button](tutorials/gui/plugins_btn.png)) on the right.
4645
The file menu button allows you to save the world to a file, save and load interface configurations and customize interface style settings.
4746
An interface configuration consists of the plugins you have loaded and the style settings in place.
4847

49-
The top left toolbar hanging below the file menu button contains shape buttons (sphere, box, cylinder, capsule and ellipsoid) and transform control (first four buttons on the second row).
50-
To learn more about transform control, go to the "Transform Control" section of [Manipulating Models](manipulating_models) tutorial.
48+
![toolbars](tutorials/gui/toolbars.png)
49+
50+
The top left toolbar hanging below the file menu button contains shape buttons (sphere, box, cylinder, capsule and ellipsoid) as well as lighting controls (point, directional and spot).
5151
The shape buttons allow you to directly insert a box, sphere, cylinder capsule, or ellipsoid model into the world.
5252
Simply click on the shape you would like to insert, and place it into the world.
5353
The shape will automatically snap onto the ground plane, and its properties will show up on the Entity Tree plugin window.
5454

55-
The following is what it looks like after inserting shapes:
55+
The following image shows the scene and the Entity Tree after adding three shapes (`box_0`, `sphere_0` and `capsule_0`):
56+
57+
![shape insertion](tutorials/gui/shape_insertion.png)
5658

57-
![shape insertion](img/shape_insertion.png)
59+
The first five buttons on the second row are for `Transform Control`.
60+
To learn more about this plugin, go to the `Transform Control` section of [Manipulating Models](manipulating_models) tutorial.
5861

5962
The plugins button lists all the available plugins.
6063
You can scroll down this list to see all the plugins that are available for your version of Gazebo.
@@ -68,14 +71,15 @@ At the top is the Component Inspector, followed by the Entity Tree.
6871
Everything in a simulation is considered an "entity."
6972
In `shapes.sdf`, the entities listed are the ground plane, each of the shape models, and the sun.
7073

71-
Items in the list can be expanded to reveal their links, as well as corresponding visuals and collisions, and joints, if they exist.
74+
Entities in the Entity Tree can be expanded to reveal their links, as well as corresponding visuals and collisions, and joints, if they exist.
7275

73-
You can select entities in the simulation by clicking on their names in the entity tree.
76+
You can select entities in the simulation by clicking on their names in the Entity Tree (or by clicking directly on the entity in the scene).
7477
You can also hold `Ctrl` and click to select multiple.
7578

76-
![Selecting multiple entities from the entity tree](img/entity_select.png)
79+
![Selecting multiple entities from the entity tree](tutorials/gui/entity_select.png)
7780

78-
You can also right-click on any plugin to open basic `Settings` or to `Close`.
81+
You can right-click on any plugin to open basic `Settings` or to `Close`.
82+
You can (re)open plugins through the plugin menu.
7983

8084
### The Scene
8185

@@ -95,23 +99,25 @@ Currently, you can navigate the scene with a mouse in several ways:
9599
* **Right-click and drag**: zoom in and out
96100
* **Scroll wheel forward/backward**: zoom in and out
97101
* **Scroll wheel click and drag**: rotate the scene
102+
* Or use **Shift key + left-click and drag**
98103

99104
More complex methods for interacting with the entities within a scene will be explained in-depth in the coming tutorials.
100105

101106
#### Grid Config
102107

103-
The grid visible in the scene can be adjusted by a plugin.
108+
The grid visibility in the scene can be adjusted by a plugin.
104109
You can adjust features of the world's grid, including cell size, grid position, cell count, and even color.
105110

106-
Open the Grid Config plugin by selecting it from the plugins button from the toolbar and selecting it from the dropdown list (below the Entity tree, use the scrollbar if your screen did not display it).
111+
Open the Grid Config plugin by selecting it from the plugins button from the toolbar and selecting it from the dropdown list.
112+
The plugin will now show up in the right panel (below the Entity Tree, scroll down if your screen did not display it).
107113

108-
![Select Grid Config](img/grid_config.png)
114+
![Select Grid Config](tutorials/gui/grid_config.png)
109115

110116
#### World Control
111117

112118
Along the bottom edge of the scene, you'll notice several buttons:
113119

114-
![Playback buttons](img/playback.png)
120+
![Playback buttons](tutorials/gui/playback.png)
115121

116122
From left to right, the options are `Play`, `Steps` and `RTF` (real time factor).
117123

@@ -121,8 +127,12 @@ You can use the same button to pause the simulation as well.
121127
The `Steps` button allows you to step through the simulation at the rate of a step size, or simulation iteration.
122128
You can customize step size by hovering over the button.
123129

130+
![hover steps](tutorials/gui/hover_steps.png)
131+
124132
At the furthest right end of the scene, you can expand `RTF` to see not only the percentage value that compares real time with sim time, but also those individual values themselves, as well as iteration count.
125133

134+
![RTF expanded](tutorials/gui/rtf_expanded.png)
135+
126136
The function of the World Control options will become clearer once you begin manipulating entities.
127137

128138
## Next Up
8.35 KB
Loading

garden/tutorials/gui/menu_btn.png

469 Bytes
Loading
596 Bytes
Loading
12.5 KB
Loading

0 commit comments

Comments
 (0)