/
group__worldgui.html
240 lines (187 loc) · 7.95 KB
/
group__worldgui.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<!-- $Id: header.html,v 1.5 2008-02-24 23:24:40 rtv Exp $ -->
<HEAD>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<style type="text/css">
#.floatright { float: right; margin: 0 0 1em 1em; }
body {
font-family: sans-serif;
#font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
background-color: #FFF;
color:#000;
}
a:link {
color: #A00;
}
a:visited {
color: #800;
}
a { text-decoration: none; }
a:hover { text-decoration: underline; }
.timestamp { text-align:right; background-color: #DDD; font-size:75%;}
h1 {
font-size:160%;
}
h2 {
font-size:110%;
#color: #FFF;
#background-color: #666;
#padding:3px;
}
h3 { text-align:left; }
img {
border: 0;
}
ul.menu {
position:relative;
left:-2.5em;
margin-bottom:0px;
margin-top:0px;
}
ul.menu1 {
position:relative;
left:-2.1em;
margin-bottom:0px;
margin-top:0px;
}
li.menu {
list-style-type: none;
position:relative;
#left:-0.5em;
}
#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:11em;}
#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }
div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; }
div.box_light { background-color:#FFF; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; }
div.title { font-weight:bold; margin-bottom:2px;}
div.topbar { position: absolute; top:0px; left:9em; margin:1em; }
</style>
<TITLE>Stage Manual</TITLE>
</HEAD>
<body>
<div id="sidebar">
<h2 style="text-align:center;">
<a href="index.html"><img src="stage_button.png" alt="Stage logo image"></a>
</h2>
<div class="box">
<div class=title>User</div>
<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="release.html">Release</a>
<li class=menu><a href="authors.html">Authors</a>
<li class=menu><a href="install.html">Installation</a>
<hr>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>
<div class=box>
<div class="title">Player</div>
<li class=menu><a href="group__player.html">libstageplugin</a>
</div>
<div class=box>
<div class="title">Developer</div>
<a href="namespaces.html">libstage</a>
</div>
<div class=box_light>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="https://github.com/rtv/Stage">GitHub</a>
<a href="https://github.com/rtv/Stage/issues">Bugs/Issues</a>
<hr>
<a href="http://playerstage.org">Player Project</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Mailing Lists</a>
</div>
</div>
<div id="content" >
<div>
<!-- Generated by Doxygen 1.7.5.1 -->
</div>
<div class="header">
<div class="headertitle">
<div class="title">World with Graphical User Interface</div> </div>
</div>
<div class="contents">
<p>The Stage window consists of a menu bar and a view of the simulated world.</p>
<p>The world view shows part of the simulated world. You can zoom the view in and out, and scroll it to see more of the world. Simulated robot devices, obstacles, etc., are rendered as colored polygons. The world view can also show visualizations of the data and configuration of various sensor and actuator models. The View menu has options to control which data and configurations are rendered.</p>
<p>API: <a class="el" href="classStg_1_1WorldGui.html">Stg::WorldGui</a></p>
<h2>Worldfile Properties</h2>
<dl class="user"><dt><b>Summary and default values</b></dt><dd></dd></dl>
<p>speedup 1</p>
<div class="fragment"><pre class="fragment">
window
(
size [ 400 300 ]
# camera options
center [ 0 0 ]
rotate [ 0 0 ]
scale 1.0
# perspective camera options
pcam_loc [ 0 -4 2 ]
pcam_angle [ 70 0 ]
# GUI options
show_data 0
show_flags 1
show_blocks 1
show_clock 1
show_footprints 0
show_grid 1
show_trailarrows 0
show_trailrise 0
show_trailfast 0
show_occupancy 0
show_tree 0
pcam_on 0
screenshots 0
)
</pre></div><dl class="user"><dt><b>Details</b></dt><dd><ul>
<li>speedup <int><br/>
Stage will attempt to run at this multiple of real time. If -1, Stage will run as fast as it can go, and not attempt to track real time at all.</li>
</ul>
</dd></dl>
<ul>
<li>size [ <width:int> <height:int> ]<br/>
size of the window in pixels</li>
<li>center [ <x:float> <y:float> ]<br/>
location of the center of the window in world coordinates (meters)</li>
<li>rotate [ <pitch:float> <yaw:float> ]<br/>
angle relative to straight up, angle of rotation (degrees)</li>
<li>scale <float><br/>
ratio of world to pixel coordinates (window zoom)</li>
<li>pcam_loc [ <x:int> <y:int> <z:int> ]<br/>
location of the perspective camera (meters)</li>
<li>pcam_angle [ <pitch:float> <yaw:float> ]<br/>
verticle and horizontal angle of the perspective camera</li>
<li>pcam_on <int><br/>
whether to start with the perspective camera enabled (0/1)</li>
</ul>
<h2>Using the Stage window</h2>
<h3>Scrolling the view</h3>
<p>Left-click and drag on the background to move your view of the world.</p>
<h3>Zooming the view</h3>
<p>Scroll the mouse wheel to zoom in or out on the mouse cursor.</p>
<h3>Saving the world</h3>
<p>You can save the current pose of everything in the world, using the File/Save menu item. <b>Warning: the saved poses overwrite the currentworld file.</b> Make a copy of your world file before saving if you want to keep the old poses. Alternatively the File/Save As menu item can be used to save to a new world file.</p>
<h3>Pausing and resuming the clock</h3>
<p>The simulation can be paused or resumed by pressing the 'p' key. Run one simulation step at a time by pressing the '.' (period) key. Hold down the '.' key to step repeatedly. Stepping leaves the simulation paused, so press 'p' to resume running. The initial paused/unpaused state can be set in the worldfile using the "paused" property.</p>
<h3>Selecting models</h3>
<p>Models can be selected by clicking on them with the left mouse button. It is possible to select multiple models by holding the shift key and clicking on multiple models. Selected models can be moved by dragging or rotated by holding the right mouse button and moving the mouse. Selections can be cleared by clicking on an empty location in the world. After clearing the selection, the last single model selected will be saved as the target for several view options described below which affect a particular model.</p>
<h3>View options</h3>
<p>The View menu provides access to a number of features affecting how the world is rendered. To the right of each option there is usually a keyboard hotkey which can be pressed to quickly toggle the relevant option.</p>
<p>Sensor data visualizations can be toggled by the "Data" option (shortcut 'd'). The filter data option (shortcut shift-'d') opens a dialog which enables turning on and off visualizations of particular sensors. The "Visualize All" option in the dialog toggles whether sensor visualizations are enabled for all models or only the currently selected ones.</p>
<p>The "Follow" option keeps the view centered on the last selected model.</p>
<p>The "Perspective camera" option switches from orthogonal viewing to perspective viewing.</p>
<h3>Saving a screenshot</h3>
<p>To save a sequence of screenshots of the world, select the "Save
screenshots" option from the view menu to start recording images and then select the option from the menu again to stop. </p>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 29 2011 16:43:39 for Stage by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>
</body>
</html>