source: trunk/documents/UserDoc/UsersGuides/ForApplicationDeveloper/html/Control/UIcommands/_vis_scene_add_.html @ 1231

Last change on this file since 1231 was 1208, checked in by garnier, 15 years ago

CVS update
File size: 10.8 KB
Line 
1<html><head><title>Commands in /vis/scene/add/</title></head>
2<body bgcolor="#ffffff"><h2>/vis/scene/add/</h2><p>
3Add model to current scene.<br>
4<p><hr><p>
5<h2>Sub-directories : </h2><dl>
6</dl><p><hr><p>
7<h2>Commands : </h2><dl>
8<p><br><p><dt><b>axes [<i>x0</i>] [<i>y0</i>] [<i>z0</i>] [<i>length</i>] [<i>unit</i>]</b>
9<p><dd>
10Add axes.<br>
11Draws axes at (x0, y0, z0) of given length.<br>
12<p><dd>Available at all Geant4 states.
13<p><dd>Parameters<table border=1>
14<tr><td>x0
15<td>type d
16<td>Omittable : default value = 0
17<td><tr><td>y0
18<td>type d
19<td>Omittable : default value = 0
20<td><tr><td>z0
21<td>type d
22<td>Omittable : default value = 0
23<td><tr><td>length
24<td>type d
25<td>Omittable : default value = 1
26<td><tr><td>unit
27<td>type s
28<td>Omittable : default value = m
29<td></table>
30<p><br><p><dt><b>eventID [<i>size</i>] [<i>x-position</i>] [<i>y-position</i>]</b>
31<p><dd>
32Adds eventID to current scene.<br>
33Run and event numbers are drawn at end of event or run when
34 the scene in which they are added is current.<br>
35<p><dd>Available at all Geant4 states.
36<p><dd>Parameters<table border=1>
37<tr><td>size
38<td>type i
39<td>Omittable : default value = 18
40<td><tr><td>x-position
41<td>type d
42<td>Omittable : default value = -0.95
43<td><tr><td>y-position
44<td>type d
45<td>Omittable : default value = 0.9
46<td></table>
47<p><br><p><dt><b>ghosts [<i>particle</i>]</b>
48<p><dd>
49Adds ghost volumes (G4FlavoredParallelWorld) to the current scene.<br>
50Selects by particle.<br>
51<p><dd>Available at all Geant4 states.
52<p><dd>Parameters<table border=1>
53<tr><td>particle
54<td>type s
55<td>Omittable : default value = all
56<td></table>
57<p><br><p><dt><b>hits</b>
58<p><dd>
59Adds hits to current scene.<br>
60Hits are drawn at end of event when the scene in which
61they are added is current.<br>
62<p><dd>Available at all Geant4 states.
63<p><br><p><dt><b>logicalVolume [<i>logical-volume-name</i>] [<i>depth-of-descent</i>] [<i>booleans-flag</i>] [<i>voxels-flag</i>] [<i>readout-flag</i>]</b>
64<p><dd>
65Adds a logical volume to the current scene,<br>
66Shows boolean components (if any), voxels (if any) and readout geometry
67(if any).  Note: voxels are not constructed until start of run -
68 "/run/beamOn".<br>
69<p><dd>Available at all Geant4 states.
70<p><dd>Parameters<table border=1>
71<tr><td>logical-volume-name
72<td>type s
73<td><td><tr><td>depth-of-descent
74<td>type i
75<td>Omittable : default value = 1
76<td><tr><td>booleans-flag
77<td>type b
78<td>Omittable : default value = 1
79<td><tr><td>voxels-flag
80<td>type b
81<td>Omittable : default value = 1
82<td><tr><td>readout-flag
83<td>type b
84<td>Omittable : default value = 1
85<td></table>
86<p><br><p><dt><b>logo [<i>height</i>] [<i>unit</i>] [<i>direction</i>] [<i>red</i>] [<i>green</i>] [<i>blue</i>] [<i>auto|manual</i>] [<i>xmid</i>] [<i>ymid</i>] [<i>zmid</i>] [<i>unit</i>]</b>
87<p><dd>
88Adds a G4 logo to the current scene.<br>
89The placement, if automatic, is similar to that of scale -
90"help /vis/scene/add/scale" for more information.<br>
91<p><dd>Available at all Geant4 states.
92<p><dd>Parameters<table border=1>
93<tr><td>height
94<td>type d
95<td>Omittable : default value = 1
96<td><tr><td>unit
97<td>type s
98<td>Omittable : default value = m
99<td><tr><td>direction
100<td>type s
101<td>Omittable : default value = x
102<td><tr><td>red
103<td>type d
104<td>Omittable : default value = 0
105<td><tr><td>green
106<td>type d
107<td>Omittable : default value = 1
108<td><tr><td>blue
109<td>type d
110<td>Omittable : default value = 0
111<td><tr><td>auto|manual
112<td>type s
113<td>Omittable : default value = auto
114<td>Parameter candidates : auto manual
115<tr><td>xmid
116<td>type d
117<td>Omittable : default value = 0
118<td><tr><td>ymid
119<td>type d
120<td>Omittable : default value = 0
121<td><tr><td>zmid
122<td>type d
123<td>Omittable : default value = 0
124<td><tr><td>unit
125<td>type s
126<td>Omittable : default value = m
127<td></table>
128<p><br><p><dt><b>scale [<i>length</i>] [<i>unit</i>] [<i>direction</i>] [<i>red</i>] [<i>green</i>] [<i>blue</i>] [<i>auto|manual</i>] [<i>xmid</i>] [<i>ymid</i>] [<i>zmid</i>] [<i>unit</i>]</b>
129<p><dd>
130Adds an annotated scale line to the current scene.<br>
131An annotated line in the specified direction with tick marks at the
132end.  If autoPlacing is true it is required to be centred at the
133front, right, bottom corner of the world space, comfortably outside
134the existing bounding box/sphere so that existing objects do not
135obscure it.  Otherwise it is required to be drawn with mid-point at
136(xmid, ymid, zmid).
137
138The auto placing algorithm might be:
139  x = xmin + (1 + comfort) * (xmax - xmin);
140  y = ymin - comfort * (ymax - ymin);
141  z = zmin + (1 + comfort) * (zmax - zmin);
142  if direction == x then (x - length,y,z) to (x,y,z);
143  if direction == y then (x,y,z) to (x,y + length,z);
144  if direction == z then (x,y,z - length) to (x,y,z);<br>
145<p><dd>Available at all Geant4 states.
146<p><dd>Parameters<table border=1>
147<tr><td>length
148<td>type d
149<td>Omittable : default value = 1
150<td><tr><td>unit
151<td>type s
152<td>Omittable : default value = m
153<td><tr><td>direction
154<td>type s
155<td>Omittable : default value = x
156<td><tr><td>red
157<td>type d
158<td>Omittable : default value = 1
159<td><tr><td>green
160<td>type d
161<td>Omittable : default value = 0
162<td><tr><td>blue
163<td>type d
164<td>Omittable : default value = 0
165<td><tr><td>auto|manual
166<td>type s
167<td>Omittable : default value = auto
168<td>Parameter candidates : auto manual
169<tr><td>xmid
170<td>type d
171<td>Omittable : default value = 0
172<td><tr><td>ymid
173<td>type d
174<td>Omittable : default value = 0
175<td><tr><td>zmid
176<td>type d
177<td>Omittable : default value = 0
178<td><tr><td>unit
179<td>type s
180<td>Omittable : default value = m
181<td></table>
182<p><br><p><dt><b>text [<i>x</i>] [<i>y</i>] [<i>z</i>] [<i>unit</i>] [<i>font_size</i>] [<i>x_offset</i>] [<i>y_offset</i>] [<i>text</i>]</b>
183<p><dd>
184Adds text to current scene.<br>
185<p><dd>Available at all Geant4 states.
186<p><dd>Parameters<table border=1>
187<tr><td>x
188<td>type d
189<td>Omittable : default value = 0
190<td><tr><td>y
191<td>type d
192<td>Omittable : default value = 0
193<td><tr><td>z
194<td>type d
195<td>Omittable : default value = 0
196<td><tr><td>unit
197<td>type s
198<td>Omittable : default value = m
199<td><tr><td>font_size
200<td>type d
201<td>Omittable : default value = 12
202<td><tr><td>x_offset
203<td>type d
204<td>Omittable : default value = 0
205<td><tr><td>y_offset
206<td>type d
207<td>Omittable : default value = 0
208<td><tr><td>text
209<td>type s
210<td>Omittable : default value = Hello G4
211<td></table>
212<p><br><p><dt><b>trajectories [<i>default-trajectory-type</i>]</b>
213<p><dd>
214Adds trajectories to current scene.<br>
215Causes trajectories, if any, to be drawn at the end of processing an
216event.  Switches on trajectory storing and sets the
217default trajectory type.<br>
218The command line parameter list determines the default trajectory type.
219If it contains the string "smooth", auxiliary inter-step points will
220be inserted to improve the smoothness of the drawing of a curved
221trajectory.
222If it contains the string "rich", significant extra information will
223be stored in the trajectory (G4RichTrajectory) amenable to modeling
224and filtering with "/vis/modeling/trajectories/create/drawByAttribute"
225and "/vis/filtering/trajectories/create/attributeFilter" commands.
226It may contain both strings in any order.<br>
227
228To switch off trajectory storing: "/tracking/storeTrajectory 0".
229See also "/vis/scene/endOfEventAction".<br>
230Note:  This only sets the default.  Independently of the result of this
231command, a user may instantiate a trajectory that overrides this default
232in PreUserTrackingAction.<br>
233<p><dd>Available at all Geant4 states.
234<p><dd>Parameters<table border=1>
235<tr><td>default-trajectory-type
236<td>type s
237<td>Omittable : default value =
238<td></table>
239<p><br><p><dt><b>userAction [<i>xmin</i>] [<i>xmax</i>] [<i>ymin</i>] [<i>ymax</i>] [<i>zmin</i>] [<i>zmax</i>] [<i>unit</i>]</b>
240<p><dd>
241Add Vis User Action, if any, to current scene.<br>
242Optional arguments define the extent of the callback drawing.  You may
243not need this if the extent has been defined in the original
244SetUserAction or is defined by other components of the scene.  But if
245the user action is the only component of the scene, you will certainly
246need to set the extent either in SetUserAction or here.  A scene must
247have an extent one way or another so that the viewer can calculate
248how to point the camera.<br>
249<p><dd>Available at all Geant4 states.
250<p><dd>Parameters<table border=1>
251<tr><td>xmin
252<td>type d
253<td>Omittable : default value = 0
254<td><tr><td>xmax
255<td>type d
256<td>Omittable : default value = 0
257<td><tr><td>ymin
258<td>type d
259<td>Omittable : default value = 0
260<td><tr><td>ymax
261<td>type d
262<td>Omittable : default value = 0
263<td><tr><td>zmin
264<td>type d
265<td>Omittable : default value = 0
266<td><tr><td>zmax
267<td>type d
268<td>Omittable : default value = 0
269<td><tr><td>unit
270<td>type s
271<td>Omittable : default value = cm
272<td></table>
273<p><br><p><dt><b>volume [<i>physical-volume-name</i>] [<i>copy-no</i>] [<i>depth-of-descent</i>] [<i>clip-volume-type</i>] [<i>parameter-unit</i>] [<i>parameter-1</i>] [<i>parameter-2</i>] [<i>parameter-3</i>] [<i>parameter-4</i>] [<i>parameter-5</i>] [<i>parameter-6</i>]</b>
274<p><dd>
275Adds a physical volume to current scene, with optional clipping volume.<br>
276If physical-volume-name is "world" (the default), the top of the
277main geometry tree (material world) is added.  If "worlds", the
278top of all worlds - material world and parallel worlds, if any - are
279added.  Otherwise a search of all worlds is made, taking the first
280matching occurence only.  To see a representation of the geometry
281hierarchy of the worlds, try "/vis/drawTree [worlds]" or one of the
282driver/browser combinations that have the required functionality,
283e.g., HepRepFile/XML with the WIRED3/4 browser.<br>
284If clip-volume-type is specified, the subsequent parameters are used to
285to define a clipping volume.  For example,
286"vis/scene/add/volume ! ! ! -box km 0 1 0 1 0 1" will draw the world
287with the positive octant cut away.<br>
288If clip-volume-type is prepended with '-', the clip-volume is subtracted
289(cutaway). (This is the default if there is no prepended character.)
290If '*' is prepended, the intersection of the physical-volume and the
291clip-volume is made. (You can make a section/DCUT with a thin box, for
292example).<br>
293For "box", the parameters are xmin,xmax,ymin,ymax,zmin,zmax.
294Only "box" is programmed at present.<br>
295<p><dd>Available at all Geant4 states.
296<p><dd>Parameters<table border=1>
297<tr><td>physical-volume-name
298<td>type s
299<td>Omittable : default value = world
300<td><tr><td>copy-no
301<td>type i
302<td>Omittable : default value = -1
303<td><tr><td>depth-of-descent
304<td>type i
305<td>Omittable : default value = -1
306<td><tr><td>clip-volume-type
307<td>type s
308<td>Omittable : default value = none
309<td>Parameter candidates : none box -box *box
310<tr><td>parameter-unit
311<td>type s
312<td>Omittable : default value = m
313<td><tr><td>parameter-1
314<td>type d
315<td>Omittable : default value = 0
316<td><tr><td>parameter-2
317<td>type d
318<td>Omittable : default value = 0
319<td><tr><td>parameter-3
320<td>type d
321<td>Omittable : default value = 0
322<td><tr><td>parameter-4
323<td>type d
324<td>Omittable : default value = 0
325<td><tr><td>parameter-5
326<td>type d
327<td>Omittable : default value = 0
328<td><tr><td>parameter-6
329<td>type d
330<td>Omittable : default value = 0
331<td></table>
332</dl></body></html>
Note: See TracBrowser for help on using the repository browser.