source: trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/AllResources/Control/UIcommands/_vis_viewer_.html

Last change on this file was 904, checked in by garnier, 16 years ago

ajout de la doc
File size: 10.5 KB
Line 
1<html><head><title>Commands in /vis/viewer/</title></head>
2<body bgcolor="#ffffff"><h2>/vis/viewer/</h2><p>
3Operations on Geant4 viewers.<br>
4<p><hr><p>
5<h2>Sub-directories : </h2><dl>
6<p><br><p><dt><a href="_vis_viewer_set_.html">/vis/viewer/set/</a>
7<p><dd>Set view parameters of current viewer.
8</dl><p><hr><p>
9<h2>Commands : </h2><dl>
10<p><br><p><dt><b>addCutawayPlane [<i>x</i>] [<i>y</i>] [<i>z</i>] [<i>unit</i>] [<i>nx</i>] [<i>ny</i>] [<i>nz</i>]</b>
11<p><dd>
12Add cutaway plane to current viewer.<br>
13<p><dd>Available at all Geant4 states.
14<p><dd>Parameters<table border=1>
15<tr><td>x
16<td>type d
17<td>Omittable : default value = 0
18<td><tr><td>y
19<td>type d
20<td>Omittable : default value = 0
21<td><tr><td>z
22<td>type d
23<td>Omittable : default value = 0
24<td><tr><td>unit
25<td>type s
26<td>Omittable : default value = m
27<td><tr><td>nx
28<td>type d
29<td>Omittable : default value = 1
30<td><tr><td>ny
31<td>type d
32<td>Omittable : default value = 0
33<td><tr><td>nz
34<td>type d
35<td>Omittable : default value = 0
36<td></table>
37<p><br><p><dt><b>changeCutawayPlane [<i>index</i>] [<i>x</i>] [<i>y</i>] [<i>z</i>] [<i>unit</i>] [<i>nx</i>] [<i>ny</i>] [<i>nz</i>]</b>
38<p><dd>
39Change cutaway plane.<br>
40<p><dd>Available at all Geant4 states.
41<p><dd>Parameters<table border=1>
42<tr><td>index
43<td>type i
44<td><td><tr><td>x
45<td>type d
46<td>Omittable : default value = 0
47<td><tr><td>y
48<td>type d
49<td>Omittable : default value = 0
50<td><tr><td>z
51<td>type d
52<td>Omittable : default value = 0
53<td><tr><td>unit
54<td>type s
55<td>Omittable : default value = m
56<td><tr><td>nx
57<td>type d
58<td>Omittable : default value = 1
59<td><tr><td>ny
60<td>type d
61<td>Omittable : default value = 0
62<td><tr><td>nz
63<td>type d
64<td>Omittable : default value = 0
65<td></table>
66<p><br><p><dt><b>clear [<i>viewer-name</i>]</b>
67<p><dd>
68Clears viewer.<br>
69By default, clears current viewer.  Specified viewer becomes current.
70"/vis/viewer/list" to see  possible viewer names.<br>
71<p><dd>Available at all Geant4 states.
72<p><dd>Parameters<table border=1>
73<tr><td>viewer-name
74<td>type s
75<td>Omittable : current value is used as the default value.
76<td></table>
77<p><br><p><dt><b>clearCutawayPlanes</b>
78<p><dd>
79Clear cutaway planes of current viewer.<br>
80<p><dd>Available at all Geant4 states.
81<p><br><p><dt><b>clearTransients [<i>viewer-name</i>]</b>
82<p><dd>
83Clears transients from viewer.<br>
84By default, operates on current viewer.  Specified viewer becomes current.
85"/vis/viewer/list" to see  possible viewer names.<br>
86<p><dd>Available at all Geant4 states.
87<p><dd>Parameters<table border=1>
88<tr><td>viewer-name
89<td>type s
90<td>Omittable : current value is used as the default value.
91<td></table>
92<p><br><p><dt><b>clone [<i>original-viewer-name</i>] [<i>clone-name</i>]</b>
93<p><dd>
94Clones viewer.<br>
95By default, clones current viewer.  Clone becomes current.
96Clone name, if not provided, is derived from the original name.
97"/vis/viewer/list" to see  possible viewer names.<br>
98<p><dd>Available at all Geant4 states.
99<p><dd>Parameters<table border=1>
100<tr><td>original-viewer-name
101<td>type s
102<td>Omittable : current value is used as the default value.
103<td><tr><td>clone-name
104<td>type s
105<td>Omittable : default value = none
106<td></table>
107<p><br><p><dt><b>create [<i>scene-handler</i>] [<i>viewer-name</i>] [<i>window-size-hint</i>]</b>
108<p><dd>
109Creates a viewer for the specified scene handler.<br>
110Default scene handler is the current scene handler.  Invents a name
111if not supplied.  (Note: the system adds information to the name
112for identification - only the characters up to the first blank are
113used for removing, selecting, etc.)  This scene handler and viewer
114become current.<br>
115<p><dd>Available at all Geant4 states.
116<p><dd>Parameters<table border=1>
117<tr><td>scene-handler
118<td>type s
119<td>Omittable : current value is used as the default value.
120<td><tr><td>viewer-name
121<td>type s
122<td>Omittable : current value is used as the default value.
123<td><tr><td>window-size-hint
124<td>type s
125<td>Omittable : default value = 600
126<td></table>
127<p><br><p><dt><b>dolly [<i>increment</i>] [<i>Unit</i>]</b>
128<p><dd>
129Incremental dolly.<br>
130Moves the camera incrementally towards target point.<br>
131<p><dd>Available at all Geant4 states.
132<p><dd>Parameters<table border=1>
133<tr><td>increment
134<td>type d
135<td>Omittable : current value is used as the default value.
136<td><tr><td>Unit
137<td>type s
138<td>Omittable : default value = m
139<td>Parameter candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
140</table>
141<p><br><p><dt><b>dollyTo [<i>distance</i>] [<i>Unit</i>]</b>
142<p><dd>
143Dolly to specific coordinate.<br>
144Places the camera towards target point relative to standard camera point.<br>
145<p><dd>Available at all Geant4 states.
146<p><dd>Parameters<table border=1>
147<tr><td>distance
148<td>type d
149<td>Omittable : current value is used as the default value.
150<td><tr><td>Unit
151<td>type s
152<td>Omittable : default value = m
153<td>Parameter candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
154</table>
155<p><br><p><dt><b>flush [<i>viewer-name</i>]</b>
156<p><dd>
157Compound command: "/vis/viewer/refresh" + "/vis/viewer/update".<br>
158Useful for refreshing and initiating post-processing for graphics
159systems which need post-processing.  By default, acts on current
160viewer.  "/vis/viewer/list" to see possible viewers.  Viewer
161becomes current.<br>
162<p><dd>Available at all Geant4 states.
163<p><dd>Parameters<table border=1>
164<tr><td>viewer-name
165<td>type s
166<td>Omittable : current value is used as the default value.
167<td></table>
168<p><br><p><dt><b>list [<i>viewer-name</i>] [<i>verbosity</i>]</b>
169<p><dd>
170Lists viewers(s).<br>
171See "/vis/verbose" for definition of verbosity.<br>
172<p><dd>Available at all Geant4 states.
173<p><dd>Parameters<table border=1>
174<tr><td>viewer-name
175<td>type s
176<td>Omittable : default value = all
177<td><tr><td>verbosity
178<td>type s
179<td>Omittable : default value = warnings
180<td></table>
181<p><br><p><dt><b>pan [<i>right-increment</i>] [<i>up-increment</i>] [<i>unit</i>]</b>
182<p><dd>
183Incremental pan.<br>
184Moves the camera incrementally right and up by these amounts (as seen
185from viewpoint direction).<br>
186<p><dd>Available at all Geant4 states.
187<p><dd>Parameters<table border=1>
188<tr><td>right-increment
189<td>type d
190<td>Omittable : current value is used as the default value.
191<td><tr><td>up-increment
192<td>type d
193<td>Omittable : current value is used as the default value.
194<td><tr><td>unit
195<td>type s
196<td>Omittable : default value = m
197<td></table>
198<p><br><p><dt><b>panTo [<i>right</i>] [<i>up</i>] [<i>unit</i>]</b>
199<p><dd>
200Pan to specific coordinate.<br>
201Places the camera in this position right and up relative to standard
202target point (as seen from viewpoint direction).<br>
203<p><dd>Available at all Geant4 states.
204<p><dd>Parameters<table border=1>
205<tr><td>right
206<td>type d
207<td>Omittable : current value is used as the default value.
208<td><tr><td>up
209<td>type d
210<td>Omittable : current value is used as the default value.
211<td><tr><td>unit
212<td>type s
213<td>Omittable : default value = m
214<td></table>
215<p><br><p><dt><b>rebuild [<i>viewer-name</i>]</b>
216<p><dd>
217Forces rebuild of graphical database.<br>
218By default, acts on current viewer.  "/vis/viewer/list"
219to see possible viewers.  Viewer becomes current.<br>
220<p><dd>Available at all Geant4 states.
221<p><dd>Parameters<table border=1>
222<tr><td>viewer-name
223<td>type s
224<td>Omittable : current value is used as the default value.
225<td></table>
226<p><br><p><dt><b>refresh [<i>viewer-name</i>]</b>
227<p><dd>
228Refreshes viewer.<br>
229By default, acts on current viewer.  "/vis/viewer/list"
230to see possible viewers.  Viewer becomes current.<br>
231<p><dd>Available at all Geant4 states.
232<p><dd>Parameters<table border=1>
233<tr><td>viewer-name
234<td>type s
235<td>Omittable : current value is used as the default value.
236<td></table>
237<p><br><p><dt><b>reset [<i>viewer-name</i>]</b>
238<p><dd>
239Resets viewer.<br>
240By default, acts on current viewer.  "/vis/viewer/list"
241to see possible viewers.  Viewer becomes current.<br>
242<p><dd>Available at all Geant4 states.
243<p><dd>Parameters<table border=1>
244<tr><td>viewer-name
245<td>type s
246<td>Omittable : current value is used as the default value.
247<td></table>
248<p><br><p><dt><b>scale [<i>x-scale-multiplier</i>] [<i>y-scale-multiplier</i>] [<i>z-scale-multiplier</i>]</b>
249<p><dd>
250Incremental (non-uniform) scaling.<br>
251Multiplies components of current scaling by components of this factor.
252 Scales (x,y,z) by corresponding components of the resulting factor.<br>
253<br>
254<p><dd>Available at all Geant4 states.
255<p><dd>Parameters<table border=1>
256<tr><td>x-scale-multiplier
257<td>type d
258<td>Omittable : current value is used as the default value.
259<td><tr><td>y-scale-multiplier
260<td>type d
261<td>Omittable : current value is used as the default value.
262<td><tr><td>z-scale-multiplier
263<td>type d
264<td>Omittable : current value is used as the default value.
265<td></table>
266<p><br><p><dt><b>scaleTo [<i>x-scale-factor</i>] [<i>y-scale-factor</i>] [<i>z-scale-factor</i>]</b>
267<p><dd>
268Absolute (non-uniform) scaling.<br>
269Scales (x,y,z) by corresponding components of this factor.<br>
270<p><dd>Available at all Geant4 states.
271<p><dd>Parameters<table border=1>
272<tr><td>x-scale-factor
273<td>type d
274<td>Omittable : current value is used as the default value.
275<td><tr><td>y-scale-factor
276<td>type d
277<td>Omittable : current value is used as the default value.
278<td><tr><td>z-scale-factor
279<td>type d
280<td>Omittable : current value is used as the default value.
281<td></table>
282<p><br><p><dt><b>select [<i>viewer-name</i>]</b>
283<p><dd>
284Selects viewer.<br>
285Specify viewer by name.  "/vis/viewer/list" to see possible viewers.<br>
286<p><dd>Available at all Geant4 states.
287<p><dd>Parameters<table border=1>
288<tr><td>viewer-name
289<td>type s
290<td><td></table>
291<p><br><p><dt><b>update [<i>viewer-name</i>]</b>
292<p><dd>
293Triggers graphical database post-processing for viewers
294using that technique.<br>
295For such viewers the view only becomes visible with this command.
296By default, acts on current viewer.  "/vis/viewer/list"
297to see possible viewers.  Viewer becomes current.<br>
298<p><dd>Available at all Geant4 states.
299<p><dd>Parameters<table border=1>
300<tr><td>viewer-name
301<td>type s
302<td>Omittable : current value is used as the default value.
303<td></table>
304<p><br><p><dt><b>zoom [<i>multiplier</i>]</b>
305<p><dd>
306Incremental zoom.<br>
307Multiplies current magnification by this factor.<br>
308<p><dd>Available at all Geant4 states.
309<p><dd>Parameters<table border=1>
310<tr><td>multiplier
311<td>type d
312<td>Omittable : current value is used as the default value.
313<td></table>
314<p><br><p><dt><b>zoomTo [<i>factor</i>]</b>
315<p><dd>
316Absolute zoom.<br>
317Magnifies standard magnification by this factor.<br>
318<p><dd>Available at all Geant4 states.
319<p><dd>Parameters<table border=1>
320<tr><td>factor
321<td>type d
322<td>Omittable : current value is used as the default value.
323<td></table>
324</dl></body></html>
Note: See TracBrowser for help on using the repository browser.