musrsim/geant4/TaoLEMuSR/doc/commands/_vis_scene_add_.html
2008-03-20 09:23:20 +00:00

297 lines
9.4 KiB
HTML

<html><head><title>Commands in /vis/scene/add/</title></head>
<body bgcolor="#ffffff"><h2>/vis/scene/add/</h2><p>
Add model to current scene.<br>
<p><hr><p>
<h2>Sub-directories : </h2><dl>
</dl><p><hr><p>
<h2>Commands : </h2><dl>
<p><br><p><dt><b>axes [<i>x0</i>] [<i>y0</i>] [<i>z0</i>] [<i>length</i>] [<i>unit</i>]</b>
<p><dd>
Add axes.<br>
Draws axes at (x0, y0, z0) of given length.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>x0
<td>type d
<td>Omittable : default value = 0
<td><tr><td>y0
<td>type d
<td>Omittable : default value = 0
<td><tr><td>z0
<td>type d
<td>Omittable : default value = 0
<td><tr><td>length
<td>type d
<td>Omittable : default value = 1
<td><tr><td>unit
<td>type s
<td>Omittable : default value = m
<td></table>
<p><br><p><dt><b>ghosts [<i>particle</i>]</b>
<p><dd>
Adds ghost volumes (G4FlavoredParallelWorld) to the current scene.<br>
Selects by particle.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>particle
<td>type s
<td>Omittable : default value = all
<td></table>
<p><br><p><dt><b>hits</b>
<p><dd>
Adds hits to current scene.<br>
Hits are drawn at end of event when the scene in which
they are added is current.<br>
<p><dd>Available at all Geant4 states.
<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>
<p><dd>
Adds a logical volume to the current scene,<br>
Shows boolean components (if any), voxels (if any) and readout geometry
(if any). Note: voxels are not constructed until start of run -
"/run/beamOn".<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>logical-volume-name
<td>type s
<td><td><tr><td>depth-of-descent
<td>type i
<td>Omittable : default value = 1
<td><tr><td>booleans-flag
<td>type b
<td>Omittable : default value = 1
<td><tr><td>voxels-flag
<td>type b
<td>Omittable : default value = 1
<td><tr><td>readout-flag
<td>type b
<td>Omittable : default value = 1
<td></table>
<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>
<p><dd>
Adds a G4 logo to the current scene.<br>
The placement, if automatic, is similar to that of scale -
"help /vis/scene/add/scale" for more information.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>height
<td>type d
<td>Omittable : default value = 1
<td><tr><td>unit
<td>type s
<td>Omittable : default value = m
<td><tr><td>direction
<td>type s
<td>Omittable : default value = x
<td><tr><td>red
<td>type d
<td>Omittable : default value = 0
<td><tr><td>green
<td>type d
<td>Omittable : default value = 1
<td><tr><td>blue
<td>type d
<td>Omittable : default value = 0
<td><tr><td>auto|manual
<td>type s
<td>Omittable : default value = auto
<td><tr><td>xmid
<td>type d
<td>Omittable : default value = 0
<td><tr><td>ymid
<td>type d
<td>Omittable : default value = 0
<td><tr><td>zmid
<td>type d
<td>Omittable : default value = 0
<td><tr><td>unit
<td>type s
<td>Omittable : default value = m
<td></table>
<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>
<p><dd>
Adds an annotated scale line to the current scene.<br>
An annotated line in the specified direction with tick marks at the
end. If autoPlacing is true it is required to be centred at the
front, right, bottom corner of the world space, comfortably outside
the existing bounding box/sphere so that existing objects do not
obscure it. Otherwise it is required to be drawn with mid-point at
(xmid, ymid, zmid).
The auto placing algorithm might be:
x = xmin + (1 + comfort) * (xmax - xmin);
y = ymin - comfort * (ymax - ymin);
z = zmin + (1 + comfort) * (zmax - zmin);
if direction == x then (x - length,y,z) to (x,y,z);
if direction == y then (x,y,z) to (x,y + length,z);
if direction == z then (x,y,z - length) to (x,y,z);<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>length
<td>type d
<td>Omittable : default value = 1
<td><tr><td>unit
<td>type s
<td>Omittable : default value = m
<td><tr><td>direction
<td>type s
<td>Omittable : default value = x
<td><tr><td>red
<td>type d
<td>Omittable : default value = 1
<td><tr><td>green
<td>type d
<td>Omittable : default value = 0
<td><tr><td>blue
<td>type d
<td>Omittable : default value = 0
<td><tr><td>auto|manual
<td>type s
<td>Omittable : default value = auto
<td><tr><td>xmid
<td>type d
<td>Omittable : default value = 0
<td><tr><td>ymid
<td>type d
<td>Omittable : default value = 0
<td><tr><td>zmid
<td>type d
<td>Omittable : default value = 0
<td><tr><td>unit
<td>type s
<td>Omittable : default value = m
<td></table>
<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>
<p><dd>
Adds text to current scene.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>x
<td>type d
<td>Omittable : default value = 0
<td><tr><td>y
<td>type d
<td>Omittable : default value = 0
<td><tr><td>z
<td>type d
<td>Omittable : default value = 0
<td><tr><td>unit
<td>type s
<td>Omittable : default value = m
<td><tr><td>font_size
<td>type d
<td>Omittable : default value = 12
<td><tr><td>x_offset
<td>type d
<td>Omittable : default value = 0
<td><tr><td>y_offset
<td>type d
<td>Omittable : default value = 0
<td><tr><td>text
<td>type s
<td>Omittable : default value = Hello G4
<td></table>
<p><br><p><dt><b>trajectories [<i>drawing-mode</i>]</b>
<p><dd>
Adds trajectories to current scene.<br>
Causes trajectories, if any, to be drawn at the end of processiing an
event. The drawing mode is an integer that is passed to the
DrawTrajectory method. The default implementation in G4VTrajectory,
if drawing-mode &gt;= 0, draws the trajectory as a polyline (blue for
positive, red for negative, green for neutral) and, if
drawing-mode != 0, draws markers of screen size
std::abs(drawing-mode)/1000 pixels at each step and auxiliary point,
if any. So drawing-mode = 5000 is a good choice.
Enable storing with "/tracking/storeTrajectory 1".
See also "/vis/scene/endOfEventAction".<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>drawing-mode
<td>type i
<td>Omittable : default value = 0
<td></table>
<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>
<p><dd>
Add Vis User Action, if any, to current scene.<br>
Optional arguments define the extent of the callback drawing. You may
not need this if the extent has been defined in the original
SetUserAction or is defined by other components of the scene. But if
the user action is the only component of the scene, you will certainly
need to set the extent either in SetUserAction or here. A scene must
have an extent one way or another so that the viewer can calculate
how to point the camera.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>xmin
<td>type d
<td>Omittable : default value = 0
<td><tr><td>xmax
<td>type d
<td>Omittable : default value = 0
<td><tr><td>ymin
<td>type d
<td>Omittable : default value = 0
<td><tr><td>ymax
<td>type d
<td>Omittable : default value = 0
<td><tr><td>zmin
<td>type d
<td>Omittable : default value = 0
<td><tr><td>zmax
<td>type d
<td>Omittable : default value = 0
<td><tr><td>unit
<td>type s
<td>Omittable : default value = cm
<td></table>
<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>
<p><dd>
Adds a physical volume to current scene, with optional clipping volume.<br>
If physical-volume-name is "world" (the default), the top of the
tracking tree is used (GetNavigatorForTracking()-&gt;GetWorldVolume()).
Otherwise a search of the tracking tree is made, taking the first
matching occurence only. To see a representation of the geometry
hierarchy of the tracking tree, try "/vis/drawTree" or one of the
driver/browser combinations that have the required functionality,
e.g., HepRepFile/XML with the WIRED3/4 browser.<br>
If clip-volume-type is specified, the subsequent parameters are used to
to define a clipping volume. For example,
"vis/scene/add/volume ! ! ! box km 0 1 0 1 0 1" will draw the world
with the positive octant cut away.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>physical-volume-name
<td>type s
<td>Omittable : default value = world
<td><tr><td>copy-no
<td>type i
<td>Omittable : default value = -1
<td><tr><td>depth-of-descent
<td>type i
<td>Omittable : default value = -1
<td><tr><td>clip-volume-type
<td>type s
<td>Omittable : default value = none
<td><tr><td>parameter-unit
<td>type s
<td>Omittable : default value = m
<td><tr><td>parameter-1
<td>type d
<td>Omittable : default value = 0
<td><tr><td>parameter-2
<td>type d
<td>Omittable : default value = 0
<td><tr><td>parameter-3
<td>type d
<td>Omittable : default value = 0
<td><tr><td>parameter-4
<td>type d
<td>Omittable : default value = 0
<td><tr><td>parameter-5
<td>type d
<td>Omittable : default value = 0
<td><tr><td>parameter-6
<td>type d
<td>Omittable : default value = 0
<td></table>
</dl></body></html>