source: trunk/documents/UserDoc/DocBookUsersGuides/IntroductionToGeant4/xml/AllResources/.ls/vis.txt @ 904

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

ajout de la doc

File size: 51.9 KB
Line 
1/control/manual /vis
2Command directory path : /vis/
3
4
5Guidance :
6Visualization commands.
7
8 Sub-directories :
9   /vis/ASCIITree/   Commands for ASCIITree control.
10   /vis/GAGTree/   Commands for GAGTree control.
11   /vis/heprep/   Commands for HepRepXML driver (not for HepRepFile driver).
12   /vis/rayTracer/   RayTracer commands.
13   /vis/modeling/   Modeling commands.
14   /vis/scene/   Operations on Geant4 scenes.
15   /vis/sceneHandler/   Operations on Geant4 scene handlers.
16   /vis/viewer/   Operations on Geant4 viewers.
17   /vis/oglxm-viewer-0/   G4OpenGLXmViewer "viewer-0" commands.
18 Commands :
19   enable * Enables/disables visualization system.
20   disable * Disables visualization system.
21   verbose * Simple graded message scheme - digit or string (1st character defines):
22   drawTree * (DTREE) Creates a scene consisting of this physical volume and
23  produces a representation of the geometry hieracrhy.
24   drawView * Draw view from this angle, etc.
25   drawVolume * Creates a scene consisting of this physical volume and asks the
26  current viewer to draw it.
27   open * Creates a scene handler ready for drawing.
28   specify * Draws logical volume with Boolean components, voxels and readout geometry.
29
30
31Command /vis/enable
32Guidance :
33Enables/disables visualization system.
34
35Parameter : enabled
36 Parameter type  : b
37 Omittable       : True
38 Default value   : 1
39
40
41
42Command /vis/disable
43Guidance :
44Disables visualization system.
45
46
47
48Command /vis/verbose
49Guidance :
50Simple graded message scheme - digit or string (1st character defines):
51  0) quiet,         // Nothing is printed.
52  1) startup,       // Startup and endup messages are printed...
53  2) errors,        // ...and errors...
54  3) warnings,      // ...and warnings...
55  4) confirmations, // ...and confirming messages...
56  5) parameters,    // ...and parameters of scenes and views...
57  6) all            // ...and everything available.
58
59Parameter : verbosity
60 Parameter type  : s
61 Omittable       : True
62 Default value   : warnings
63
64
65
66Command /vis/drawTree
67Guidance :
68(DTREE) Creates a scene consisting of this physical volume and
69  produces a representation of the geometry hieracrhy.
70The scene becomes current.
71
72Parameter : physical-volume-name
73 Parameter type  : s
74 Omittable       : True
75 Default value   : world
76
77Parameter : system
78 Parameter type  : s
79 Omittable       : True
80 Default value   : ATree
81
82
83
84Command /vis/drawView
85Guidance :
86Draw view from this angle, etc.
87
88Parameter : theta-degrees
89 Parameter type  : d
90 Omittable       : True
91 Default value   : 0
92
93Parameter : phi-degrees
94 Parameter type  : d
95 Omittable       : True
96 Default value   : 0
97
98Parameter : pan-right
99 Parameter type  : d
100 Omittable       : True
101 Default value   : 0
102
103Parameter : pan-up
104 Parameter type  : d
105 Omittable       : True
106 Default value   : 0
107
108Parameter : pan-unit
109 Parameter type  : s
110 Omittable       : True
111 Default value   : cm
112
113Parameter : zoom-factor
114 Parameter type  : d
115 Omittable       : True
116 Default value   : 1
117
118Parameter : dolly
119 Parameter type  : d
120 Omittable       : True
121 Default value   : 0
122
123Parameter : dolly-unit
124 Parameter type  : s
125 Omittable       : True
126 Default value   : cm
127
128
129
130Command /vis/drawVolume
131Guidance :
132Creates a scene consisting of this physical volume and asks the
133  current viewer to draw it.
134The scene becomes current.
135
136Parameter : physical-volume-name
137 Parameter type  : s
138 Omittable       : True
139 Default value   : world
140
141
142
143Command /vis/open
144Guidance :
145Creates a scene handler ready for drawing.
146The scene handler becomes current (the name is auto-generated).
147
148Parameter : graphics-system-name
149 Parameter type  : s
150 Omittable       : False
151 Candidates      : XXX ATree DAWNFILE GAGTree HepRepXML HepRepFile VRML1FILE VRML2FILE DAWN OGLIX OGLSX OGLIXm OGLSXm OIX RayTracerX VRML1 VRML2
152
153Parameter : window-size-hint
154integer (pixels) for square window placed by window manager or X-Windows-type geometry string, e.g. 600x600-100+100
155 Parameter type  : s
156 Omittable       : True
157 Default value   : 600
158
159
160
161Command /vis/specify
162Guidance :
163Draws logical volume with Boolean components, voxels and readout geometry.
164Creates a scene consisting of this logical volume and asks the
165  current viewer to draw it to the specified depth of descent
166  showing boolean components (if any), voxels (if any)
167  and readout geometry (if any), under control of the appropriate flag.
168Note: voxels are not constructed until start of run - /run/beamOn.
169The scene becomes current.
170
171Parameter : logical-volume-name
172 Parameter type  : s
173 Omittable       : False
174
175Parameter : depth-of-descent
176 Parameter type  : i
177 Omittable       : True
178 Default value   : 1
179
180Parameter : booleans-flag
181 Parameter type  : b
182 Omittable       : True
183 Default value   : 1
184
185Parameter : voxels-flag
186 Parameter type  : b
187 Omittable       : True
188 Default value   : 1
189
190Parameter : readout-flag
191 Parameter type  : b
192 Omittable       : True
193 Default value   : 1
194
195Command directory path : /vis/ASCIITree/
196
197
198Guidance :
199Commands for ASCIITree control.
200
201 Sub-directories :
202   /vis/ASCIITree/set/   Settings for ASCIITree control.
203 Commands :
204   verbose *   <  10: - does not print daughters of repeated placements, does not repeat replicas.
205
206
207Command /vis/ASCIITree/verbose
208Guidance :
209  <  10: - does not print daughters of repeated placements, does not repeat replicas.
210  >= 10: prints all physical volumes.
211The level of detail is given by verbosity%10:
212for each volume:
213  >=  0: physical volume name.
214  >=  1: logical volume name (and names of sensitive detector and readout geometry, if any).
215  >=  2: solid name and type.
216  >=  3: volume and density.
217  >=  5: daughter-subtracted volume and mass.
218and in the summary at the end of printing:
219  >=  4: daughter-included mass of top physical volume(s) in scene to depth specified.
220Note: by default, culling is switched off so all volumes are seen.
221Note: the mass calculation takes into account daughters, which can be time consuming.  If you want the mass of a particular subtree to a particular depth:
222  /vis/open ATree
223  /vis/ASCIITree/verbose 14
224  /vis/scene/create
225  /vis/scene/add/volume <subtree-physical-volume> ! <depth>
226  /vis/sceneHandler/attach
227  /vis/viewer/flush
228
229Parameter : verbosity
230 Parameter type  : i
231 Omittable       : True
232 Default value   : 0
233
234Command directory path : /vis/ASCIITree/set/
235
236
237Guidance :
238Settings for ASCIITree control.
239
240 Sub-directories :
241 Commands :
242   outFile * Set name of output file.
243
244
245Command /vis/ASCIITree/set/outFile
246Guidance :
247Set name of output file.
248
249Parameter : out-filename
250 Parameter type  : s
251 Omittable       : True
252 Default value   : G4cout
253
254Command directory path : /vis/GAGTree/
255
256
257Guidance :
258Commands for GAGTree control.
259
260 Sub-directories :
261 Commands :
262   verbose * /vis/GAGTree/verbose [<verbosity>]
263
264
265Command /vis/GAGTree/verbose
266Guidance :
267/vis/GAGTree/verbose [<verbosity>]
2680 (default) mimimum - 10 maximum printing.
269
270Parameter : verbosity
271 Parameter type  : i
272 Omittable       : True
273 Default value   : taken from the current value
274
275Command directory path : /vis/heprep/
276
277
278Guidance :
279Commands for HepRepXML driver.
280Note: To instead control the HepRepFile driver, use environment variables as explained in the visualization
281section of the User Guide for Application Developers.
282
283 Sub-directories :
284 Commands :
285   setEventNumberSuffix * Write separate event files, appended with given suffix.
286   appendGeometry * Appends copy of geometry to every event.
287   addPointAttributes * Adds point attributes to the points of trajectories.
288   useSolids * Use HepRep Solids, rather than Geant4 Primitives.
289
290
291Command /vis/heprep/setEventNumberSuffix
292Guidance :
293Write separate event files, appended with given suffix.
294Define the suffix with a pattern such as '-0000'.
295
296Parameter : suffix
297 Parameter type  : s
298 Omittable       : False
299
300
301
302Command /vis/heprep/appendGeometry
303Guidance :
304Appends copy of geometry to every event.
305
306Parameter : flag
307 Parameter type  : b
308 Omittable       : False
309 Default value   : 1
310
311
312
313Command /vis/heprep/addPointAttributes
314Guidance :
315Adds point attributes to the points of trajectories.
316
317Parameter : flag
318 Parameter type  : b
319 Omittable       : False
320 Default value   : 0
321
322
323
324Command /vis/heprep/useSolids
325Guidance :
326Use HepRep Solids, rather than Geant4 Primitives.
327
328Parameter : flag
329 Parameter type  : b
330 Omittable       : False
331 Default value   : 1
332
333Command directory path : /vis/rayTracer/
334
335
336Guidance :
337RayTracer commands.
338
339 Sub-directories :
340 Commands :
341   trace * Start the ray tracing.
342   column * Define the number of horizontal pixels.
343   row * Define the number of virtical pixels.
344   target * Define the center position of the target.
345   eyePosition * Define the eye position.
346   lightDirection * Define the direction of illumination light.
347   span * Define the angle per 100 pixels.
348   headAngle * Define the head direction.
349   attenuation * Define the attenuation length for transparent material.
350   distortion * Distortion effect of the fish eye lens.
351   ignoreTransparency * Ignore transparency even if the alpha of G4Colour < 1.
352   backgroundColour * Set background colour: red green blue: range 0.->1.
353
354
355Command /vis/rayTracer/trace
356Guidance :
357Start the ray tracing.
358Define the name of output JPEG file.
359
360Parameter : fileName
361 Parameter type  : s
362 Omittable       : True
363 Default value   : g4RayTracer.jpeg
364
365
366
367Command /vis/rayTracer/column
368Guidance :
369Define the number of horizontal pixels.
370 Range of parameters : nPixel > 0
371
372Parameter : nPixel
373 Parameter type  : i
374 Omittable       : False
375
376
377
378Command /vis/rayTracer/row
379Guidance :
380Define the number of virtical pixels.
381 Range of parameters : nPixel > 0
382
383Parameter : nPixel
384 Parameter type  : i
385 Omittable       : False
386
387
388
389Command /vis/rayTracer/target
390Guidance :
391Define the center position of the target.
392
393Parameter : X
394 Parameter type  : d
395 Omittable       : True
396 Default value   : 0
397
398Parameter : Y
399 Parameter type  : d
400 Omittable       : True
401 Default value   : 0
402
403Parameter : Z
404 Parameter type  : d
405 Omittable       : True
406 Default value   : 0
407
408Parameter : Unit
409 Parameter type  : s
410 Omittable       : True
411 Default value   : m
412 Candidates      : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
413
414
415
416Command /vis/rayTracer/eyePosition
417Guidance :
418Define the eye position.
419Eye direction is calsurated from (target - eyePosition).
420
421Parameter : X
422 Parameter type  : d
423 Omittable       : True
424 Default value   : 0
425
426Parameter : Y
427 Parameter type  : d
428 Omittable       : True
429 Default value   : 0
430
431Parameter : Z
432 Parameter type  : d
433 Omittable       : True
434 Default value   : 0
435
436Parameter : Unit
437 Parameter type  : s
438 Omittable       : True
439 Default value   : m
440 Candidates      : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
441
442
443
444Command /vis/rayTracer/lightDirection
445Guidance :
446Define the direction of illumination light.
447The vector needs not to be a unit vector, but it must not be a zero vector.
448 Range of parameters : Px != 0 || Py != 0 || Pz != 0
449
450Parameter : Px
451 Parameter type  : d
452 Omittable       : True
453 Default value   : 0.1
454
455Parameter : Py
456 Parameter type  : d
457 Omittable       : True
458 Default value   : 0.2
459
460Parameter : Pz
461 Parameter type  : d
462 Omittable       : True
463 Default value   : 0.3
464
465
466
467Command /vis/rayTracer/span
468Guidance :
469Define the angle per 100 pixels.
470 Range of parameters : span>0.
471
472Parameter : span
473 Parameter type  : d
474 Omittable       : True
475 Default value   : 50
476
477Parameter : Unit
478 Parameter type  : s
479 Omittable       : True
480 Default value   : deg
481 Candidates      : rad mrad sr deg radian milliradian steradian degree
482
483
484
485Command /vis/rayTracer/headAngle
486Guidance :
487Define the head direction.
488 Range of parameters : headAngle>=0. && headAngle<360.
489
490Parameter : headAngle
491 Parameter type  : d
492 Omittable       : True
493 Default value   : 270
494
495Parameter : Unit
496 Parameter type  : s
497 Omittable       : True
498 Default value   : deg
499 Candidates      : rad mrad sr deg radian milliradian steradian degree
500
501
502
503Command /vis/rayTracer/attenuation
504Guidance :
505Define the attenuation length for transparent material.
506Note that this value is independent to the attenuation length for the optical photon processes.
507 Range of parameters : Length > 0.
508
509Parameter : Length
510 Parameter type  : d
511 Omittable       : True
512 Default value   : 1
513
514Parameter : Unit
515 Parameter type  : s
516 Omittable       : True
517 Default value   : m
518 Candidates      : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
519
520
521
522Command /vis/rayTracer/distortion
523Guidance :
524Distortion effect of the fish eye lens.
525
526Parameter : flag
527 Parameter type  : b
528 Omittable       : True
529 Default value   : 0
530
531
532
533Command /vis/rayTracer/ignoreTransparency
534Guidance :
535Ignore transparency even if the alpha of G4Colour < 1.
536
537Parameter : flag
538 Parameter type  : b
539 Omittable       : True
540 Default value   : 0
541
542
543
544Command /vis/rayTracer/backgroundColour
545Guidance :
546Set background colour: red green blue: range 0.->1.
547E.g: /vis/rayTracer/backgroundColour 0 0 0
548
549Parameter : red
550 Parameter type  : d
551 Omittable       : True
552 Default value   : 1
553
554Parameter : green
555 Parameter type  : d
556 Omittable       : True
557 Default value   : 1
558
559Parameter : blue
560 Parameter type  : d
561 Omittable       : True
562 Default value   : 1
563
564Command directory path : /vis/modeling/
565
566
567Guidance :
568Modeling commands.
569
570 Sub-directories :
571   /vis/modeling/trajectories/   Trajectory model commands.
572 Commands :
573Command directory path : /vis/modeling/trajectories/
574
575
576Guidance :
577Trajectory model commands.
578
579 Sub-directories :
580   /vis/modeling/trajectories/create/   Create trajectory models and messengers.
581   /vis/modeling/trajectories/drawByCharge-0/   Commands for drawByCharge-0 model.
582   /vis/modeling/trajectories/drawByParticleID-0/   Commands for drawByParticleID-0 model.
583 Commands :
584   list * List objects registered with list manager
585   select * Select created object
586
587
588Command /vis/modeling/trajectories/list
589Guidance :
590List objects registered with list manager
591
592Parameter : name
593 Parameter type  : s
594 Omittable       : True
595
596
597
598Command /vis/modeling/trajectories/select
599Guidance :
600Select created object
601
602Parameter : name
603 Parameter type  : s
604 Omittable       : False
605
606Command directory path : /vis/modeling/trajectories/create/
607
608
609Guidance :
610Create trajectory models and messengers.
611
612 Sub-directories :
613 Commands :
614   drawByCharge * Create a drawByCharge model and associated messengers.
615   drawByParticleID * Create a drawByParticleID model and associated messengers.
616
617
618Command /vis/modeling/trajectories/create/drawByCharge
619Guidance :
620Create a drawByCharge model and associated messengers.
621Generated model becomes current.
622
623Parameter : model-name
624 Parameter type  : s
625 Omittable       : True
626
627
628
629Command /vis/modeling/trajectories/create/drawByParticleID
630Guidance :
631Create a drawByParticleID model and associated messengers.
632Generated model becomes current.
633
634Parameter : model-name
635 Parameter type  : s
636 Omittable       : True
637
638Command directory path : /vis/modeling/trajectories/drawByCharge-0/
639
640
641Guidance :
642Commands for drawByCharge-0 model.
643
644 Sub-directories :
645 Commands :
646   set * Set trajectory colour through a string.
647   setRGBA * Set trajectory colour through red, green, blue and alpha components.
648
649
650Command /vis/modeling/trajectories/drawByCharge-0/set
651Guidance :
652Set trajectory colour through a string.
653Two inputs are expected, for example
654/vis/modeling/trajectories/drawByCharge-0/set -1 red
655
656Parameter : parameters
657 Parameter type  : s
658 Omittable       : False
659
660
661
662Command /vis/modeling/trajectories/drawByCharge-0/setRGBA
663Guidance :
664Set trajectory colour through red, green, blue and alpha components.
665Five inputs are expected, for example
666/vis/modeling/trajectories/drawByCharge-0/setRGBA -1 1 1 1 1
667
668Parameter : parameters
669 Parameter type  : s
670 Omittable       : False
671
672Command directory path : /vis/modeling/trajectories/drawByParticleID-0/
673
674
675Guidance :
676Commands for drawByParticleID-0 model.
677
678 Sub-directories :
679 Commands :
680   set * Set trajectory colour through a string.
681   setRGBA * Set trajectory colour through red, green, blue and alpha components.
682   setDefault * Set default trajectory colour through a string.
683   setDefaultRGBA * Set default trajectory colour through red, green, blue and alpha components.
684
685
686Command /vis/modeling/trajectories/drawByParticleID-0/set
687Guidance :
688Set trajectory colour through a string.
689Two inputs are expected, for example
690/vis/modeling/trajectories/drawByParticleID-0/set gamma red
691
692Parameter : parameters
693 Parameter type  : s
694 Omittable       : False
695
696
697
698Command /vis/modeling/trajectories/drawByParticleID-0/setRGBA
699Guidance :
700Set trajectory colour through red, green, blue and alpha components.
701Five inputs are expected, for example
702/vis/modeling/trajectories/drawByParticleID-0/setRGBA gamma 1 1 1 1
703
704Parameter : parameters
705 Parameter type  : s
706 Omittable       : False
707
708
709
710Command /vis/modeling/trajectories/drawByParticleID-0/setDefault
711Guidance :
712Set default trajectory colour through a string.
713One input is expected, for example
714/vis/modeling/trajectories/drawByParticleID-0/setDefault red
715
716Parameter : parameters
717 Parameter type  : s
718 Omittable       : False
719
720
721
722Command /vis/modeling/trajectories/drawByParticleID-0/setDefaultRGBA
723Guidance :
724Set default trajectory colour through red, green, blue and alpha components.
725Four inputs are expected, for example
726/vis/modeling/trajectories/drawByParticleID-0/setDefaultRGBA 1 1 1 1
727
728Parameter : parameters
729 Parameter type  : s
730 Omittable       : False
731
732Command directory path : /vis/scene/
733
734
735Guidance :
736Operations on Geant4 scenes.
737
738 Sub-directories :
739   /vis/scene/add/   Add model to current scene.
740 Commands :
741   create * Creates an empty scene.
742   endOfEventAction * Accumulate or refresh the viewer for each new event.
743   endOfRunAction * Accumulate or refresh the viewer for each new run.
744   list * Lists scene(s).
745   notifyHandlers * Notifies scene handlers and forces re-rendering.
746   select * Selects a scene
747
748
749Command /vis/scene/create
750Guidance :
751Creates an empty scene.
752Invents a name if not supplied.  This scene becomes current.
753
754Parameter : scene-name
755 Parameter type  : s
756 Omittable       : True
757
758
759
760Command /vis/scene/endOfEventAction
761Guidance :
762Accumulate or refresh the viewer for each new event.
763"accumulate": viewer accumulates hits, etc., event by event, or
764"refresh": viewer shows them at end of event or, for direct-screen
765  viewers, refreshes the screen just before drawing the next event.
766The detector remains or is redrawn.
767
768Parameter : action
769 Parameter type  : s
770 Omittable       : True
771 Default value   : refresh
772 Candidates      : accumulate refresh
773
774
775
776Command /vis/scene/endOfRunAction
777Guidance :
778Accumulate or refresh the viewer for each new run.
779"accumulate": viewer accumulates hits, etc., run by run, or
780"refresh": viewer shows them at end of run or, for direct-screen
781  viewers, refreshes the screen just before drawing the first
782  event of the next run.
783The detector remains or is redrawn.
784
785Parameter : action
786 Parameter type  : s
787 Omittable       : True
788 Default value   : refresh
789 Candidates      : accumulate refresh
790
791
792
793Command /vis/scene/list
794Guidance :
795Lists scene(s).
796"help /vis/verbose" for definition of verbosity.
797
798Parameter : scene-name
799 Parameter type  : s
800 Omittable       : True
801 Default value   : all
802
803Parameter : verbosity
804 Parameter type  : s
805 Omittable       : True
806 Default value   : 0
807
808
809
810Command /vis/scene/notifyHandlers
811Guidance :
812Notifies scene handlers and forces re-rendering.
813Notifies the handler(s) of the specified scene and forces a
814reconstruction of any graphical databases.
815Clears and refreshes all viewers of current scene.
816  The default action "refresh" does not issue "update" (see
817    /vis/viewer/update).
818If "flush" is specified, it issues an "update" as well as
819  "refresh" - "update" and initiates post-processing
820  for graphics systems which need it.
821The default for <scene-name> is the current scene name.
822This command does not change current scene, scene handler or viewer.
823
824Parameter : scene-name
825 Parameter type  : s
826 Omittable       : True
827 Default value   : taken from the current value
828
829Parameter : refresh-flush
830 Parameter type  : s
831 Omittable       : True
832 Default value   : refresh
833 Candidates      : refresh flush
834
835
836
837Command /vis/scene/select
838Guidance :
839Selects a scene
840Makes the scene current.  "/vis/scene/list" to see
841 possible scene names.
842
843Parameter : scene-name
844 Parameter type  : s
845 Omittable       : False
846
847Command directory path : /vis/scene/add/
848
849
850Guidance :
851Add model to current scene.
852
853 Sub-directories :
854 Commands :
855   axes * Add axes.
856   ghosts * Adds ghost volumes (G4FlavoredParallelWorld) to the current scene.
857   hits * Adds hits to current scene.
858   logicalVolume * Adds a logical volume to the current scene,
859   logo * Adds a G4 logo to the current scene.
860   scale * Adds an annotated scale line to the current scene.
861   text * Adds text to current scene.
862   trajectories * Adds trajectories to current scene.
863   userAction * Add Vis User Action, if any, to current scene.
864   volume * Adds a physical volume to current scene, with optional clipping volume.
865
866
867Command /vis/scene/add/axes
868Guidance :
869Add axes.
870Draws axes at (x0, y0, z0) of given length.
871
872Parameter : x0
873 Parameter type  : d
874 Omittable       : True
875 Default value   : 0
876
877Parameter : y0
878 Parameter type  : d
879 Omittable       : True
880 Default value   : 0
881
882Parameter : z0
883 Parameter type  : d
884 Omittable       : True
885 Default value   : 0
886
887Parameter : length
888 Parameter type  : d
889 Omittable       : True
890 Default value   : 1
891
892Parameter : unit
893 Parameter type  : s
894 Omittable       : True
895 Default value   : m
896
897
898
899Command /vis/scene/add/ghosts
900Guidance :
901Adds ghost volumes (G4FlavoredParallelWorld) to the current scene.
902Selects by particle.
903
904Parameter : particle
905 Parameter type  : s
906 Omittable       : True
907 Default value   : all
908
909
910
911Command /vis/scene/add/hits
912Guidance :
913Adds hits to current scene.
914Hits are drawn at end of event when the scene in which
915they are added is current.
916
917
918
919Command /vis/scene/add/logicalVolume
920Guidance :
921Adds a logical volume to the current scene,
922Shows boolean components (if any), voxels (if any) and readout geometry
923(if any).  Note: voxels are not constructed until start of run -
924 "/run/beamOn".
925
926Parameter : logical-volume-name
927 Parameter type  : s
928 Omittable       : False
929
930Parameter : depth-of-descent
931Depth of descent of geometry hierarchy.
932 Parameter type  : i
933 Omittable       : True
934 Default value   : 1
935
936Parameter : booleans-flag
937 Parameter type  : b
938 Omittable       : True
939 Default value   : 1
940
941Parameter : voxels-flag
942 Parameter type  : b
943 Omittable       : True
944 Default value   : 1
945
946Parameter : readout-flag
947 Parameter type  : b
948 Omittable       : True
949 Default value   : 1
950
951
952
953Command /vis/scene/add/logo
954Guidance :
955Adds a G4 logo to the current scene.
956The placement, if automatic, is similar to that of scale -
957"help /vis/scene/add/scale" for more information.
958
959Parameter : height
960 Parameter type  : d
961 Omittable       : True
962 Default value   : 1
963
964Parameter : unit
965 Parameter type  : s
966 Omittable       : True
967 Default value   : m
968
969Parameter : direction
970'x', 'y' or 'z' - otherwise defaults to 'x'.
971 Parameter type  : s
972 Omittable       : True
973 Default value   : x
974
975Parameter : red
976 Parameter type  : d
977 Omittable       : True
978 Default value   : 0
979
980Parameter : green
981 Parameter type  : d
982 Omittable       : True
983 Default value   : 1
984
985Parameter : blue
986 Parameter type  : d
987 Omittable       : True
988 Default value   : 0
989
990Parameter : auto|manual
991Automatic placement or manual placement at (xmid,ymid,zmid).
992 Parameter type  : s
993 Omittable       : True
994 Default value   : auto
995
996Parameter : xmid
997 Parameter type  : d
998 Omittable       : True
999 Default value   : 0
1000
1001Parameter : ymid
1002
1003 Parameter type  : d
1004 Omittable       : True
1005 Default value   : 0
1006
1007Parameter : zmid
1008 Parameter type  : d
1009 Omittable       : True
1010 Default value   : 0
1011
1012Parameter : unit
1013 Parameter type  : s
1014 Omittable       : True
1015 Default value   : m
1016
1017
1018
1019Command /vis/scene/add/scale
1020Guidance :
1021Adds an annotated scale line to the current scene.
1022An annotated line in the specified direction with tick marks at the
1023end.  If autoPlacing is true it is required to be centred at the
1024front, right, bottom corner of the world space, comfortably outside
1025the existing bounding box/sphere so that existing objects do not
1026obscure it.  Otherwise it is required to be drawn with mid-point at
1027(xmid, ymid, zmid).
1028
1029The auto placing algorithm might be:
1030  x = xmin + (1 + comfort) * (xmax - xmin);
1031  y = ymin - comfort * (ymax - ymin);
1032  z = zmin + (1 + comfort) * (zmax - zmin);
1033  if direction == x then (x - length,y,z) to (x,y,z);
1034  if direction == y then (x,y,z) to (x,y + length,z);
1035  if direction == z then (x,y,z - length) to (x,y,z);
1036
1037Parameter : length
1038 Parameter type  : d
1039 Omittable       : True
1040 Default value   : 1
1041
1042Parameter : unit
1043 Parameter type  : s
1044 Omittable       : True
1045 Default value   : m
1046
1047Parameter : direction
1048'x', 'y' or 'z' - otherwise defaults to 'x'.
1049 Parameter type  : s
1050 Omittable       : True
1051 Default value   : x
1052
1053Parameter : red
1054 Parameter type  : d
1055 Omittable       : True
1056 Default value   : 1
1057
1058Parameter : green
1059 Parameter type  : d
1060 Omittable       : True
1061 Default value   : 0
1062
1063Parameter : blue
1064 Parameter type  : d
1065 Omittable       : True
1066 Default value   : 0
1067
1068Parameter : auto|manual
1069Automatic placement or manual placement at (xmid,ymid,zmid).
1070 Parameter type  : s
1071 Omittable       : True
1072 Default value   : auto
1073
1074Parameter : xmid
1075 Parameter type  : d
1076 Omittable       : True
1077 Default value   : 0
1078
1079Parameter : ymid
1080 Parameter type  : d
1081 Omittable       : True
1082 Default value   : 0
1083
1084Parameter : zmid
1085 Parameter type  : d
1086 Omittable       : True
1087 Default value   : 0
1088
1089Parameter : unit
1090 Parameter type  : s
1091 Omittable       : True
1092 Default value   : m
1093
1094
1095
1096Command /vis/scene/add/text
1097Guidance :
1098Adds text to current scene.
1099
1100Parameter : x
1101x
1102 Parameter type  : d
1103 Omittable       : True
1104 Default value   : 0
1105
1106Parameter : y
1107y
1108 Parameter type  : d
1109 Omittable       : True
1110 Default value   : 0
1111
1112Parameter : z
1113z
1114 Parameter type  : d
1115 Omittable       : True
1116 Default value   : 0
1117
1118Parameter : unit
1119 Parameter type  : s
1120 Omittable       : True
1121 Default value   : m
1122
1123Parameter : font_size
1124pixels
1125 Parameter type  : d
1126 Omittable       : True
1127 Default value   : 12
1128
1129Parameter : x_offset
1130pixels
1131 Parameter type  : d
1132 Omittable       : True
1133 Default value   : 0
1134
1135Parameter : y_offset
1136pixels
1137 Parameter type  : d
1138 Omittable       : True
1139 Default value   : 0
1140
1141Parameter : text
1142The rest of the line is text.
1143 Parameter type  : s
1144 Omittable       : True
1145 Default value   : Hello G4
1146
1147
1148
1149Command /vis/scene/add/trajectories
1150Guidance :
1151Adds trajectories to current scene.
1152Causes trajectories, if any, to be drawn at the end of processiing an
1153event. The drawing mode is an integer that is passed to the
1154DrawTrajectory method.  The default implementation in G4VTrajectory,
1155if drawing-mode >= 0, draws the trajectory as a polyline (blue for
1156positive, red for negative, green for neutral) and, if
1157drawing-mode != 0, draws markers of screen size
1158std::abs(drawing-mode)/1000 pixels at each step and auxiliary point,
1159if any.  So drawing-mode = 5000 is a good choice.
1160Enable storing with "/tracking/storeTrajectory 1".
1161See also "/vis/scene/endOfEventAction".
1162
1163Parameter : drawing-mode
1164 Parameter type  : i
1165 Omittable       : True
1166 Default value   : 0
1167
1168
1169
1170Command /vis/scene/add/userAction
1171Guidance :
1172Add Vis User Action, if any, to current scene.
1173Optional arguments define the extent of the callback drawing.  You may
1174not need this if the extent has been defined in the original
1175SetUserAction or is defined by other components of the scene.  But if
1176the user action is the only component of the scene, you will certainly
1177need to set the extent either in SetUserAction or here.  A scene must
1178have an extent one way or another so that the viewer can calculate
1179how to point the camera.
1180
1181Parameter : xmin
1182 Parameter type  : d
1183 Omittable       : True
1184 Default value   : 0
1185
1186Parameter : xmax
1187 Parameter type  : d
1188 Omittable       : True
1189 Default value   : 0
1190
1191Parameter : ymin
1192 Parameter type  : d
1193 Omittable       : True
1194 Default value   : 0
1195
1196Parameter : ymax
1197 Parameter type  : d
1198 Omittable       : True
1199 Default value   : 0
1200
1201Parameter : zmin
1202 Parameter type  : d
1203 Omittable       : True
1204 Default value   : 0
1205
1206Parameter : zmax
1207 Parameter type  : d
1208 Omittable       : True
1209 Default value   : 0
1210
1211Parameter : unit
1212 Parameter type  : s
1213 Omittable       : True
1214 Default value   : cm
1215
1216
1217
1218Command /vis/scene/add/volume
1219Guidance :
1220Adds a physical volume to current scene, with optional clipping volume.
1221If physical-volume-name is "world" (the default), the top of the
1222tracking tree is used (GetNavigatorForTracking()->GetWorldVolume()).
1223Otherwise a search of the tracking tree is made, taking the first
1224matching occurence only.  To see a representation of the geometry
1225hierarchy of the tracking tree, try "/vis/drawTree" or one of the
1226driver/browser combinations that have the required functionality,
1227e.g., HepRepFile/XML with the WIRED3/4 browser.
1228If clip-volume-type is specified, the subsequent parameters are used to
1229to define a clipping volume.  For example,
1230"vis/scene/add/volume ! ! ! box km 0 1 0 1 0 1" will draw the world
1231with the positive octant cut away.
1232
1233Parameter : physical-volume-name
1234 Parameter type  : s
1235 Omittable       : True
1236 Default value   : world
1237
1238Parameter : copy-no
1239If negative, matches any copy no.  First name match is taken.
1240 Parameter type  : i
1241 Omittable       : True
1242 Default value   : -1
1243
1244Parameter : depth-of-descent
1245Depth of descent of geometry hierarchy. Default = unlimited depth.
1246 Parameter type  : i
1247 Omittable       : True
1248 Default value   : -1
1249
1250Parameter : clip-volume-type
1251For "box", the parameters are xmin,xmax,ymin,ymax,zmin,zmax. Only "box" is programmed at present.
1252 Parameter type  : s
1253 Omittable       : True
1254 Default value   : none
1255
1256Parameter : parameter-unit
1257 Parameter type  : s
1258 Omittable       : True
1259 Default value   : m
1260
1261Parameter : parameter-1
1262 Parameter type  : d
1263 Omittable       : True
1264 Default value   : 0
1265
1266Parameter : parameter-2
1267 Parameter type  : d
1268 Omittable       : True
1269 Default value   : 0
1270
1271Parameter : parameter-3
1272 Parameter type  : d
1273 Omittable       : True
1274 Default value   : 0
1275
1276Parameter : parameter-4
1277 Parameter type  : d
1278 Omittable       : True
1279 Default value   : 0
1280
1281Parameter : parameter-5
1282 Parameter type  : d
1283 Omittable       : True
1284 Default value   : 0
1285
1286Parameter : parameter-6
1287 Parameter type  : d
1288 Omittable       : True
1289 Default value   : 0
1290
1291Command directory path : /vis/sceneHandler/
1292
1293
1294Guidance :
1295Operations on Geant4 scene handlers.
1296
1297 Sub-directories :
1298 Commands :
1299   attach * Attaches scene to current scene handler.
1300   create * Creates an scene handler for a specific graphics system.
1301   list * Lists scene handler(s).
1302   select * Selects a scene handler.
1303
1304
1305Command /vis/sceneHandler/attach
1306Guidance :
1307Attaches scene to current scene handler.
1308If scene-name is omitted, current scene is attached.  To see scenes and
1309scene handlers, use "/vis/scene/list" and "/vis/sceneHandler/list"
1310
1311Parameter : scene-name
1312 Parameter type  : s
1313 Omittable       : True
1314 Default value   : taken from the current value
1315
1316
1317
1318Command /vis/sceneHandler/create
1319Guidance :
1320Creates an scene handler for a specific graphics system.
1321Attaches current scene, if any.  (You can change attached scenes with
1322"/vis/sceneHandler/attach".)  Invents a scene handler name if not
1323supplied.  This scene handler becomes current.
1324
1325Parameter : graphics-system-name
1326 Parameter type  : s
1327 Omittable       : False
1328 Candidates      : XXX ATree DAWNFILE GAGTree HepRepXML HepRepFile VRML1FILE VRML2FILE DAWN OGLIX OGLSX OGLIXm OGLSXm OIX RayTracerX VRML1 VRML2
1329
1330Parameter : scene-handler-name
1331 Parameter type  : s
1332 Omittable       : True
1333 Default value   : taken from the current value
1334
1335
1336
1337Command /vis/sceneHandler/list
1338Guidance :
1339Lists scene handler(s).
1340"help /vis/verbose" for definition of verbosity.
1341
1342Parameter : scene-handler-name
1343 Parameter type  : s
1344 Omittable       : True
1345 Default value   : all
1346
1347Parameter : verbosity
1348 Parameter type  : s
1349 Omittable       : True
1350 Default value   : 0
1351
1352
1353
1354Command /vis/sceneHandler/select
1355Guidance :
1356Selects a scene handler.
1357Makes the scene handler current.  "/vis/sceneHandler/list" to see
1358 possible scene handler names.
1359
1360Parameter : scene-handler-name
1361 Parameter type  : s
1362 Omittable       : False
1363
1364Command directory path : /vis/viewer/
1365
1366
1367Guidance :
1368Operations on Geant4 viewers.
1369
1370 Sub-directories :
1371   /vis/viewer/set/   Set view parameters of current viewer.
1372 Commands :
1373   clear * Clears viewer.
1374   create * Creates a viewer for the specified scene handler.
1375   dolly * Incremental dolly.
1376   dollyTo * Dolly to specific coordinate.
1377   flush * Compound command: "/vis/viewer/refresh" + "/vis/viewer/update".
1378   list * Lists viewers(s).
1379   pan * Incremental pan.
1380   panTo * Pan to specific coordinate.
1381   rebuild * Forces rebuild of graphical database.
1382   refresh * Refreshes viewer.
1383   reset * Resets viewer.
1384   scale * Incremental (non-uniform) scaling.
1385   scaleTo * Absolute (non-uniform) scaling.
1386   select * Selects viewer.
1387   update * Triggers graphical database post-processing for viewers
1388using that technique.
1389   zoom * Incremental zoom.
1390   zoomTo * Absolute zoom.
1391
1392
1393Command /vis/viewer/clear
1394Guidance :
1395Clears viewer.
1396By default, clears current viewer.  Specified viewer becomes current.
1397"/vis/viewer/list" to see  possible viewer names.
1398
1399Parameter : viewer-name
1400 Parameter type  : s
1401 Omittable       : True
1402 Default value   : taken from the current value
1403
1404
1405
1406Command /vis/viewer/create
1407Guidance :
1408Creates a viewer for the specified scene handler.
1409Default scene handler is the current scene handler.  Invents a name
1410if not supplied.  (Note: the system adds information to the name
1411for identification - only the characters up to the first blank are
1412used for removing, selecting, etc.)  This scene handler and viewer
1413become current.
1414
1415Parameter : scene-handler
1416 Parameter type  : s
1417 Omittable       : True
1418 Default value   : taken from the current value
1419
1420Parameter : viewer-name
1421 Parameter type  : s
1422 Omittable       : True
1423 Default value   : taken from the current value
1424
1425Parameter : window-size-hint
1426integer (pixels) for square window placed by window manager or X-Windows-type geometry string, e.g. 600x600-100+100
1427 Parameter type  : s
1428 Omittable       : True
1429 Default value   : 600
1430
1431
1432
1433Command /vis/viewer/dolly
1434Guidance :
1435Incremental dolly.
1436Moves the camera incrementally towards target point.
1437
1438Parameter : increment
1439 Parameter type  : d
1440 Omittable       : True
1441 Default value   : taken from the current value
1442
1443Parameter : Unit
1444 Parameter type  : s
1445 Omittable       : True
1446 Default value   : m
1447 Candidates      : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
1448
1449
1450
1451Command /vis/viewer/dollyTo
1452Guidance :
1453Dolly to specific coordinate.
1454Places the camera towards target point relative to standard camera point.
1455
1456Parameter : distance
1457 Parameter type  : d
1458 Omittable       : True
1459 Default value   : taken from the current value
1460
1461Parameter : Unit
1462 Parameter type  : s
1463 Omittable       : True
1464 Default value   : m
1465 Candidates      : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
1466
1467
1468
1469Command /vis/viewer/flush
1470Guidance :
1471Compound command: "/vis/viewer/refresh" + "/vis/viewer/update".
1472Useful for refreshing and initiating post-processing for graphics
1473systems which need post-processing.  By default, acts on current
1474viewer.  "/vis/viewer/list" to see possible viewers.  Viewer
1475becomes current.
1476
1477Parameter : viewer-name
1478 Parameter type  : s
1479 Omittable       : True
1480 Default value   : taken from the current value
1481
1482
1483
1484Command /vis/viewer/list
1485Guidance :
1486Lists viewers(s).
1487See "/vis/verbose" for definition of verbosity.
1488
1489Parameter : viewer-name
1490 Parameter type  : s
1491 Omittable       : True
1492 Default value   : all
1493
1494Parameter : verbosity
1495 Parameter type  : s
1496 Omittable       : True
1497 Default value   : 0
1498
1499
1500
1501Command /vis/viewer/pan
1502Guidance :
1503Incremental pan.
1504Moves the camera incrementally right and up by these amounts (as seen
1505from viewpoint direction).
1506
1507Parameter : right-increment
1508 Parameter type  : d
1509 Omittable       : True
1510 Default value   : taken from the current value
1511
1512Parameter : up-increment
1513 Parameter type  : d
1514 Omittable       : True
1515 Default value   : taken from the current value
1516
1517Parameter : unit
1518 Parameter type  : s
1519 Omittable       : True
1520 Default value   : m
1521
1522
1523
1524Command /vis/viewer/panTo
1525Guidance :
1526Pan to specific coordinate.
1527Places the camera in this position right and up relative to standard
1528target point (as seen from viewpoint direction).
1529
1530Parameter : right
1531 Parameter type  : d
1532 Omittable       : True
1533 Default value   : taken from the current value
1534
1535Parameter : up
1536 Parameter type  : d
1537 Omittable       : True
1538 Default value   : taken from the current value
1539
1540Parameter : unit
1541 Parameter type  : s
1542 Omittable       : True
1543 Default value   : m
1544
1545
1546
1547Command /vis/viewer/rebuild
1548Guidance :
1549Forces rebuild of graphical database.
1550By default, acts on current viewer.  "/vis/viewer/list"
1551to see possible viewers.  Viewer becomes current.
1552
1553Parameter : viewer-name
1554 Parameter type  : s
1555 Omittable       : True
1556 Default value   : taken from the current value
1557
1558
1559
1560Command /vis/viewer/refresh
1561Guidance :
1562Refreshes viewer.
1563By default, acts on current viewer.  "/vis/viewer/list"
1564to see possible viewers.  Viewer becomes current.
1565
1566Parameter : viewer-name
1567 Parameter type  : s
1568 Omittable       : True
1569 Default value   : taken from the current value
1570
1571
1572
1573Command /vis/viewer/reset
1574Guidance :
1575Resets viewer.
1576By default, acts on current viewer.  "/vis/viewer/list"
1577to see possible viewers.  Viewer becomes current.
1578
1579Parameter : viewer-name
1580 Parameter type  : s
1581 Omittable       : True
1582 Default value   : taken from the current value
1583
1584
1585
1586Command /vis/viewer/scale
1587Guidance :
1588Incremental (non-uniform) scaling.
1589Multiplies components of current scaling by components of this factor.
1590 Scales (x,y,z) by corresponding components of the resulting factor.
1591
1592
1593Parameter : x-scale-multiplier
1594 Parameter type  : d
1595 Omittable       : True
1596 Default value   : taken from the current value
1597
1598Parameter : y-scale-multiplier
1599 Parameter type  : d
1600 Omittable       : True
1601 Default value   : taken from the current value
1602
1603Parameter : z-scale-multiplier
1604 Parameter type  : d
1605 Omittable       : True
1606 Default value   : taken from the current value
1607
1608
1609
1610Command /vis/viewer/scaleTo
1611Guidance :
1612Absolute (non-uniform) scaling.
1613Scales (x,y,z) by corresponding components of this factor.
1614
1615Parameter : x-scale-factor
1616 Parameter type  : d
1617 Omittable       : True
1618 Default value   : taken from the current value
1619
1620Parameter : y-scale-factor
1621 Parameter type  : d
1622 Omittable       : True
1623 Default value   : taken from the current value
1624
1625Parameter : z-scale-factor
1626 Parameter type  : d
1627 Omittable       : True
1628 Default value   : taken from the current value
1629
1630
1631
1632Command /vis/viewer/select
1633Guidance :
1634Selects viewer.
1635Specify viewer by name.  "/vis/viewer/list" to see possible viewers.
1636
1637Parameter : viewer-name
1638 Parameter type  : s
1639 Omittable       : False
1640
1641
1642
1643Command /vis/viewer/update
1644Guidance :
1645Triggers graphical database post-processing for viewers
1646using that technique.
1647For such viewers the view only becomes visible with this command.
1648By default, acts on current viewer.  "/vis/viewer/list"
1649to see possible viewers.  Viewer becomes current.
1650
1651Parameter : viewer-name
1652 Parameter type  : s
1653 Omittable       : True
1654 Default value   : taken from the current value
1655
1656
1657
1658Command /vis/viewer/zoom
1659Guidance :
1660Incremental zoom.
1661Multiplies current magnification by this factor.
1662
1663Parameter : multiplier
1664 Parameter type  : d
1665 Omittable       : True
1666 Default value   : taken from the current value
1667
1668
1669
1670Command /vis/viewer/zoomTo
1671Guidance :
1672Absolute zoom.
1673Magnifies standard magnification by this factor.
1674
1675Parameter : factor
1676 Parameter type  : d
1677 Omittable       : True
1678 Default value   : taken from the current value
1679
1680Command directory path : /vis/viewer/set/
1681
1682
1683Guidance :
1684Set view parameters of current viewer.
1685
1686 Sub-directories :
1687 Commands :
1688   all * Copies view parameters.
1689   autoRefresh * Sets auto-refresh.
1690   auxiliaryEdge * Sets visibility of auxiliary edges
1691   culling * Set culling options.
1692   edge *   default: true
1693   globalMarkerScale * Multiplies marker sizes by this factor.
1694   hiddenEdge * Edges become hidden/seen in wireframe or surface mode.
1695   hiddenMarker * If true, closer objects hide markers. Otherwise, markers always show.
1696   lightsMove * Lights move with camera or with object
1697   lightsThetaPhi * Set direction from target to lights.
1698   lightsVector * Set direction from target to lights.
1699   lineSegmentsPerCircle * Set number of sides per circle for polygon/polyhedron drawing.
1700   projection * Orthogonal or perspective projection.
1701   sectionPlane * Set plane for drawing section (DCUT).
1702   style * Set style of drawing.
1703   upThetaPhi * Set up vector.
1704   upVector * Set up vector.
1705   viewpointThetaPhi * Set direction from target to camera.
1706   viewpointVector * Set direction from target to camera.
1707   background * Set background colour and transparency (default black and opaque).
1708
1709
1710Command /vis/viewer/set/all
1711Guidance :
1712Copies view parameters.
1713Copies view parameters (except the autoRefresh status) from
1714from-viewer to current viewer.
1715
1716Parameter : from-viewer-name
1717 Parameter type  : s
1718 Omittable       : False
1719
1720
1721
1722Command /vis/viewer/set/autoRefresh
1723Guidance :
1724Sets auto-refresh.
1725If true, view is automatically refreshed after a change of
1726view parameters.
1727
1728Parameter : auto-refresh
1729 Parameter type  : b
1730 Omittable       : True
1731 Default value   : 0
1732
1733
1734
1735Command /vis/viewer/set/auxiliaryEdge
1736Guidance :
1737Sets visibility of auxiliary edges
1738Auxiliary edges, i.e., those that are part of a curved surface,
1739sometimes called soft edges, become visible/invisible.
1740
1741Parameter : edge
1742 Parameter type  : b
1743 Omittable       : True
1744 Default value   : 0
1745
1746
1747
1748Command /vis/viewer/set/culling
1749Guidance :
1750Set culling options.
1751"global": enables/disables all other culling options.
1752"coveredDaughters": culls, i.e., eliminates, volumes that would not
1753be seen because covered by ancester volumes in surface drawing mode,
1754and then only if the ancesters are visible and opaque, and then only
1755if no sections or cutaways are in operation.  Intended solely to
1756improve the speed of rendering visible volumes.
1757"invisible": culls objects with the invisible attribute set.
1758"density": culls volumes with density lower than threshold.  Useful
1759for eliminating "container volumes" with no physical correspondence,
1760whose material is usually air.  If this is selected, provide threshold
1761density and unit (g/cm3 mg/cm3 or kg/m3).
1762
1763Parameter : culling-option
1764 Parameter type  : s
1765 Omittable       : False
1766 Candidates      : global coveredDaughters invisible density
1767
1768Parameter : action
1769 Parameter type  : b
1770 Omittable       : True
1771 Default value   : true
1772
1773Parameter : density-threshold
1774 Parameter type  : d
1775 Omittable       : True
1776 Default value   : 0.01
1777
1778Parameter : unit
1779 Parameter type  : s
1780 Omittable       : True
1781 Default value   : g/cm3
1782 Candidates      : g/cm3, mg/cm3 kg/m3
1783
1784
1785
1786Command /vis/viewer/set/edge
1787Guidance :
1788  default: true
1789Edges become visible/invisible in surface mode.
1790
1791Parameter : edge
1792 Parameter type  : b
1793 Omittable       : True
1794 Default value   : 1
1795
1796
1797
1798Command /vis/viewer/set/globalMarkerScale
1799Guidance :
1800Multiplies marker sizes by this factor.
1801
1802Parameter : scale-factorr
1803 Parameter type  : d
1804 Omittable       : True
1805 Default value   : 1
1806
1807
1808
1809Command /vis/viewer/set/hiddenEdge
1810Guidance :
1811Edges become hidden/seen in wireframe or surface mode.
1812
1813Parameter : hidden-edge
1814 Parameter type  : b
1815 Omittable       : True
1816 Default value   : 1
1817
1818
1819
1820Command /vis/viewer/set/hiddenMarker
1821Guidance :
1822If true, closer objects hide markers. Otherwise, markers always show.
1823
1824Parameter : hidden-marker
1825 Parameter type  : b
1826 Omittable       : True
1827 Default value   : 1
1828
1829
1830
1831Command /vis/viewer/set/lightsMove
1832Guidance :
1833Lights move with camera or with object
1834
1835Parameter : lightsMove
1836 Parameter type  : s
1837 Omittable       : False
1838 Candidates      : cam camera with-camera obj object with-object
1839
1840
1841
1842Command /vis/viewer/set/lightsThetaPhi
1843Guidance :
1844Set direction from target to lights.
1845
1846Parameter : theta
1847 Parameter type  : d
1848 Omittable       : True
1849 Default value   : 60
1850
1851Parameter : phi
1852 Parameter type  : d
1853 Omittable       : True
1854 Default value   : 45
1855
1856Parameter : unit
1857 Parameter type  : s
1858 Omittable       : True
1859 Default value   : deg
1860
1861
1862
1863Command /vis/viewer/set/lightsVector
1864Guidance :
1865Set direction from target to lights.
1866
1867Parameter : x
1868 Parameter type  : d
1869 Omittable       : True
1870 Default value   : 1
1871
1872Parameter : y
1873 Parameter type  : d
1874 Omittable       : True
1875 Default value   : 1
1876
1877Parameter : z
1878 Parameter type  : d
1879 Omittable       : True
1880 Default value   : 1
1881
1882
1883
1884Command /vis/viewer/set/lineSegmentsPerCircle
1885Guidance :
1886Set number of sides per circle for polygon/polyhedron drawing.
1887Refers to graphical representation of objects with curved lines/surfaces.
1888
1889Parameter : line-segments
1890 Parameter type  : i
1891 Omittable       : True
1892 Default value   : 24
1893
1894
1895
1896Command /vis/viewer/set/projection
1897Guidance :
1898Orthogonal or perspective projection.
1899
1900Parameter : projection
1901 Parameter type  : s
1902 Omittable       : True
1903 Default value   : orthogonal
1904 Candidates      : o orthogonal p perspective
1905
1906Parameter : field-half-angle
1907 Parameter type  : d
1908 Omittable       : True
1909 Default value   : 30
1910
1911Parameter : unit
1912 Parameter type  : s
1913 Omittable       : True
1914 Default value   : deg
1915
1916
1917
1918Command /vis/viewer/set/sectionPlane
1919Guidance :
1920Set plane for drawing section (DCUT).
1921E.g., for a y-z plane at x = 1 cm:
1922"/vis/viewer/set/sectionPlane on 1 0 0 cm 1 0 0".
1923To turn off: /vis/viewer/set/sectionPlane off
1924
1925Parameter : Selector
1926 Parameter type  : c
1927 Omittable       : True
1928 Default value   : on
1929
1930Parameter : x
1931Coordinate of point on the plane.
1932 Parameter type  : d
1933 Omittable       : True
1934 Default value   : 0
1935
1936Parameter : y
1937Coordinate of point on the plane.
1938 Parameter type  : d
1939 Omittable       : True
1940 Default value   : 0
1941
1942Parameter : z
1943Coordinate of point on the plane.
1944 Parameter type  : d
1945 Omittable       : True
1946 Default value   : 0
1947
1948Parameter : unit
1949Unit of point on the plane.
1950 Parameter type  : s
1951 Omittable       : True
1952 Default value   : cm
1953
1954Parameter : nx
1955Component of plane normal.
1956 Parameter type  : d
1957 Omittable       : True
1958 Default value   : 1
1959
1960Parameter : ny
1961Component of plane normal.
1962 Parameter type  : d
1963 Omittable       : True
1964 Default value   : 0
1965
1966Parameter : nz
1967Component of plane normal.
1968 Parameter type  : d
1969 Omittable       : True
1970 Default value   : 0
1971
1972
1973
1974Command /vis/viewer/set/style
1975Guidance :
1976Set style of drawing.
1977(Hidden line drawing is controlled by "/vis/viewer/set/hiddenEdge".)
1978
1979Parameter : style
1980 Parameter type  : s
1981 Omittable       : False
1982 Candidates      : w wireframe s surface
1983
1984
1985
1986Command /vis/viewer/set/upThetaPhi
1987Guidance :
1988Set up vector.
1989Viewer will attempt always to show this direction upwards.
1990
1991Parameter : theta
1992 Parameter type  : d
1993 Omittable       : True
1994 Default value   : 90
1995
1996Parameter : phi
1997 Parameter type  : d
1998 Omittable       : True
1999 Default value   : 90
2000
2001Parameter : unit
2002 Parameter type  : s
2003 Omittable       : True
2004 Default value   : deg
2005
2006
2007
2008Command /vis/viewer/set/upVector
2009Guidance :
2010Set up vector.
2011Viewer will attempt always to show this direction upwards.
2012
2013Parameter : x
2014 Parameter type  : d
2015 Omittable       : True
2016 Default value   : 0
2017
2018Parameter : y
2019 Parameter type  : d
2020 Omittable       : True
2021 Default value   : 1
2022
2023Parameter : z
2024 Parameter type  : d
2025 Omittable       : True
2026 Default value   : 0
2027
2028
2029
2030Command /vis/viewer/set/viewpointThetaPhi
2031Guidance :
2032Set direction from target to camera.
2033Also changes lightpoint direction if lights are set to move with camera.
2034
2035Parameter : theta
2036 Parameter type  : d
2037 Omittable       : True
2038 Default value   : 60
2039
2040Parameter : phi
2041 Parameter type  : d
2042 Omittable       : True
2043 Default value   : 45
2044
2045Parameter : unit
2046 Parameter type  : s
2047 Omittable       : True
2048 Default value   : deg
2049
2050
2051
2052Command /vis/viewer/set/viewpointVector
2053Guidance :
2054Set direction from target to camera.
2055Also changes lightpoint direction if lights are set to move with camera.
2056
2057Parameter : x
2058 Parameter type  : d
2059 Omittable       : True
2060 Default value   : 1
2061
2062Parameter : y
2063 Parameter type  : d
2064 Omittable       : True
2065 Default value   : 1
2066
2067Parameter : z
2068 Parameter type  : d
2069 Omittable       : True
2070 Default value   : 1
2071
2072
2073
2074Command /vis/viewer/set/background
2075Guidance :
2076Set background colour and transparency (default black and opaque).
2077Accepts (a) RGB triplet. e.g., ".3 .4 .5", or
2078(b) string such as "white", "black", "grey", "red"...
2079(c) an additional number for opacity, e.g., ".3 .4 .5 .6"
2080    or "grey ! ! .6" (note "!"'s for unused green and blue parameters),
2081    e.g. "! ! ! 0." for a transparent background.
2082
2083Parameter : red_or_string
2084 Parameter type  : s
2085 Omittable       : True
2086 Default value   : 0.
2087
2088Parameter : green
2089 Parameter type  : d
2090 Omittable       : True
2091 Default value   : 0
2092
2093Parameter : blue
2094 Parameter type  : d
2095 Omittable       : True
2096 Default value   : 0
2097
2098Parameter : opacity
2099 Parameter type  : d
2100 Omittable       : True
2101 Default value   : 1
2102
2103Command directory path : /vis/oglxm-viewer-0/
2104
2105
2106Guidance :
2107G4OpenGLXmViewer "viewer-0" commands.
2108
2109 Sub-directories :
2110   /vis/oglxm-viewer-0/set/   G4OpenGLXmViewer "viewer-0" set commands.
2111 Commands :
2112Command directory path : /vis/oglxm-viewer-0/set/
2113
2114
2115Guidance :
2116G4OpenGLXmViewer "viewer-0" set commands.
2117
2118 Sub-directories :
2119 Commands :
2120   dolly-high * Higher limit of dolly slider.
2121   dolly-low * Lower limit of dolly slider.
2122   pan-high * Higher limit of pan slider.
2123   rotation-high * Higher limit of rotation slider.
2124   zoom-high * Higher limit of zoom slider.
2125   zoom-low * Lower limit of zoom slider.
2126
2127
2128Command /vis/oglxm-viewer-0/set/dolly-high
2129Guidance :
2130Higher limit of dolly slider.
2131
2132Parameter : dolly-high
2133 Parameter type  : d
2134 Omittable       : False
2135
2136Parameter : Unit
2137 Parameter type  : s
2138 Omittable       : False
2139
2140
2141
2142Command /vis/oglxm-viewer-0/set/dolly-low
2143Guidance :
2144Lower limit of dolly slider.
2145
2146Parameter : dolly-low
2147 Parameter type  : d
2148 Omittable       : False
2149
2150Parameter : Unit
2151 Parameter type  : s
2152 Omittable       : False
2153
2154
2155
2156Command /vis/oglxm-viewer-0/set/pan-high
2157Guidance :
2158Higher limit of pan slider.
2159
2160Parameter : pan-high
2161 Parameter type  : d
2162 Omittable       : False
2163
2164Parameter : Unit
2165 Parameter type  : s
2166 Omittable       : False
2167
2168
2169
2170Command /vis/oglxm-viewer-0/set/rotation-high
2171Guidance :
2172Higher limit of rotation slider.
2173
2174Parameter : rotation-high
2175 Parameter type  : d
2176 Omittable       : False
2177
2178Parameter : Unit
2179 Parameter type  : s
2180 Omittable       : False
2181
2182
2183
2184Command /vis/oglxm-viewer-0/set/zoom-high
2185Guidance :
2186Higher limit of zoom slider.
2187
2188Parameter : zoom-high
2189 Parameter type  : d
2190 Omittable       : False
2191
2192
2193
2194Command /vis/oglxm-viewer-0/set/zoom-low
2195Guidance :
2196Lower limit of zoom slider.
2197
2198Parameter : zoom-low
2199 Parameter type  : d
2200 Omittable       : False
2201
Note: See TracBrowser for help on using the repository browser.