You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* grouped images under tutorials directory, added extra screenshots, reworded some lines for clarity, removed the pre-release tag under the --version explanation
Copy file name to clipboardExpand all lines: garden/GUI_tutorial.md
+29-19Lines changed: 29 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,44 +17,47 @@ gz sim shapes.sdf
17
17
18
18
`gz sim` will run the latest version of Gazebo you have installed.
19
19
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:
21
21
22
22
```bash
23
-
7.0.0~pre1
23
+
7.0.0
24
24
6.0.0
25
25
5.0.0
26
26
```
27
27
28
28
To ensure you're working with Garden, include the `--force-version` directive when starting up:
29
29
30
30
```bash
31
-
gz sim --force-version 7.0.0~pre1 shapes.sdf
31
+
gz sim --force-version 7.0.0 shapes.sdf
32
32
```
33
33
34
34
## GUI
35
35
36
36
After running `shapes.sdf`, you should see the following screen:
37
37
38
-

38
+

39
39
40
40
The interface consists of several sections:
41
41
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
45
43
44
+
The toolbar along the top of the GUI contains two buttons, a file menu button () on the left, and a plugins button () on the right.
46
45
The file menu button allows you to save the world to a file, save and load interface configurations and customize interface style settings.
47
46
An interface configuration consists of the plugins you have loaded and the style settings in place.
48
47
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
+

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).
51
51
The shape buttons allow you to directly insert a box, sphere, cylinder capsule, or ellipsoid model into the world.
52
52
Simply click on the shape you would like to insert, and place it into the world.
53
53
The shape will automatically snap onto the ground plane, and its properties will show up on the Entity Tree plugin window.
54
54
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`):
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.
58
61
59
62
The plugins button lists all the available plugins.
60
63
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.
68
71
Everything in a simulation is considered an "entity."
69
72
In `shapes.sdf`, the entities listed are the ground plane, each of the shape models, and the sun.
70
73
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.
72
75
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).
74
77
You can also hold `Ctrl` and click to select multiple.
75
78
76
-

79
+

77
80
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.
79
83
80
84
### The Scene
81
85
@@ -95,23 +99,25 @@ Currently, you can navigate the scene with a mouse in several ways:
95
99
***Right-click and drag**: zoom in and out
96
100
***Scroll wheel forward/backward**: zoom in and out
97
101
***Scroll wheel click and drag**: rotate the scene
102
+
* Or use **Shift key + left-click and drag**
98
103
99
104
More complex methods for interacting with the entities within a scene will be explained in-depth in the coming tutorials.
100
105
101
106
#### Grid Config
102
107
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.
104
109
You can adjust features of the world's grid, including cell size, grid position, cell count, and even color.
105
110
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).
Along the bottom edge of the scene, you'll notice several buttons:
113
119
114
-

120
+

115
121
116
122
From left to right, the options are `Play`, `Steps` and `RTF` (real time factor).
117
123
@@ -121,8 +127,12 @@ You can use the same button to pause the simulation as well.
121
127
The `Steps` button allows you to step through the simulation at the rate of a step size, or simulation iteration.
122
128
You can customize step size by hovering over the button.
123
129
130
+

131
+
124
132
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.
125
133
134
+

135
+
126
136
The function of the World Control options will become clearer once you begin manipulating entities.
0 commit comments