| 1 | <html><head><title>Commands in /vis/scene/add/</title></head> |
|---|
| 2 | <body bgcolor="#ffffff"><h2>/vis/scene/add/</h2><p> |
|---|
| 3 | Add 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> |
|---|
| 10 | Add axes.<br> |
|---|
| 11 | Draws 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>ghosts [<i>particle</i>]</b> |
|---|
| 31 | <p><dd> |
|---|
| 32 | Adds ghost volumes (G4FlavoredParallelWorld) to the current scene.<br> |
|---|
| 33 | Selects by particle.<br> |
|---|
| 34 | <p><dd>Available at all Geant4 states. |
|---|
| 35 | <p><dd>Parameters<table border=1> |
|---|
| 36 | <tr><td>particle |
|---|
| 37 | <td>type s |
|---|
| 38 | <td>Omittable : default value = all |
|---|
| 39 | <td></table> |
|---|
| 40 | <p><br><p><dt><b>hits</b> |
|---|
| 41 | <p><dd> |
|---|
| 42 | Adds hits to current scene.<br> |
|---|
| 43 | Hits are drawn at end of event when the scene in which |
|---|
| 44 | they are added is current.<br> |
|---|
| 45 | <p><dd>Available at all Geant4 states. |
|---|
| 46 | <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> |
|---|
| 47 | <p><dd> |
|---|
| 48 | Adds a logical volume to the current scene,<br> |
|---|
| 49 | Shows boolean components (if any), voxels (if any) and readout geometry |
|---|
| 50 | (if any). Note: voxels are not constructed until start of run - |
|---|
| 51 | "/run/beamOn".<br> |
|---|
| 52 | <p><dd>Available at all Geant4 states. |
|---|
| 53 | <p><dd>Parameters<table border=1> |
|---|
| 54 | <tr><td>logical-volume-name |
|---|
| 55 | <td>type s |
|---|
| 56 | <td><td><tr><td>depth-of-descent |
|---|
| 57 | <td>type i |
|---|
| 58 | <td>Omittable : default value = 1 |
|---|
| 59 | <td><tr><td>booleans-flag |
|---|
| 60 | <td>type b |
|---|
| 61 | <td>Omittable : default value = 1 |
|---|
| 62 | <td><tr><td>voxels-flag |
|---|
| 63 | <td>type b |
|---|
| 64 | <td>Omittable : default value = 1 |
|---|
| 65 | <td><tr><td>readout-flag |
|---|
| 66 | <td>type b |
|---|
| 67 | <td>Omittable : default value = 1 |
|---|
| 68 | <td></table> |
|---|
| 69 | <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> |
|---|
| 70 | <p><dd> |
|---|
| 71 | Adds a G4 logo to the current scene.<br> |
|---|
| 72 | The placement, if automatic, is similar to that of scale - |
|---|
| 73 | "help /vis/scene/add/scale" for more information.<br> |
|---|
| 74 | <p><dd>Available at all Geant4 states. |
|---|
| 75 | <p><dd>Parameters<table border=1> |
|---|
| 76 | <tr><td>height |
|---|
| 77 | <td>type d |
|---|
| 78 | <td>Omittable : default value = 1 |
|---|
| 79 | <td><tr><td>unit |
|---|
| 80 | <td>type s |
|---|
| 81 | <td>Omittable : default value = m |
|---|
| 82 | <td><tr><td>direction |
|---|
| 83 | <td>type s |
|---|
| 84 | <td>Omittable : default value = x |
|---|
| 85 | <td><tr><td>red |
|---|
| 86 | <td>type d |
|---|
| 87 | <td>Omittable : default value = 0 |
|---|
| 88 | <td><tr><td>green |
|---|
| 89 | <td>type d |
|---|
| 90 | <td>Omittable : default value = 1 |
|---|
| 91 | <td><tr><td>blue |
|---|
| 92 | <td>type d |
|---|
| 93 | <td>Omittable : default value = 0 |
|---|
| 94 | <td><tr><td>auto|manual |
|---|
| 95 | <td>type s |
|---|
| 96 | <td>Omittable : default value = auto |
|---|
| 97 | <td><tr><td>xmid |
|---|
| 98 | <td>type d |
|---|
| 99 | <td>Omittable : default value = 0 |
|---|
| 100 | <td><tr><td>ymid |
|---|
| 101 | <td>type d |
|---|
| 102 | <td>Omittable : default value = 0 |
|---|
| 103 | <td><tr><td>zmid |
|---|
| 104 | <td>type d |
|---|
| 105 | <td>Omittable : default value = 0 |
|---|
| 106 | <td><tr><td>unit |
|---|
| 107 | <td>type s |
|---|
| 108 | <td>Omittable : default value = m |
|---|
| 109 | <td></table> |
|---|
| 110 | <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> |
|---|
| 111 | <p><dd> |
|---|
| 112 | Adds an annotated scale line to the current scene.<br> |
|---|
| 113 | An annotated line in the specified direction with tick marks at the |
|---|
| 114 | end. If autoPlacing is true it is required to be centred at the |
|---|
| 115 | front, right, bottom corner of the world space, comfortably outside |
|---|
| 116 | the existing bounding box/sphere so that existing objects do not |
|---|
| 117 | obscure it. Otherwise it is required to be drawn with mid-point at |
|---|
| 118 | (xmid, ymid, zmid). |
|---|
| 119 | |
|---|
| 120 | The auto placing algorithm might be: |
|---|
| 121 | x = xmin + (1 + comfort) * (xmax - xmin); |
|---|
| 122 | y = ymin - comfort * (ymax - ymin); |
|---|
| 123 | z = zmin + (1 + comfort) * (zmax - zmin); |
|---|
| 124 | if direction == x then (x - length,y,z) to (x,y,z); |
|---|
| 125 | if direction == y then (x,y,z) to (x,y + length,z); |
|---|
| 126 | if direction == z then (x,y,z - length) to (x,y,z);<br> |
|---|
| 127 | <p><dd>Available at all Geant4 states. |
|---|
| 128 | <p><dd>Parameters<table border=1> |
|---|
| 129 | <tr><td>length |
|---|
| 130 | <td>type d |
|---|
| 131 | <td>Omittable : default value = 1 |
|---|
| 132 | <td><tr><td>unit |
|---|
| 133 | <td>type s |
|---|
| 134 | <td>Omittable : default value = m |
|---|
| 135 | <td><tr><td>direction |
|---|
| 136 | <td>type s |
|---|
| 137 | <td>Omittable : default value = x |
|---|
| 138 | <td><tr><td>red |
|---|
| 139 | <td>type d |
|---|
| 140 | <td>Omittable : default value = 1 |
|---|
| 141 | <td><tr><td>green |
|---|
| 142 | <td>type d |
|---|
| 143 | <td>Omittable : default value = 0 |
|---|
| 144 | <td><tr><td>blue |
|---|
| 145 | <td>type d |
|---|
| 146 | <td>Omittable : default value = 0 |
|---|
| 147 | <td><tr><td>auto|manual |
|---|
| 148 | <td>type s |
|---|
| 149 | <td>Omittable : default value = auto |
|---|
| 150 | <td><tr><td>xmid |
|---|
| 151 | <td>type d |
|---|
| 152 | <td>Omittable : default value = 0 |
|---|
| 153 | <td><tr><td>ymid |
|---|
| 154 | <td>type d |
|---|
| 155 | <td>Omittable : default value = 0 |
|---|
| 156 | <td><tr><td>zmid |
|---|
| 157 | <td>type d |
|---|
| 158 | <td>Omittable : default value = 0 |
|---|
| 159 | <td><tr><td>unit |
|---|
| 160 | <td>type s |
|---|
| 161 | <td>Omittable : default value = m |
|---|
| 162 | <td></table> |
|---|
| 163 | <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> |
|---|
| 164 | <p><dd> |
|---|
| 165 | Adds text to current scene.<br> |
|---|
| 166 | <p><dd>Available at all Geant4 states. |
|---|
| 167 | <p><dd>Parameters<table border=1> |
|---|
| 168 | <tr><td>x |
|---|
| 169 | <td>type d |
|---|
| 170 | <td>Omittable : default value = 0 |
|---|
| 171 | <td><tr><td>y |
|---|
| 172 | <td>type d |
|---|
| 173 | <td>Omittable : default value = 0 |
|---|
| 174 | <td><tr><td>z |
|---|
| 175 | <td>type d |
|---|
| 176 | <td>Omittable : default value = 0 |
|---|
| 177 | <td><tr><td>unit |
|---|
| 178 | <td>type s |
|---|
| 179 | <td>Omittable : default value = m |
|---|
| 180 | <td><tr><td>font_size |
|---|
| 181 | <td>type d |
|---|
| 182 | <td>Omittable : default value = 12 |
|---|
| 183 | <td><tr><td>x_offset |
|---|
| 184 | <td>type d |
|---|
| 185 | <td>Omittable : default value = 0 |
|---|
| 186 | <td><tr><td>y_offset |
|---|
| 187 | <td>type d |
|---|
| 188 | <td>Omittable : default value = 0 |
|---|
| 189 | <td><tr><td>text |
|---|
| 190 | <td>type s |
|---|
| 191 | <td>Omittable : default value = Hello G4 |
|---|
| 192 | <td></table> |
|---|
| 193 | <p><br><p><dt><b>trajectories [<i>drawing-mode</i>]</b> |
|---|
| 194 | <p><dd> |
|---|
| 195 | Adds trajectories to current scene.<br> |
|---|
| 196 | Causes trajectories, if any, to be drawn at the end of processiing an |
|---|
| 197 | event. The drawing mode is an integer that is passed to the |
|---|
| 198 | DrawTrajectory method. The default implementation in G4VTrajectory, |
|---|
| 199 | if drawing-mode >= 0, draws the trajectory as a polyline (blue for |
|---|
| 200 | positive, red for negative, green for neutral) and, if |
|---|
| 201 | drawing-mode != 0, draws markers of screen size |
|---|
| 202 | std::abs(drawing-mode)/1000 pixels at each step and auxiliary point, |
|---|
| 203 | if any. So drawing-mode = 5000 is a good choice. |
|---|
| 204 | Enable storing with "/tracking/storeTrajectory 1". |
|---|
| 205 | See also "/vis/scene/endOfEventAction".<br> |
|---|
| 206 | <p><dd>Available at all Geant4 states. |
|---|
| 207 | <p><dd>Parameters<table border=1> |
|---|
| 208 | <tr><td>drawing-mode |
|---|
| 209 | <td>type i |
|---|
| 210 | <td>Omittable : default value = 0 |
|---|
| 211 | <td></table> |
|---|
| 212 | <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> |
|---|
| 213 | <p><dd> |
|---|
| 214 | Add Vis User Action, if any, to current scene.<br> |
|---|
| 215 | Optional arguments define the extent of the callback drawing. You may |
|---|
| 216 | not need this if the extent has been defined in the original |
|---|
| 217 | SetUserAction or is defined by other components of the scene. But if |
|---|
| 218 | the user action is the only component of the scene, you will certainly |
|---|
| 219 | need to set the extent either in SetUserAction or here. A scene must |
|---|
| 220 | have an extent one way or another so that the viewer can calculate |
|---|
| 221 | how to point the camera.<br> |
|---|
| 222 | <p><dd>Available at all Geant4 states. |
|---|
| 223 | <p><dd>Parameters<table border=1> |
|---|
| 224 | <tr><td>xmin |
|---|
| 225 | <td>type d |
|---|
| 226 | <td>Omittable : default value = 0 |
|---|
| 227 | <td><tr><td>xmax |
|---|
| 228 | <td>type d |
|---|
| 229 | <td>Omittable : default value = 0 |
|---|
| 230 | <td><tr><td>ymin |
|---|
| 231 | <td>type d |
|---|
| 232 | <td>Omittable : default value = 0 |
|---|
| 233 | <td><tr><td>ymax |
|---|
| 234 | <td>type d |
|---|
| 235 | <td>Omittable : default value = 0 |
|---|
| 236 | <td><tr><td>zmin |
|---|
| 237 | <td>type d |
|---|
| 238 | <td>Omittable : default value = 0 |
|---|
| 239 | <td><tr><td>zmax |
|---|
| 240 | <td>type d |
|---|
| 241 | <td>Omittable : default value = 0 |
|---|
| 242 | <td><tr><td>unit |
|---|
| 243 | <td>type s |
|---|
| 244 | <td>Omittable : default value = cm |
|---|
| 245 | <td></table> |
|---|
| 246 | <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> |
|---|
| 247 | <p><dd> |
|---|
| 248 | Adds a physical volume to current scene, with optional clipping volume.<br> |
|---|
| 249 | If physical-volume-name is "world" (the default), the top of the |
|---|
| 250 | tracking tree is used (GetNavigatorForTracking()->GetWorldVolume()). |
|---|
| 251 | Otherwise a search of the tracking tree is made, taking the first |
|---|
| 252 | matching occurence only. To see a representation of the geometry |
|---|
| 253 | hierarchy of the tracking tree, try "/vis/drawTree" or one of the |
|---|
| 254 | driver/browser combinations that have the required functionality, |
|---|
| 255 | e.g., HepRepFile/XML with the WIRED3/4 browser.<br> |
|---|
| 256 | If clip-volume-type is specified, the subsequent parameters are used to |
|---|
| 257 | to define a clipping volume. For example, |
|---|
| 258 | "vis/scene/add/volume ! ! ! box km 0 1 0 1 0 1" will draw the world |
|---|
| 259 | with the positive octant cut away.<br> |
|---|
| 260 | <p><dd>Available at all Geant4 states. |
|---|
| 261 | <p><dd>Parameters<table border=1> |
|---|
| 262 | <tr><td>physical-volume-name |
|---|
| 263 | <td>type s |
|---|
| 264 | <td>Omittable : default value = world |
|---|
| 265 | <td><tr><td>copy-no |
|---|
| 266 | <td>type i |
|---|
| 267 | <td>Omittable : default value = -1 |
|---|
| 268 | <td><tr><td>depth-of-descent |
|---|
| 269 | <td>type i |
|---|
| 270 | <td>Omittable : default value = -1 |
|---|
| 271 | <td><tr><td>clip-volume-type |
|---|
| 272 | <td>type s |
|---|
| 273 | <td>Omittable : default value = none |
|---|
| 274 | <td><tr><td>parameter-unit |
|---|
| 275 | <td>type s |
|---|
| 276 | <td>Omittable : default value = m |
|---|
| 277 | <td><tr><td>parameter-1 |
|---|
| 278 | <td>type d |
|---|
| 279 | <td>Omittable : default value = 0 |
|---|
| 280 | <td><tr><td>parameter-2 |
|---|
| 281 | <td>type d |
|---|
| 282 | <td>Omittable : default value = 0 |
|---|
| 283 | <td><tr><td>parameter-3 |
|---|
| 284 | <td>type d |
|---|
| 285 | <td>Omittable : default value = 0 |
|---|
| 286 | <td><tr><td>parameter-4 |
|---|
| 287 | <td>type d |
|---|
| 288 | <td>Omittable : default value = 0 |
|---|
| 289 | <td><tr><td>parameter-5 |
|---|
| 290 | <td>type d |
|---|
| 291 | <td>Omittable : default value = 0 |
|---|
| 292 | <td><tr><td>parameter-6 |
|---|
| 293 | <td>type d |
|---|
| 294 | <td>Omittable : default value = 0 |
|---|
| 295 | <td></table> |
|---|
| 296 | </dl></body></html> |
|---|
