source: trunk/documents/UserDoc/UsersGuides/ForApplicationDeveloper/html/Visualization/UIcommands/vis.txt@ 1331

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

CVS update
File size: 115.5 KB
Line 
1Command directory path : /vis/
2
3
4Guidance :
5Visualization commands.
6
7 Sub-directories :
8 /vis/ASCIITree/ Commands for ASCIITree control.
9 /vis/GAGTree/ Commands for GAGTree control.
10 /vis/heprep/ HepRep commands.
11 /vis/rayTracer/ RayTracer commands.
12 /vis/ogl/ G4OpenGLViewer commands.
13 /vis/oglx/ G4OpenGLXViewer commands.
14 /vis/oglxm/ G4OpenGLXmViewer commands.
15 /vis/modeling/ Modeling commands.
16 /vis/filtering/ Filtering commands.
17 /vis/geometry/ Operations on vis attributes of Geant4 geometry.
18 /vis/scene/ Operations on Geant4 scenes.
19 /vis/sceneHandler/ Operations on Geant4 scene handlers.
20 /vis/viewer/ Operations on Geant4 viewers.
21 Commands :
22 enable * Enables/disables visualization system.
23 disable * Disables visualization system.
24 list * Lists visualization parameters.
25 verbose * Simple graded message scheme - digit or string (1st character defines):
26 reviewKeptEvents * Review kept events.
27 drawTree * (DTREE) Creates a scene consisting of this physical volume and
28 produces a representation of the geometry hieracrhy.
29 drawView * Draw view from this angle, etc.
30 drawVolume * Creates a scene containing this physical volume and asks the
31current viewer to draw it. The scene becomes current.
32 open * Creates a scene handler ready for drawing.
33 specify * Draws logical volume with Boolean components, voxels and readout geometry.
34
35
36Command /vis/enable
37Guidance :
38Enables/disables visualization system.
39
40Parameter : enabled
41 Parameter type : b
42 Omittable : True
43 Default value : 1
44
45
46
47Command /vis/disable
48Guidance :
49Disables visualization system.
50
51
52
53Command /vis/list
54Guidance :
55Lists visualization parameters.
56
57Parameter : verbosity
58 Parameter type : s
59 Omittable : True
60 Default value : warnings
61
62
63
64Command /vis/verbose
65Guidance :
66Simple graded message scheme - digit or string (1st character defines):
67 0) quiet, // Nothing is printed.
68 1) startup, // Startup and endup messages are printed...
69 2) errors, // ...and errors...
70 3) warnings, // ...and warnings...
71 4) confirmations, // ...and confirming messages...
72 5) parameters, // ...and parameters of scenes and views...
73 6) all // ...and everything available.
74
75Parameter : verbosity
76 Parameter type : s
77 Omittable : True
78 Default value : warnings
79
80
81
82Command /vis/reviewKeptEvents
83Guidance :
84Review kept events.
85If a macro file is specified, it is executed for each event.
86If a macro file is not specified, each event is drawn to the current
87viewer. After each event, the session is paused. The user may issue
88any allowed command. Then enter "continue" to continue to the next
89event.
90However, if the current scene requests event accumulation, this
91command simply notifies handlers.
92
93Parameter : macro-file-name
94 Parameter type : s
95 Omittable : True
96
97
98
99Command /vis/drawTree
100Guidance :
101(DTREE) Creates a scene consisting of this physical volume and
102 produces a representation of the geometry hieracrhy.
103The scene becomes current.
104
105Parameter : physical-volume-name
106 Parameter type : s
107 Omittable : True
108 Default value : world
109
110Parameter : system
111 Parameter type : s
112 Omittable : True
113 Default value : ATree
114
115
116
117Command /vis/drawView
118Guidance :
119Draw view from this angle, etc.
120
121Parameter : theta-degrees
122 Parameter type : d
123 Omittable : True
124 Default value : 0
125
126Parameter : phi-degrees
127 Parameter type : d
128 Omittable : True
129 Default value : 0
130
131Parameter : pan-right
132 Parameter type : d
133 Omittable : True
134 Default value : 0
135
136Parameter : pan-up
137 Parameter type : d
138 Omittable : True
139 Default value : 0
140
141Parameter : pan-unit
142 Parameter type : s
143 Omittable : True
144 Default value : cm
145
146Parameter : zoom-factor
147 Parameter type : d
148 Omittable : True
149 Default value : 1
150
151Parameter : dolly
152 Parameter type : d
153 Omittable : True
154 Default value : 0
155
156Parameter : dolly-unit
157 Parameter type : s
158 Omittable : True
159 Default value : cm
160
161
162
163Command /vis/drawVolume
164Guidance :
165Creates a scene containing this physical volume and asks the
166current viewer to draw it. The scene becomes current.
167If physical-volume-name is "world" (the default), the main geometry
168tree (material world) is drawn. If "worlds", all worlds - material
169world and parallel worlds, if any - are drawn. Otherwise a search of
170all worlds is made, taking the first matching occurence only. To see
171a representation of the geometry hierarchy of the worlds, try
172"/vis/drawTree [worlds]" or one of the driver/browser combinations
173that have the required functionality, e.g., HepRepFile/XML with the
174WIRED3/4 browser.
175
176Parameter : physical-volume-name
177 Parameter type : s
178 Omittable : True
179 Default value : world
180
181
182
183Command /vis/open
184Guidance :
185Creates a scene handler ready for drawing.
186The scene handler becomes current (the name is auto-generated).
187
188Parameter : graphics-system-name
189 Parameter type : s
190 Omittable : False
191 Candidates : XXX XXXFile XXXStored XXXSG ATree DAWNFILE GAGTree HepRepXML HepRepFile RayTracer VRML1FILE VRML2FILE DAWN OGLIX OGLSX OGLIXm OGLSXm OIX RayTracerX VRML1 VRML2
192
193Parameter : window-size-hint
194integer (pixels) for square window placed by window manager or X-Windows-type geometry string, e.g. 600x600-100+100
195 Parameter type : s
196 Omittable : True
197 Default value : 600
198
199
200
201Command /vis/specify
202Guidance :
203Draws logical volume with Boolean components, voxels and readout geometry.
204Creates a scene consisting of this logical volume and asks the
205 current viewer to draw it to the specified depth of descent
206 showing boolean components (if any), voxels (if any)
207 and readout geometry (if any), under control of the appropriate flag.
208Note: voxels are not constructed until start of run - /run/beamOn.
209The scene becomes current.
210
211Parameter : logical-volume-name
212 Parameter type : s
213 Omittable : False
214
215Parameter : depth-of-descent
216 Parameter type : i
217 Omittable : True
218 Default value : 1
219
220Parameter : booleans-flag
221 Parameter type : b
222 Omittable : True
223 Default value : 1
224
225Parameter : voxels-flag
226 Parameter type : b
227 Omittable : True
228 Default value : 1
229
230Parameter : readout-flag
231 Parameter type : b
232 Omittable : True
233 Default value : 1
234
235Command directory path : /vis/ASCIITree/
236
237
238Guidance :
239Commands for ASCIITree control.
240
241 Sub-directories :
242 /vis/ASCIITree/set/ Settings for ASCIITree control.
243 Commands :
244 verbose * < 10: - does not print daughters of repeated placements, does not repeat replicas.
245
246
247Command /vis/ASCIITree/verbose
248Guidance :
249 < 10: - does not print daughters of repeated placements, does not repeat replicas.
250 >= 10: prints all physical volumes.
251The level of detail is given by verbosity%10:
252for each volume:
253 >= 0: physical volume name.
254 >= 1: logical volume name (and names of sensitive detector and readout geometry, if any).
255 >= 2: solid name and type.
256 >= 3: volume and density.
257 >= 5: daughter-subtracted volume and mass.
258and in the summary at the end of printing:
259 >= 4: daughter-included mass of top physical volume(s) in scene to depth specified.
260Note: by default, culling is switched off so all volumes are seen.
261Note: 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:
262 /vis/open ATree
263 /vis/ASCIITree/verbose 14
264 /vis/scene/create
265 /vis/scene/add/volume <subtree-physical-volume> ! <depth>
266 /vis/sceneHandler/attach
267 /vis/viewer/flush
268
269Parameter : verbosity
270 Parameter type : i
271 Omittable : True
272 Default value : 0
273
274Command directory path : /vis/ASCIITree/set/
275
276
277Guidance :
278Settings for ASCIITree control.
279
280 Sub-directories :
281 Commands :
282 outFile * Set name of output file.
283
284
285Command /vis/ASCIITree/set/outFile
286Guidance :
287Set name of output file.
288
289Parameter : out-filename
290 Parameter type : s
291 Omittable : True
292 Default value : G4cout
293
294Command directory path : /vis/GAGTree/
295
296
297Guidance :
298Commands for GAGTree control.
299
300 Sub-directories :
301 Commands :
302 verbose * /vis/GAGTree/verbose [<verbosity>]
303
304
305Command /vis/GAGTree/verbose
306Guidance :
307/vis/GAGTree/verbose [<verbosity>]
3080 (default) mimimum - 10 maximum printing.
309
310Parameter : verbosity
311 Parameter type : i
312 Omittable : True
313 Default value : taken from the current value
314
315Command directory path : /vis/heprep/
316
317
318Guidance :
319HepRep commands.
320
321 Sub-directories :
322 Commands :
323 setEventNumberSuffix * Write separate event files, appended with given suffix.
324 appendGeometry * Appends copy of geometry to every event.
325 addPointAttributes * Adds point attributes to the points of trajectories.
326 useSolids * Use HepRep Solids, rather than Geant4 Primitives.
327
328
329Command /vis/heprep/setEventNumberSuffix
330Guidance :
331Write separate event files, appended with given suffix.
332Define the suffix with a pattern such as '-0000'.
333
334Parameter : suffix
335 Parameter type : s
336 Omittable : False
337
338
339
340Command /vis/heprep/appendGeometry
341Guidance :
342Appends copy of geometry to every event.
343
344Parameter : flag
345 Parameter type : b
346 Omittable : False
347 Default value : 1
348
349
350
351Command /vis/heprep/addPointAttributes
352Guidance :
353Adds point attributes to the points of trajectories.
354
355Parameter : flag
356 Parameter type : b
357 Omittable : False
358 Default value : 0
359
360
361
362Command /vis/heprep/useSolids
363Guidance :
364Use HepRep Solids, rather than Geant4 Primitives.
365
366Parameter : flag
367 Parameter type : b
368 Omittable : False
369 Default value : 1
370
371Command directory path : /vis/rayTracer/
372
373
374Guidance :
375RayTracer commands.
376
377 Sub-directories :
378 Commands :
379 trace * Start the ray tracing.
380 column * Define the number of horizontal pixels.
381 row * Define the number of virtical pixels.
382 target * Define the center position of the target.
383 eyePosition * Define the eye position.
384 lightDirection * Define the direction of illumination light.
385 span * Define the angle per 100 pixels.
386 headAngle * Define the head direction.
387 attenuation * Define the attenuation length for transparent material.
388 distortion * Distortion effect of the fish eye lens.
389 ignoreTransparency * Ignore transparency even if the alpha of G4Colour < 1.
390 backgroundColour * Command has been deprecated. Use /vis/viewer/set/background instead.
391
392
393Command /vis/rayTracer/trace
394Guidance :
395Start the ray tracing.
396Define the name of output JPEG file.
397
398Parameter : fileName
399 Parameter type : s
400 Omittable : True
401 Default value : g4RayTracer.jpeg
402
403
404
405Command /vis/rayTracer/column
406Guidance :
407Define the number of horizontal pixels.
408 Range of parameters : nPixel > 0
409
410Parameter : nPixel
411 Parameter type : i
412 Omittable : False
413
414
415
416Command /vis/rayTracer/row
417Guidance :
418Define the number of virtical pixels.
419 Range of parameters : nPixel > 0
420
421Parameter : nPixel
422 Parameter type : i
423 Omittable : False
424
425
426
427Command /vis/rayTracer/target
428Guidance :
429Define the center position of the target.
430
431Parameter : X
432 Parameter type : d
433 Omittable : True
434 Default value : 0
435
436Parameter : Y
437 Parameter type : d
438 Omittable : True
439 Default value : 0
440
441Parameter : Z
442 Parameter type : d
443 Omittable : True
444 Default value : 0
445
446Parameter : Unit
447 Parameter type : s
448 Omittable : True
449 Default value : m
450 Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
451
452
453
454Command /vis/rayTracer/eyePosition
455Guidance :
456Define the eye position.
457Eye direction is calsurated from (target - eyePosition).
458
459Parameter : X
460 Parameter type : d
461 Omittable : True
462 Default value : 0
463
464Parameter : Y
465 Parameter type : d
466 Omittable : True
467 Default value : 0
468
469Parameter : Z
470 Parameter type : d
471 Omittable : True
472 Default value : 0
473
474Parameter : Unit
475 Parameter type : s
476 Omittable : True
477 Default value : m
478 Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
479
480
481
482Command /vis/rayTracer/lightDirection
483Guidance :
484Define the direction of illumination light.
485The vector needs not to be a unit vector, but it must not be a zero vector.
486 Range of parameters : Px != 0 || Py != 0 || Pz != 0
487
488Parameter : Px
489 Parameter type : d
490 Omittable : True
491 Default value : 0.1
492
493Parameter : Py
494 Parameter type : d
495 Omittable : True
496 Default value : 0.2
497
498Parameter : Pz
499 Parameter type : d
500 Omittable : True
501 Default value : 0.3
502
503
504
505Command /vis/rayTracer/span
506Guidance :
507Define the angle per 100 pixels.
508 Range of parameters : span>0.
509
510Parameter : span
511 Parameter type : d
512 Omittable : True
513 Default value : 50
514
515Parameter : Unit
516 Parameter type : s
517 Omittable : True
518 Default value : deg
519 Candidates : rad mrad sr deg radian milliradian steradian degree
520
521
522
523Command /vis/rayTracer/headAngle
524Guidance :
525Define the head direction.
526 Range of parameters : headAngle>=0. && headAngle<360.
527
528Parameter : headAngle
529 Parameter type : d
530 Omittable : True
531 Default value : 270
532
533Parameter : Unit
534 Parameter type : s
535 Omittable : True
536 Default value : deg
537 Candidates : rad mrad sr deg radian milliradian steradian degree
538
539
540
541Command /vis/rayTracer/attenuation
542Guidance :
543Define the attenuation length for transparent material.
544Note that this value is independent to the attenuation length for the optical photon processes.
545 Range of parameters : Length > 0.
546
547Parameter : Length
548 Parameter type : d
549 Omittable : True
550 Default value : 1
551
552Parameter : Unit
553 Parameter type : s
554 Omittable : True
555 Default value : m
556 Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
557
558
559
560Command /vis/rayTracer/distortion
561Guidance :
562Distortion effect of the fish eye lens.
563
564Parameter : flag
565 Parameter type : b
566 Omittable : True
567 Default value : 0
568
569
570
571Command /vis/rayTracer/ignoreTransparency
572Guidance :
573Ignore transparency even if the alpha of G4Colour < 1.
574
575Parameter : flag
576 Parameter type : b
577 Omittable : True
578 Default value : 0
579
580
581
582Command /vis/rayTracer/backgroundColour
583Guidance :
584Command has been deprecated. Use /vis/viewer/set/background instead.
585
586Parameter : red
587 Parameter type : d
588 Omittable : True
589 Default value : 1
590
591Parameter : green
592 Parameter type : d
593 Omittable : True
594 Default value : 1
595
596Parameter : blue
597 Parameter type : d
598 Omittable : True
599 Default value : 1
600
601Command directory path : /vis/ogl/
602
603
604Guidance :
605G4OpenGLViewer commands.
606
607 Sub-directories :
608 /vis/ogl/set/ G4OpenGLViewer set commands.
609 Commands :
610Command directory path : /vis/ogl/set/
611
612
613Guidance :
614G4OpenGLViewer set commands.
615
616 Sub-directories :
617 Commands :
618 displayHeadTime * Display head time of range in 2D text.
619 displayLightFront * Display the light front at head time.
620 endTime * Set end and range of track time.
621 fade * 0: no fade; 1: maximum fade with time within range.
622 startTime * Set start and range of track time.
623 transparency * True/false to enable/disable rendering of transparent objects.
624
625
626Command /vis/ogl/set/displayHeadTime
627Guidance :
628Display head time of range in 2D text.
629
630Parameter : displayHeadTime
631 Parameter type : b
632 Omittable : False
633 Default value : 0
634
635Parameter : screenX
636-1 < screenX < 1
637 Parameter type : d
638 Omittable : True
639 Default value : -0.9
640 Parameter range : screenX >= -1. && screenX <= 1.
641
642Parameter : screenY
643-1 < screenY < 1
644 Parameter type : d
645 Omittable : True
646 Default value : -0.9
647 Parameter range : screenY >= -1. && screenY <= 1.
648
649Parameter : screenSize
650 Parameter type : d
651 Omittable : True
652 Default value : 24
653
654Parameter : red
655 Parameter type : d
656 Omittable : True
657 Default value : 0
658 Parameter range : red >= 0. && red <= 1.
659
660Parameter : green
661 Parameter type : d
662 Omittable : True
663 Default value : 1
664 Parameter range : green >= 0. && green <= 1.
665
666Parameter : blue
667 Parameter type : d
668 Omittable : True
669 Default value : 1
670 Parameter range : blue >= 0. && blue <= 1.
671
672
673
674Command /vis/ogl/set/displayLightFront
675Guidance :
676Display the light front at head time.
677Tip: The trajectories can appear of jump ahead of the light front
678because their time range overlaps the viewer's time range. To
679average out this discrete time effect, advance the light front by
680half the trajectories interval. E.g., if the trajectory time slice
681interval is 0.01 ns:
682 /vis/ogl/set/displayLightFront true -90 0 0 mm -0.005 ns
683To prevent them beating the light front at all:
684 /vis/ogl/set/displayLightFront true -90 0 0 mm -0.01 ns
685
686Parameter : displayLightFront
687 Parameter type : b
688 Omittable : False
689 Default value : 0
690
691Parameter : originX
692 Parameter type : d
693 Omittable : True
694 Default value : 0
695
696Parameter : originY
697 Parameter type : d
698 Omittable : True
699 Default value : 0
700
701Parameter : originZ
702 Parameter type : d
703 Omittable : True
704 Default value : 0
705
706Parameter : space_unit
707 Parameter type : s
708 Omittable : True
709 Default value : m
710
711Parameter : originT
712 Parameter type : d
713 Omittable : True
714 Default value : 0
715
716Parameter : time_unit
717 Parameter type : s
718 Omittable : True
719 Default value : s
720
721Parameter : red
722 Parameter type : d
723 Omittable : True
724 Default value : 0
725 Parameter range : red >= 0. && red <= 1.
726
727Parameter : green
728 Parameter type : d
729 Omittable : True
730 Default value : 1
731 Parameter range : green >= 0. && green <= 1.
732
733Parameter : blue
734 Parameter type : d
735 Omittable : True
736 Default value : 0
737 Parameter range : blue >= 0. && blue <= 1.
738
739
740
741Command /vis/ogl/set/endTime
742Guidance :
743Set end and range of track time.
744
745Parameter : end-time
746 Parameter type : d
747 Omittable : False
748 Default value : 1.79769e+308
749
750Parameter : end-time-unit
751 Parameter type : s
752 Omittable : False
753 Default value : ns
754
755Parameter : time-range
756 Parameter type : d
757 Omittable : True
758 Default value : -1
759
760Parameter : time-range-unit
761 Parameter type : s
762 Omittable : True
763 Default value : ns
764
765
766
767Command /vis/ogl/set/fade
768Guidance :
7690: no fade; 1: maximum fade with time within range.
770 Range of parameters : fadefactor>=0.&&fadefactor<=1.
771
772Parameter : fadefactor
773 Parameter type : d
774 Omittable : False
775 Default value : 0
776
777
778
779Command /vis/ogl/set/startTime
780Guidance :
781Set start and range of track time.
782
783Parameter : start-time
784 Parameter type : d
785 Omittable : False
786 Default value : -1.79769e+308
787
788Parameter : start-time-unit
789 Parameter type : s
790 Omittable : False
791 Default value : ns
792
793Parameter : time-range
794 Parameter type : d
795 Omittable : True
796 Default value : -1
797
798Parameter : time-range-unit
799 Parameter type : s
800 Omittable : True
801 Default value : ns
802
803
804
805Command /vis/ogl/set/transparency
806Guidance :
807True/false to enable/disable rendering of transparent objects.
808
809Parameter : transparency-enabled
810 Parameter type : b
811 Omittable : True
812 Default value : 1
813
814Command directory path : /vis/oglx/
815
816
817Guidance :
818G4OpenGLXViewer commands.
819
820 Sub-directories :
821 Commands :
822 printEPS * Print Encapsulated PostScript file.
823
824
825Command /vis/oglx/printEPS
826Guidance :
827Print Encapsulated PostScript file.
828Generates files with names G4OpenGL_n.eps, where n is a sequence
829number, starting at 0.
830
831Command directory path : /vis/oglxm/
832
833
834Guidance :
835G4OpenGLXmViewer commands.
836
837 Sub-directories :
838 /vis/oglxm/set/ G4OpenGLXmViewer set commands.
839 Commands :
840Command directory path : /vis/oglxm/set/
841
842
843Guidance :
844G4OpenGLXmViewer set commands.
845
846 Sub-directories :
847 Commands :
848 dolly-high * Higher limit of dolly slider.
849 dolly-low * Lower limit of dolly slider.
850 pan-high * Higher limit of pan slider.
851 rotation-high * Higher limit of rotation slider.
852 zoom-high * Higher limit of zoom slider.
853 zoom-low * Lower limit of zoom slider.
854
855
856Command /vis/oglxm/set/dolly-high
857Guidance :
858Higher limit of dolly slider.
859
860Parameter : dolly-high
861 Parameter type : d
862 Omittable : False
863
864Parameter : Unit
865 Parameter type : s
866 Omittable : False
867
868
869
870Command /vis/oglxm/set/dolly-low
871Guidance :
872Lower limit of dolly slider.
873
874Parameter : dolly-low
875 Parameter type : d
876 Omittable : False
877
878Parameter : Unit
879 Parameter type : s
880 Omittable : False
881
882
883
884Command /vis/oglxm/set/pan-high
885Guidance :
886Higher limit of pan slider.
887
888Parameter : pan-high
889 Parameter type : d
890 Omittable : False
891
892Parameter : Unit
893 Parameter type : s
894 Omittable : False
895
896
897
898Command /vis/oglxm/set/rotation-high
899Guidance :
900Higher limit of rotation slider.
901
902Parameter : rotation-high
903 Parameter type : d
904 Omittable : False
905
906Parameter : Unit
907 Parameter type : s
908 Omittable : False
909
910
911
912Command /vis/oglxm/set/zoom-high
913Guidance :
914Higher limit of zoom slider.
915
916Parameter : zoom-high
917 Parameter type : d
918 Omittable : False
919
920
921
922Command /vis/oglxm/set/zoom-low
923Guidance :
924Lower limit of zoom slider.
925
926Parameter : zoom-low
927 Parameter type : d
928 Omittable : False
929
930Command directory path : /vis/modeling/
931
932
933Guidance :
934Modeling commands.
935
936 Sub-directories :
937 /vis/modeling/trajectories/ Trajectory model commands.
938 Commands :
939Command directory path : /vis/modeling/trajectories/
940
941
942Guidance :
943Trajectory model commands.
944
945 Sub-directories :
946 /vis/modeling/trajectories/create/ Create trajectory models and messengers.
947 /vis/modeling/trajectories/generic-0/ Commands for generic-0 model.
948 /vis/modeling/trajectories/drawByCharge-0/ Commands for drawByCharge-0 model.
949 /vis/modeling/trajectories/drawByParticleID-0/ Commands for drawByParticleID-0 model.
950 /vis/modeling/trajectories/drawByOriginVolume-0/ Commands for drawByOriginVolume-0 model.
951 /vis/modeling/trajectories/drawByAttribute-0/ Commands for drawByAttribute-0 model.
952 Commands :
953 list * List objects registered with list manager
954 select * Select created object
955
956
957Command /vis/modeling/trajectories/list
958Guidance :
959List objects registered with list manager
960
961Parameter : name
962 Parameter type : s
963 Omittable : True
964
965
966
967Command /vis/modeling/trajectories/select
968Guidance :
969Select created object
970
971Parameter : name
972 Parameter type : s
973 Omittable : False
974
975Command directory path : /vis/modeling/trajectories/create/
976
977
978Guidance :
979Create trajectory models and messengers.
980
981 Sub-directories :
982 Commands :
983 generic * Create a generic model and associated messengers.
984 drawByCharge * Create a drawByCharge model and associated messengers.
985 drawByParticleID * Create a drawByParticleID model and associated messengers.
986 drawByOriginVolume * Create a drawByOriginVolume model and associated messengers.
987 drawByAttribute * Create a drawByAttribute model and associated messengers.
988
989
990Command /vis/modeling/trajectories/create/generic
991Guidance :
992Create a generic model and associated messengers.
993Generated model becomes current.
994
995Parameter : model-name
996 Parameter type : s
997 Omittable : True
998
999
1000
1001Command /vis/modeling/trajectories/create/drawByCharge
1002Guidance :
1003Create a drawByCharge model and associated messengers.
1004Generated model becomes current.
1005
1006Parameter : model-name
1007 Parameter type : s
1008 Omittable : True
1009
1010
1011
1012Command /vis/modeling/trajectories/create/drawByParticleID
1013Guidance :
1014Create a drawByParticleID model and associated messengers.
1015Generated model becomes current.
1016
1017Parameter : model-name
1018 Parameter type : s
1019 Omittable : True
1020
1021
1022
1023Command /vis/modeling/trajectories/create/drawByOriginVolume
1024Guidance :
1025Create a drawByOriginVolume model and associated messengers.
1026Generated model becomes current.
1027
1028Parameter : model-name
1029 Parameter type : s
1030 Omittable : True
1031
1032
1033
1034Command /vis/modeling/trajectories/create/drawByAttribute
1035Guidance :
1036Create a drawByAttribute model and associated messengers.
1037Generated model becomes current.
1038
1039Parameter : model-name
1040 Parameter type : s
1041 Omittable : True
1042
1043Command directory path : /vis/modeling/trajectories/generic-0/
1044
1045
1046Guidance :
1047Commands for generic-0 model.
1048
1049 Sub-directories :
1050 /vis/modeling/trajectories/generic-0/default/ Commands for default configuration
1051 Commands :
1052 verbose * Verbose command
1053
1054
1055Command /vis/modeling/trajectories/generic-0/verbose
1056Guidance :
1057Verbose command
1058
1059Parameter : Bool
1060 Parameter type : b
1061 Omittable : False
1062
1063Command directory path : /vis/modeling/trajectories/generic-0/default/
1064
1065
1066Guidance :
1067Commands for default configuration
1068
1069 Sub-directories :
1070 Commands :
1071 setDrawLine * Set draw line command
1072 setLineVisible * Set line visibility command
1073 setLineColour * Set colour through a string
1074 setLineColourRGBA * Set colour through red, green, blue and alpha components
1075 setDrawStepPts * Set draw step points command
1076 setStepPtsVisible * Set step points visible command
1077 setStepPtsColour * Set colour through a string
1078 setStepPtsColourRGBA * Set colour through red, green, blue and alpha components
1079 setStepPtsSize * Set step points size command
1080 setStepPtsType * Set step points type.
1081 setStepPtsFillStyle * Set step fill style type.
1082 setDrawAuxPts * Set draw auxiliary points command
1083 setAuxPtsVisible * Set auxiliary points visibility command
1084 setAuxPtsColour * Set colour through a string
1085 setAuxPtsColourRGBA * Set colour through red, green, blue and alpha components
1086 setAuxPtsSize * Set auxiliary points size command
1087 setAuxPtsType * Set auxiliary points type.
1088 setAuxPtsFillStyle * Set auxiliary fill style.
1089 setTimeSliceInterval * Set time slice interval. Give unit, e.g., "0.1 ns"
1090
1091
1092Command /vis/modeling/trajectories/generic-0/default/setDrawLine
1093Guidance :
1094Set draw line command
1095
1096Parameter : Bool
1097 Parameter type : b
1098 Omittable : False
1099
1100
1101
1102Command /vis/modeling/trajectories/generic-0/default/setLineVisible
1103Guidance :
1104Set line visibility command
1105
1106Parameter : Bool
1107 Parameter type : b
1108 Omittable : False
1109
1110
1111
1112Command /vis/modeling/trajectories/generic-0/default/setLineColour
1113Guidance :
1114Set colour through a string
1115
1116Parameter : Variable
1117 Parameter type : s
1118 Omittable : False
1119
1120
1121
1122Command /vis/modeling/trajectories/generic-0/default/setLineColourRGBA
1123Guidance :
1124Set colour through red, green, blue and alpha components
1125Four inputs are expected.
1126
1127Parameter : Red component
1128 Parameter type : d
1129 Omittable : False
1130
1131Parameter : Green component
1132 Parameter type : d
1133 Omittable : False
1134
1135Parameter : Blue component
1136 Parameter type : d
1137 Omittable : False
1138
1139Parameter : Alpha component
1140 Parameter type : d
1141 Omittable : False
1142
1143
1144
1145Command /vis/modeling/trajectories/generic-0/default/setDrawStepPts
1146Guidance :
1147Set draw step points command
1148
1149Parameter : Bool
1150 Parameter type : b
1151 Omittable : False
1152
1153
1154
1155Command /vis/modeling/trajectories/generic-0/default/setStepPtsVisible
1156Guidance :
1157Set step points visible command
1158
1159Parameter : Bool
1160 Parameter type : b
1161 Omittable : False
1162
1163
1164
1165Command /vis/modeling/trajectories/generic-0/default/setStepPtsColour
1166Guidance :
1167Set colour through a string
1168
1169Parameter : Variable
1170 Parameter type : s
1171 Omittable : False
1172
1173
1174
1175Command /vis/modeling/trajectories/generic-0/default/setStepPtsColourRGBA
1176Guidance :
1177Set colour through red, green, blue and alpha components
1178Four inputs are expected.
1179
1180Parameter : Red component
1181 Parameter type : d
1182 Omittable : False
1183
1184Parameter : Green component
1185 Parameter type : d
1186 Omittable : False
1187
1188Parameter : Blue component
1189 Parameter type : d
1190 Omittable : False
1191
1192Parameter : Alpha component
1193 Parameter type : d
1194 Omittable : False
1195
1196
1197
1198Command /vis/modeling/trajectories/generic-0/default/setStepPtsSize
1199Guidance :
1200Set step points size command
1201
1202Parameter : Double
1203 Parameter type : d
1204 Omittable : False
1205
1206
1207
1208Command /vis/modeling/trajectories/generic-0/default/setStepPtsType
1209Guidance :
1210Set step points type.
1211
1212Parameter :
1213 Parameter type : s
1214 Omittable : False
1215 Candidates : dots circles squares
1216
1217
1218
1219Command /vis/modeling/trajectories/generic-0/default/setStepPtsFillStyle
1220Guidance :
1221Set step fill style type.
1222
1223Parameter :
1224 Parameter type : s
1225 Omittable : False
1226 Candidates : noFill hashed filled
1227
1228
1229
1230Command /vis/modeling/trajectories/generic-0/default/setDrawAuxPts
1231Guidance :
1232Set draw auxiliary points command
1233
1234Parameter : Bool
1235 Parameter type : b
1236 Omittable : False
1237
1238
1239
1240Command /vis/modeling/trajectories/generic-0/default/setAuxPtsVisible
1241Guidance :
1242Set auxiliary points visibility command
1243
1244Parameter : Bool
1245 Parameter type : b
1246 Omittable : False
1247
1248
1249
1250Command /vis/modeling/trajectories/generic-0/default/setAuxPtsColour
1251Guidance :
1252Set colour through a string
1253
1254Parameter : Variable
1255 Parameter type : s
1256 Omittable : False
1257
1258
1259
1260Command /vis/modeling/trajectories/generic-0/default/setAuxPtsColourRGBA
1261Guidance :
1262Set colour through red, green, blue and alpha components
1263Four inputs are expected.
1264
1265Parameter : Red component
1266 Parameter type : d
1267 Omittable : False
1268
1269Parameter : Green component
1270 Parameter type : d
1271 Omittable : False
1272
1273Parameter : Blue component
1274 Parameter type : d
1275 Omittable : False
1276
1277Parameter : Alpha component
1278 Parameter type : d
1279 Omittable : False
1280
1281
1282
1283Command /vis/modeling/trajectories/generic-0/default/setAuxPtsSize
1284Guidance :
1285Set auxiliary points size command
1286
1287Parameter : Double
1288 Parameter type : d
1289 Omittable : False
1290
1291
1292
1293Command /vis/modeling/trajectories/generic-0/default/setAuxPtsType
1294Guidance :
1295Set auxiliary points type.
1296
1297Parameter :
1298 Parameter type : s
1299 Omittable : False
1300 Candidates : dots circles squares
1301
1302
1303
1304Command /vis/modeling/trajectories/generic-0/default/setAuxPtsFillStyle
1305Guidance :
1306Set auxiliary fill style.
1307
1308Parameter :
1309 Parameter type : s
1310 Omittable : False
1311 Candidates : noFill hashed filled
1312
1313
1314
1315Command /vis/modeling/trajectories/generic-0/default/setTimeSliceInterval
1316Guidance :
1317Set time slice interval. Give unit, e.g., "0.1 ns"
1318
1319Parameter : DoubleAndUnit
1320 Parameter type : d
1321 Omittable : False
1322
1323Parameter : Unit
1324 Parameter type : s
1325 Omittable : False
1326 Candidates : s ms mus ns ps second millisecond microsecond nanosecond picosecond
1327
1328Command directory path : /vis/modeling/trajectories/drawByCharge-0/
1329
1330
1331Guidance :
1332Commands for drawByCharge-0 model.
1333
1334 Sub-directories :
1335 /vis/modeling/trajectories/drawByCharge-0/default/ Commands for default configuration
1336 Commands :
1337 set * Set variable colour through a string
1338 setRGBA * Set variable colour through red, green, blue and alpha components
1339 verbose * Verbose command
1340
1341
1342Command /vis/modeling/trajectories/drawByCharge-0/set
1343Guidance :
1344Set variable colour through a string
1345
1346Parameter : Variable
1347 Parameter type : s
1348 Omittable : False
1349
1350Parameter : Value
1351 Parameter type : s
1352 Omittable : False
1353
1354
1355
1356Command /vis/modeling/trajectories/drawByCharge-0/setRGBA
1357Guidance :
1358Set variable colour through red, green, blue and alpha components
1359
1360Parameter : Variable
1361 Parameter type : s
1362 Omittable : False
1363
1364Parameter : Red component
1365 Parameter type : d
1366 Omittable : False
1367
1368Parameter : Green component
1369 Parameter type : d
1370 Omittable : False
1371
1372Parameter : Blue component
1373 Parameter type : d
1374 Omittable : False
1375
1376Parameter : Alpha component
1377 Parameter type : d
1378 Omittable : False
1379
1380
1381
1382Command /vis/modeling/trajectories/drawByCharge-0/verbose
1383Guidance :
1384Verbose command
1385
1386Parameter : Bool
1387 Parameter type : b
1388 Omittable : False
1389
1390Command directory path : /vis/modeling/trajectories/drawByCharge-0/default/
1391
1392
1393Guidance :
1394Commands for default configuration
1395
1396 Sub-directories :
1397 Commands :
1398 setDrawLine * Set draw line command
1399 setLineVisible * Set line visibility command
1400 setLineColour * Set colour through a string
1401 setLineColourRGBA * Set colour through red, green, blue and alpha components
1402 setDrawStepPts * Set draw step points command
1403 setStepPtsVisible * Set step points visible command
1404 setStepPtsColour * Set colour through a string
1405 setStepPtsColourRGBA * Set colour through red, green, blue and alpha components
1406 setStepPtsSize * Set step points size command
1407 setStepPtsType * Set step points type.
1408 setStepPtsFillStyle * Set step fill style type.
1409 setDrawAuxPts * Set draw auxiliary points command
1410 setAuxPtsVisible * Set auxiliary points visibility command
1411 setAuxPtsColour * Set colour through a string
1412 setAuxPtsColourRGBA * Set colour through red, green, blue and alpha components
1413 setAuxPtsSize * Set auxiliary points size command
1414 setAuxPtsType * Set auxiliary points type.
1415 setAuxPtsFillStyle * Set auxiliary fill style.
1416 setTimeSliceInterval * Set time slice interval. Give unit, e.g., "0.1 ns"
1417
1418
1419Command /vis/modeling/trajectories/drawByCharge-0/default/setDrawLine
1420Guidance :
1421Set draw line command
1422
1423Parameter : Bool
1424 Parameter type : b
1425 Omittable : False
1426
1427
1428
1429Command /vis/modeling/trajectories/drawByCharge-0/default/setLineVisible
1430Guidance :
1431Set line visibility command
1432
1433Parameter : Bool
1434 Parameter type : b
1435 Omittable : False
1436
1437
1438
1439Command /vis/modeling/trajectories/drawByCharge-0/default/setLineColour
1440Guidance :
1441Set colour through a string
1442
1443Parameter : Variable
1444 Parameter type : s
1445 Omittable : False
1446
1447
1448
1449Command /vis/modeling/trajectories/drawByCharge-0/default/setLineColourRGBA
1450Guidance :
1451Set colour through red, green, blue and alpha components
1452Four inputs are expected.
1453
1454Parameter : Red component
1455 Parameter type : d
1456 Omittable : False
1457
1458Parameter : Green component
1459 Parameter type : d
1460 Omittable : False
1461
1462Parameter : Blue component
1463 Parameter type : d
1464 Omittable : False
1465
1466Parameter : Alpha component
1467 Parameter type : d
1468 Omittable : False
1469
1470
1471
1472Command /vis/modeling/trajectories/drawByCharge-0/default/setDrawStepPts
1473Guidance :
1474Set draw step points command
1475
1476Parameter : Bool
1477 Parameter type : b
1478 Omittable : False
1479
1480
1481
1482Command /vis/modeling/trajectories/drawByCharge-0/default/setStepPtsVisible
1483Guidance :
1484Set step points visible command
1485
1486Parameter : Bool
1487 Parameter type : b
1488 Omittable : False
1489
1490
1491
1492Command /vis/modeling/trajectories/drawByCharge-0/default/setStepPtsColour
1493Guidance :
1494Set colour through a string
1495
1496Parameter : Variable
1497 Parameter type : s
1498 Omittable : False
1499
1500
1501
1502Command /vis/modeling/trajectories/drawByCharge-0/default/setStepPtsColourRGBA
1503Guidance :
1504Set colour through red, green, blue and alpha components
1505Four inputs are expected.
1506
1507Parameter : Red component
1508 Parameter type : d
1509 Omittable : False
1510
1511Parameter : Green component
1512 Parameter type : d
1513 Omittable : False
1514
1515Parameter : Blue component
1516 Parameter type : d
1517 Omittable : False
1518
1519Parameter : Alpha component
1520 Parameter type : d
1521 Omittable : False
1522
1523
1524
1525Command /vis/modeling/trajectories/drawByCharge-0/default/setStepPtsSize
1526Guidance :
1527Set step points size command
1528
1529Parameter : Double
1530 Parameter type : d
1531 Omittable : False
1532
1533
1534
1535Command /vis/modeling/trajectories/drawByCharge-0/default/setStepPtsType
1536Guidance :
1537Set step points type.
1538
1539Parameter :
1540 Parameter type : s
1541 Omittable : False
1542 Candidates : dots circles squares
1543
1544
1545
1546Command /vis/modeling/trajectories/drawByCharge-0/default/setStepPtsFillStyle
1547Guidance :
1548Set step fill style type.
1549
1550Parameter :
1551 Parameter type : s
1552 Omittable : False
1553 Candidates : noFill hashed filled
1554
1555
1556
1557Command /vis/modeling/trajectories/drawByCharge-0/default/setDrawAuxPts
1558Guidance :
1559Set draw auxiliary points command
1560
1561Parameter : Bool
1562 Parameter type : b
1563 Omittable : False
1564
1565
1566
1567Command /vis/modeling/trajectories/drawByCharge-0/default/setAuxPtsVisible
1568Guidance :
1569Set auxiliary points visibility command
1570
1571Parameter : Bool
1572 Parameter type : b
1573 Omittable : False
1574
1575
1576
1577Command /vis/modeling/trajectories/drawByCharge-0/default/setAuxPtsColour
1578Guidance :
1579Set colour through a string
1580
1581Parameter : Variable
1582 Parameter type : s
1583 Omittable : False
1584
1585
1586
1587Command /vis/modeling/trajectories/drawByCharge-0/default/setAuxPtsColourRGBA
1588Guidance :
1589Set colour through red, green, blue and alpha components
1590Four inputs are expected.
1591
1592Parameter : Red component
1593 Parameter type : d
1594 Omittable : False
1595
1596Parameter : Green component
1597 Parameter type : d
1598 Omittable : False
1599
1600Parameter : Blue component
1601 Parameter type : d
1602 Omittable : False
1603
1604Parameter : Alpha component
1605 Parameter type : d
1606 Omittable : False
1607
1608
1609
1610Command /vis/modeling/trajectories/drawByCharge-0/default/setAuxPtsSize
1611Guidance :
1612Set auxiliary points size command
1613
1614Parameter : Double
1615 Parameter type : d
1616 Omittable : False
1617
1618
1619
1620Command /vis/modeling/trajectories/drawByCharge-0/default/setAuxPtsType
1621Guidance :
1622Set auxiliary points type.
1623
1624Parameter :
1625 Parameter type : s
1626 Omittable : False
1627 Candidates : dots circles squares
1628
1629
1630
1631Command /vis/modeling/trajectories/drawByCharge-0/default/setAuxPtsFillStyle
1632Guidance :
1633Set auxiliary fill style.
1634
1635Parameter :
1636 Parameter type : s
1637 Omittable : False
1638 Candidates : noFill hashed filled
1639
1640
1641
1642Command /vis/modeling/trajectories/drawByCharge-0/default/setTimeSliceInterval
1643Guidance :
1644Set time slice interval. Give unit, e.g., "0.1 ns"
1645
1646Parameter : DoubleAndUnit
1647 Parameter type : d
1648 Omittable : False
1649
1650Parameter : Unit
1651 Parameter type : s
1652 Omittable : False
1653 Candidates : s ms mus ns ps second millisecond microsecond nanosecond picosecond
1654
1655Command directory path : /vis/modeling/trajectories/drawByParticleID-0/
1656
1657
1658Guidance :
1659Commands for drawByParticleID-0 model.
1660
1661 Sub-directories :
1662 /vis/modeling/trajectories/drawByParticleID-0/default/ Commands for default configuration
1663 Commands :
1664 set * Set variable colour through a string
1665 setRGBA * Set variable colour through red, green, blue and alpha components
1666 setDefault * Set colour through a string
1667 setDefaultRGBA * Set colour through red, green, blue and alpha components
1668 verbose * Verbose command
1669
1670
1671Command /vis/modeling/trajectories/drawByParticleID-0/set
1672Guidance :
1673Set variable colour through a string
1674
1675Parameter : Variable
1676 Parameter type : s
1677 Omittable : False
1678
1679Parameter : Value
1680 Parameter type : s
1681 Omittable : False
1682
1683
1684
1685Command /vis/modeling/trajectories/drawByParticleID-0/setRGBA
1686Guidance :
1687Set variable colour through red, green, blue and alpha components
1688
1689Parameter : Variable
1690 Parameter type : s
1691 Omittable : False
1692
1693Parameter : Red component
1694 Parameter type : d
1695 Omittable : False
1696
1697Parameter : Green component
1698 Parameter type : d
1699 Omittable : False
1700
1701Parameter : Blue component
1702 Parameter type : d
1703 Omittable : False
1704
1705Parameter : Alpha component
1706 Parameter type : d
1707 Omittable : False
1708
1709
1710
1711Command /vis/modeling/trajectories/drawByParticleID-0/setDefault
1712Guidance :
1713Set colour through a string
1714
1715Parameter : Variable
1716 Parameter type : s
1717 Omittable : False
1718
1719
1720
1721Command /vis/modeling/trajectories/drawByParticleID-0/setDefaultRGBA
1722Guidance :
1723Set colour through red, green, blue and alpha components
1724Four inputs are expected.
1725
1726Parameter : Red component
1727 Parameter type : d
1728 Omittable : False
1729
1730Parameter : Green component
1731 Parameter type : d
1732 Omittable : False
1733
1734Parameter : Blue component
1735 Parameter type : d
1736 Omittable : False
1737
1738
1739Parameter : Alpha component
1740 Parameter type : d
1741 Omittable : False
1742
1743
1744
1745Command /vis/modeling/trajectories/drawByParticleID-0/verbose
1746Guidance :
1747Verbose command
1748
1749Parameter : Bool
1750 Parameter type : b
1751 Omittable : False
1752
1753Command directory path : /vis/modeling/trajectories/drawByParticleID-0/default/
1754
1755
1756Guidance :
1757Commands for default configuration
1758
1759 Sub-directories :
1760 Commands :
1761 setDrawLine * Set draw line command
1762 setLineVisible * Set line visibility command
1763 setLineColour * Set colour through a string
1764 setLineColourRGBA * Set colour through red, green, blue and alpha components
1765 setDrawStepPts * Set draw step points command
1766 setStepPtsVisible * Set step points visible command
1767 setStepPtsColour * Set colour through a string
1768 setStepPtsColourRGBA * Set colour through red, green, blue and alpha components
1769 setStepPtsSize * Set step points size command
1770 setStepPtsType * Set step points type.
1771 setStepPtsFillStyle * Set step fill style type.
1772 setDrawAuxPts * Set draw auxiliary points command
1773 setAuxPtsVisible * Set auxiliary points visibility command
1774 setAuxPtsColour * Set colour through a string
1775 setAuxPtsColourRGBA * Set colour through red, green, blue and alpha components
1776 setAuxPtsSize * Set auxiliary points size command
1777 setAuxPtsType * Set auxiliary points type.
1778 setAuxPtsFillStyle * Set auxiliary fill style.
1779 setTimeSliceInterval * Set time slice interval. Give unit, e.g., "0.1 ns"
1780
1781
1782Command /vis/modeling/trajectories/drawByParticleID-0/default/setDrawLine
1783Guidance :
1784Set draw line command
1785
1786Parameter : Bool
1787 Parameter type : b
1788 Omittable : False
1789
1790
1791
1792Command /vis/modeling/trajectories/drawByParticleID-0/default/setLineVisible
1793Guidance :
1794Set line visibility command
1795
1796Parameter : Bool
1797 Parameter type : b
1798 Omittable : False
1799
1800
1801
1802Command /vis/modeling/trajectories/drawByParticleID-0/default/setLineColour
1803Guidance :
1804Set colour through a string
1805
1806Parameter : Variable
1807 Parameter type : s
1808
1809 Omittable : False
1810
1811
1812
1813Command /vis/modeling/trajectories/drawByParticleID-0/default/setLineColourRGBA
1814Guidance :
1815Set colour through red, green, blue and alpha components
1816Four inputs are expected.
1817
1818Parameter : Red component
1819 Parameter type : d
1820 Omittable : False
1821
1822Parameter : Green component
1823 Parameter type : d
1824 Omittable : False
1825
1826Parameter : Blue component
1827 Parameter type : d
1828 Omittable : False
1829
1830Parameter : Alpha component
1831 Parameter type : d
1832 Omittable : False
1833
1834
1835
1836Command /vis/modeling/trajectories/drawByParticleID-0/default/setDrawStepPts
1837Guidance :
1838Set draw step points command
1839
1840Parameter : Bool
1841 Parameter type : b
1842 Omittable : False
1843
1844
1845
1846Command /vis/modeling/trajectories/drawByParticleID-0/default/setStepPtsVisible
1847Guidance :
1848Set step points visible command
1849
1850Parameter : Bool
1851 Parameter type : b
1852 Omittable : False
1853
1854
1855
1856Command /vis/modeling/trajectories/drawByParticleID-0/default/setStepPtsColour
1857Guidance :
1858Set colour through a string
1859
1860Parameter : Variable
1861 Parameter type : s
1862 Omittable : False
1863
1864
1865
1866Command /vis/modeling/trajectories/drawByParticleID-0/default/setStepPtsColourRGBA
1867Guidance :
1868Set colour through red, green, blue and alpha components
1869Four inputs are expected.
1870
1871Parameter : Red component
1872 Parameter type : d
1873 Omittable : False
1874
1875Parameter : Green component
1876 Parameter type : d
1877 Omittable : False
1878
1879Parameter : Blue component
1880 Parameter type : d
1881 Omittable : False
1882
1883Parameter : Alpha component
1884 Parameter type : d
1885 Omittable : False
1886
1887
1888
1889Command /vis/modeling/trajectories/drawByParticleID-0/default/setStepPtsSize
1890Guidance :
1891Set step points size command
1892
1893Parameter : Double
1894 Parameter type : d
1895 Omittable : False
1896
1897
1898
1899Command /vis/modeling/trajectories/drawByParticleID-0/default/setStepPtsType
1900Guidance :
1901Set step points type.
1902
1903Parameter :
1904 Parameter type : s
1905 Omittable : False
1906 Candidates : dots circles squares
1907
1908
1909
1910Command /vis/modeling/trajectories/drawByParticleID-0/default/setStepPtsFillStyle
1911Guidance :
1912Set step fill style type.
1913
1914Parameter :
1915 Parameter type : s
1916 Omittable : False
1917 Candidates : noFill hashed filled
1918
1919
1920
1921Command /vis/modeling/trajectories/drawByParticleID-0/default/setDrawAuxPts
1922Guidance :
1923Set draw auxiliary points command
1924
1925Parameter : Bool
1926 Parameter type : b
1927 Omittable : False
1928
1929
1930
1931Command /vis/modeling/trajectories/drawByParticleID-0/default/setAuxPtsVisible
1932Guidance :
1933Set auxiliary points visibility command
1934
1935Parameter : Bool
1936 Parameter type : b
1937 Omittable : False
1938
1939
1940
1941Command /vis/modeling/trajectories/drawByParticleID-0/default/setAuxPtsColour
1942Guidance :
1943Set colour through a string
1944
1945Parameter : Variable
1946 Parameter type : s
1947 Omittable : False
1948
1949
1950
1951Command /vis/modeling/trajectories/drawByParticleID-0/default/setAuxPtsColourRGBA
1952Guidance :
1953Set colour through red, green, blue and alpha components
1954Four inputs are expected.
1955
1956Parameter : Red component
1957 Parameter type : d
1958 Omittable : False
1959
1960Parameter : Green component
1961 Parameter type : d
1962 Omittable : False
1963
1964Parameter : Blue component
1965 Parameter type : d
1966 Omittable : False
1967
1968Parameter : Alpha component
1969 Parameter type : d
1970 Omittable : False
1971
1972
1973
1974Command /vis/modeling/trajectories/drawByParticleID-0/default/setAuxPtsSize
1975Guidance :
1976Set auxiliary points size command
1977
1978Parameter : Double
1979 Parameter type : d
1980 Omittable : False
1981
1982
1983
1984Command /vis/modeling/trajectories/drawByParticleID-0/default/setAuxPtsType
1985Guidance :
1986Set auxiliary points type.
1987
1988Parameter :
1989 Parameter type : s
1990 Omittable : False
1991 Candidates : dots circles squares
1992
1993
1994
1995Command /vis/modeling/trajectories/drawByParticleID-0/default/setAuxPtsFillStyle
1996Guidance :
1997Set auxiliary fill style.
1998
1999Parameter :
2000 Parameter type : s
2001 Omittable : False
2002 Candidates : noFill hashed filled
2003
2004
2005
2006Command /vis/modeling/trajectories/drawByParticleID-0/default/setTimeSliceInterval
2007Guidance :
2008Set time slice interval. Give unit, e.g., "0.1 ns"
2009
2010Parameter : DoubleAndUnit
2011 Parameter type : d
2012 Omittable : False
2013
2014Parameter : Unit
2015 Parameter type : s
2016 Omittable : False
2017 Candidates : s ms mus ns ps second millisecond microsecond nanosecond picosecond
2018
2019Command directory path : /vis/modeling/trajectories/drawByOriginVolume-0/
2020
2021
2022Guidance :
2023Commands for drawByOriginVolume-0 model.
2024
2025 Sub-directories :
2026 /vis/modeling/trajectories/drawByOriginVolume-0/default/ Commands for default configuration
2027 Commands :
2028 set * Set variable colour through a string
2029 setRGBA * Set variable colour through red, green, blue and alpha components
2030 setDefault * Set colour through a string
2031 setDefaultRGBA * Set colour through red, green, blue and alpha components
2032 verbose * Verbose command
2033
2034
2035Command /vis/modeling/trajectories/drawByOriginVolume-0/set
2036Guidance :
2037Set variable colour through a string
2038
2039Parameter : Variable
2040 Parameter type : s
2041 Omittable : False
2042
2043Parameter : Value
2044 Parameter type : s
2045 Omittable : False
2046
2047
2048
2049Command /vis/modeling/trajectories/drawByOriginVolume-0/setRGBA
2050Guidance :
2051Set variable colour through red, green, blue and alpha components
2052
2053Parameter : Variable
2054 Parameter type : s
2055 Omittable : False
2056
2057Parameter : Red component
2058 Parameter type : d
2059 Omittable : False
2060
2061Parameter : Green component
2062 Parameter type : d
2063 Omittable : False
2064
2065Parameter : Blue component
2066 Parameter type : d
2067 Omittable : False
2068
2069Parameter : Alpha component
2070 Parameter type : d
2071 Omittable : False
2072
2073
2074
2075Command /vis/modeling/trajectories/drawByOriginVolume-0/setDefault
2076Guidance :
2077Set colour through a string
2078
2079Parameter : Variable
2080 Parameter type : s
2081 Omittable : False
2082
2083
2084
2085Command /vis/modeling/trajectories/drawByOriginVolume-0/setDefaultRGBA
2086Guidance :
2087Set colour through red, green, blue and alpha components
2088Four inputs are expected.
2089
2090Parameter : Red component
2091 Parameter type : d
2092 Omittable : False
2093
2094Parameter : Green component
2095 Parameter type : d
2096 Omittable : False
2097
2098Parameter : Blue component
2099 Parameter type : d
2100 Omittable : False
2101
2102Parameter : Alpha component
2103 Parameter type : d
2104 Omittable : False
2105
2106
2107
2108Command /vis/modeling/trajectories/drawByOriginVolume-0/verbose
2109Guidance :
2110Verbose command
2111
2112Parameter : Bool
2113 Parameter type : b
2114 Omittable : False
2115
2116Command directory path : /vis/modeling/trajectories/drawByOriginVolume-0/default/
2117
2118
2119Guidance :
2120Commands for default configuration
2121
2122 Sub-directories :
2123 Commands :
2124 setDrawLine * Set draw line command
2125 setLineVisible * Set line visibility command
2126 setLineColour * Set colour through a string
2127 setLineColourRGBA * Set colour through red, green, blue and alpha components
2128 setDrawStepPts * Set draw step points command
2129 setStepPtsVisible * Set step points visible command
2130 setStepPtsColour * Set colour through a string
2131 setStepPtsColourRGBA * Set colour through red, green, blue and alpha components
2132 setStepPtsSize * Set step points size command
2133 setStepPtsType * Set step points type.
2134 setStepPtsFillStyle * Set step fill style type.
2135 setDrawAuxPts * Set draw auxiliary points command
2136 setAuxPtsVisible * Set auxiliary points visibility command
2137 setAuxPtsColour * Set colour through a string
2138 setAuxPtsColourRGBA * Set colour through red, green, blue and alpha components
2139 setAuxPtsSize * Set auxiliary points size command
2140 setAuxPtsType * Set auxiliary points type.
2141 setAuxPtsFillStyle * Set auxiliary fill style.
2142 setTimeSliceInterval * Set time slice interval. Give unit, e.g., "0.1 ns"
2143
2144
2145Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setDrawLine
2146Guidance :
2147Set draw line command
2148
2149Parameter : Bool
2150 Parameter type : b
2151 Omittable : False
2152
2153
2154
2155Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setLineVisible
2156Guidance :
2157Set line visibility command
2158
2159Parameter : Bool
2160 Parameter type : b
2161 Omittable : False
2162
2163
2164
2165Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setLineColour
2166Guidance :
2167Set colour through a string
2168
2169Parameter : Variable
2170 Parameter type : s
2171 Omittable : False
2172
2173
2174
2175Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setLineColourRGBA
2176Guidance :
2177Set colour through red, green, blue and alpha components
2178Four inputs are expected.
2179
2180Parameter : Red component
2181 Parameter type : d
2182 Omittable : False
2183
2184Parameter : Green component
2185 Parameter type : d
2186 Omittable : False
2187
2188Parameter : Blue component
2189 Parameter type : d
2190 Omittable : False
2191
2192Parameter : Alpha component
2193 Parameter type : d
2194 Omittable : False
2195
2196
2197
2198Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setDrawStepPts
2199Guidance :
2200Set draw step points command
2201
2202Parameter : Bool
2203 Parameter type : b
2204 Omittable : False
2205
2206
2207
2208Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setStepPtsVisible
2209Guidance :
2210Set step points visible command
2211
2212Parameter : Bool
2213 Parameter type : b
2214 Omittable : False
2215
2216
2217
2218Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setStepPtsColour
2219Guidance :
2220Set colour through a string
2221
2222Parameter : Variable
2223 Parameter type : s
2224 Omittable : False
2225
2226
2227
2228Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setStepPtsColourRGBA
2229Guidance :
2230Set colour through red, green, blue and alpha components
2231Four inputs are expected.
2232
2233Parameter : Red component
2234 Parameter type : d
2235 Omittable : False
2236
2237Parameter : Green component
2238 Parameter type : d
2239 Omittable : False
2240
2241Parameter : Blue component
2242 Parameter type : d
2243 Omittable : False
2244
2245Parameter : Alpha component
2246 Parameter type : d
2247 Omittable : False
2248
2249
2250
2251Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setStepPtsSize
2252Guidance :
2253Set step points size command
2254
2255Parameter : Double
2256 Parameter type : d
2257 Omittable : False
2258
2259
2260
2261
2262Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setStepPtsType
2263Guidance :
2264Set step points type.
2265
2266Parameter :
2267 Parameter type : s
2268 Omittable : False
2269 Candidates : dots circles squares
2270
2271
2272
2273Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setStepPtsFillStyle
2274Guidance :
2275Set step fill style type.
2276
2277Parameter :
2278 Parameter type : s
2279 Omittable : False
2280 Candidates : noFill hashed filled
2281
2282
2283
2284Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setDrawAuxPts
2285Guidance :
2286Set draw auxiliary points command
2287
2288Parameter : Bool
2289 Parameter type : b
2290 Omittable : False
2291
2292
2293
2294Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setAuxPtsVisible
2295Guidance :
2296Set auxiliary points visibility command
2297
2298Parameter : Bool
2299 Parameter type : b
2300 Omittable : False
2301
2302
2303
2304Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setAuxPtsColour
2305Guidance :
2306Set colour through a string
2307
2308Parameter : Variable
2309 Parameter type : s
2310 Omittable : False
2311
2312
2313
2314Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setAuxPtsColourRGBA
2315Guidance :
2316Set colour through red, green, blue and alpha components
2317Four inputs are expected.
2318
2319Parameter : Red component
2320 Parameter type : d
2321 Omittable : False
2322
2323Parameter : Green component
2324 Parameter type : d
2325 Omittable : False
2326
2327Parameter : Blue component
2328 Parameter type : d
2329 Omittable : False
2330
2331Parameter : Alpha component
2332 Parameter type : d
2333 Omittable : False
2334
2335
2336
2337Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setAuxPtsSize
2338Guidance :
2339Set auxiliary points size command
2340
2341Parameter : Double
2342 Parameter type : d
2343 Omittable : False
2344
2345
2346
2347Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setAuxPtsType
2348Guidance :
2349Set auxiliary points type.
2350
2351Parameter :
2352 Parameter type : s
2353 Omittable : False
2354 Candidates : dots circles squares
2355
2356
2357
2358Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setAuxPtsFillStyle
2359Guidance :
2360Set auxiliary fill style.
2361
2362Parameter :
2363 Parameter type : s
2364 Omittable : False
2365 Candidates : noFill hashed filled
2366
2367
2368
2369Command /vis/modeling/trajectories/drawByOriginVolume-0/default/setTimeSliceInterval
2370Guidance :
2371Set time slice interval. Give unit, e.g., "0.1 ns"
2372
2373Parameter : DoubleAndUnit
2374 Parameter type : d
2375 Omittable : False
2376
2377Parameter : Unit
2378 Parameter type : s
2379 Omittable : False
2380 Candidates : s ms mus ns ps second millisecond microsecond nanosecond picosecond
2381
2382Command directory path : /vis/modeling/trajectories/drawByAttribute-0/
2383
2384
2385Guidance :
2386Commands for drawByAttribute-0 model.
2387
2388 Sub-directories :
2389 /vis/modeling/trajectories/drawByAttribute-0/default/ Commands for default configuration
2390 Commands :
2391 verbose * Verbose command
2392 setAttribute * Set command
2393 addInterval * Add interval.
2394 addValue * Add value.
2395
2396
2397Command /vis/modeling/trajectories/drawByAttribute-0/verbose
2398
2399Guidance :
2400Verbose command
2401
2402Parameter : Bool
2403 Parameter type : b
2404 Omittable : False
2405
2406
2407
2408Command /vis/modeling/trajectories/drawByAttribute-0/setAttribute
2409Guidance :
2410Set command
2411
2412Parameter :
2413 Parameter type : s
2414 Omittable : False
2415
2416
2417
2418Command /vis/modeling/trajectories/drawByAttribute-0/addInterval
2419Guidance :
2420Add interval.
2421
2422Parameter :
2423 Parameter type : s
2424 Omittable : False
2425
2426
2427
2428Command /vis/modeling/trajectories/drawByAttribute-0/addValue
2429Guidance :
2430Add value.
2431
2432Parameter :
2433 Parameter type : s
2434 Omittable : False
2435
2436Command directory path : /vis/modeling/trajectories/drawByAttribute-0/default/
2437
2438
2439Guidance :
2440Commands for default configuration
2441
2442 Sub-directories :
2443 Commands :
2444 setDrawLine * Set draw line command
2445 setLineVisible * Set line visibility command
2446 setLineColour * Set colour through a string
2447 setLineColourRGBA * Set colour through red, green, blue and alpha components
2448 setDrawStepPts * Set draw step points command
2449 setStepPtsVisible * Set step points visible command
2450 setStepPtsColour * Set colour through a string
2451 setStepPtsColourRGBA * Set colour through red, green, blue and alpha components
2452 setStepPtsSize * Set step points size command
2453 setStepPtsType * Set step points type.
2454 setStepPtsFillStyle * Set step fill style type.
2455 setDrawAuxPts * Set draw auxiliary points command
2456 setAuxPtsVisible * Set auxiliary points visibility command
2457 setAuxPtsColour * Set colour through a string
2458 setAuxPtsColourRGBA * Set colour through red, green, blue and alpha components
2459 setAuxPtsSize * Set auxiliary points size command
2460 setAuxPtsType * Set auxiliary points type.
2461 setAuxPtsFillStyle * Set auxiliary fill style.
2462 setTimeSliceInterval * Set time slice interval. Give unit, e.g., "0.1 ns"
2463
2464
2465Command /vis/modeling/trajectories/drawByAttribute-0/default/setDrawLine
2466Guidance :
2467Set draw line command
2468
2469Parameter : Bool
2470 Parameter type : b
2471 Omittable : False
2472
2473
2474
2475Command /vis/modeling/trajectories/drawByAttribute-0/default/setLineVisible
2476Guidance :
2477Set line visibility command
2478
2479Parameter : Bool
2480 Parameter type : b
2481 Omittable : False
2482
2483
2484
2485Command /vis/modeling/trajectories/drawByAttribute-0/default/setLineColour
2486Guidance :
2487Set colour through a string
2488
2489Parameter : Variable
2490 Parameter type : s
2491 Omittable : False
2492
2493
2494
2495Command /vis/modeling/trajectories/drawByAttribute-0/default/setLineColourRGBA
2496Guidance :
2497Set colour through red, green, blue and alpha components
2498Four inputs are expected.
2499
2500Parameter : Red component
2501 Parameter type : d
2502 Omittable : False
2503
2504Parameter : Green component
2505 Parameter type : d
2506 Omittable : False
2507
2508Parameter : Blue component
2509 Parameter type : d
2510 Omittable : False
2511
2512Parameter : Alpha component
2513 Parameter type : d
2514 Omittable : False
2515
2516
2517
2518Command /vis/modeling/trajectories/drawByAttribute-0/default/setDrawStepPts
2519Guidance :
2520Set draw step points command
2521
2522Parameter : Bool
2523 Parameter type : b
2524 Omittable : False
2525
2526
2527
2528Command /vis/modeling/trajectories/drawByAttribute-0/default/setStepPtsVisible
2529Guidance :
2530Set step points visible command
2531
2532Parameter : Bool
2533 Parameter type : b
2534 Omittable : False
2535
2536
2537
2538Command /vis/modeling/trajectories/drawByAttribute-0/default/setStepPtsColour
2539Guidance :
2540Set colour through a string
2541
2542Parameter : Variable
2543 Parameter type : s
2544 Omittable : False
2545
2546
2547
2548Command /vis/modeling/trajectories/drawByAttribute-0/default/setStepPtsColourRGBA
2549Guidance :
2550Set colour through red, green, blue and alpha components
2551Four inputs are expected.
2552
2553Parameter : Red component
2554 Parameter type : d
2555 Omittable : False
2556
2557Parameter : Green component
2558 Parameter type : d
2559 Omittable : False
2560
2561Parameter : Blue component
2562 Parameter type : d
2563 Omittable : False
2564
2565Parameter : Alpha component
2566 Parameter type : d
2567 Omittable : False
2568
2569
2570
2571Command /vis/modeling/trajectories/drawByAttribute-0/default/setStepPtsSize
2572Guidance :
2573Set step points size command
2574
2575Parameter : Double
2576 Parameter type : d
2577 Omittable : False
2578
2579
2580
2581Command /vis/modeling/trajectories/drawByAttribute-0/default/setStepPtsType
2582Guidance :
2583Set step points type.
2584
2585Parameter :
2586 Parameter type : s
2587 Omittable : False
2588 Candidates : dots circles squares
2589
2590
2591
2592Command /vis/modeling/trajectories/drawByAttribute-0/default/setStepPtsFillStyle
2593Guidance :
2594Set step fill style type.
2595
2596Parameter :
2597 Parameter type : s
2598 Omittable : False
2599 Candidates : noFill hashed filled
2600
2601
2602
2603Command /vis/modeling/trajectories/drawByAttribute-0/default/setDrawAuxPts
2604Guidance :
2605Set draw auxiliary points command
2606
2607Parameter : Bool
2608 Parameter type : b
2609 Omittable : False
2610
2611
2612
2613Command /vis/modeling/trajectories/drawByAttribute-0/default/setAuxPtsVisible
2614Guidance :
2615Set auxiliary points visibility command
2616
2617Parameter : Bool
2618 Parameter type : b
2619 Omittable : False
2620
2621
2622
2623Command /vis/modeling/trajectories/drawByAttribute-0/default/setAuxPtsColour
2624Guidance :
2625Set colour through a string
2626
2627Parameter : Variable
2628 Parameter type : s
2629 Omittable : False
2630
2631
2632
2633Command /vis/modeling/trajectories/drawByAttribute-0/default/setAuxPtsColourRGBA
2634Guidance :
2635Set colour through red, green, blue and alpha components
2636Four inputs are expected.
2637
2638Parameter : Red component
2639 Parameter type : d
2640 Omittable : False
2641
2642Parameter : Green component
2643 Parameter type : d
2644 Omittable : False
2645
2646Parameter : Blue component
2647 Parameter type : d
2648 Omittable : False
2649
2650Parameter : Alpha component
2651 Parameter type : d
2652 Omittable : False
2653
2654
2655
2656Command /vis/modeling/trajectories/drawByAttribute-0/default/setAuxPtsSize
2657Guidance :
2658Set auxiliary points size command
2659
2660Parameter : Double
2661 Parameter type : d
2662 Omittable : False
2663
2664
2665
2666Command /vis/modeling/trajectories/drawByAttribute-0/default/setAuxPtsType
2667Guidance :
2668Set auxiliary points type.
2669
2670Parameter :
2671 Parameter type : s
2672 Omittable : False
2673 Candidates : dots circles squares
2674
2675
2676
2677Command /vis/modeling/trajectories/drawByAttribute-0/default/setAuxPtsFillStyle
2678Guidance :
2679Set auxiliary fill style.
2680
2681Parameter :
2682 Parameter type : s
2683 Omittable : False
2684 Candidates : noFill hashed filled
2685
2686
2687
2688Command /vis/modeling/trajectories/drawByAttribute-0/default/setTimeSliceInterval
2689Guidance :
2690Set time slice interval. Give unit, e.g., "0.1 ns"
2691
2692Parameter : DoubleAndUnit
2693 Parameter type : d
2694 Omittable : False
2695
2696Parameter : Unit
2697 Parameter type : s
2698 Omittable : False
2699 Candidates : s ms mus ns ps second millisecond microsecond nanosecond picosecond
2700
2701Command directory path : /vis/filtering/
2702
2703
2704Guidance :
2705Filtering commands.
2706
2707 Sub-directories :
2708 /vis/filtering/trajectories/ Trajectory filtering commands.
2709 /vis/filtering/hits/ Hit filtering commands.
2710 Commands :
2711Command directory path : /vis/filtering/trajectories/
2712
2713
2714Guidance :
2715Trajectory filtering commands.
2716
2717 Sub-directories :
2718 /vis/filtering/trajectories/create/ Create trajectory filters and messengers.
2719 /vis/filtering/trajectories/chargeFilter-0/ Commands for chargeFilter-0 model.
2720 /vis/filtering/trajectories/particleFilter-0/ Commands for particleFilter-0 model.
2721 /vis/filtering/trajectories/originVolumeFilter-0/ Commands for originVolumeFilter-0 model.
2722 /vis/filtering/trajectories/attributeFilter-0/ Commands for attributeFilter-0 model.
2723 Commands :
2724 list * List objects registered with list manager
2725 mode * Set mode of operation
2726
2727
2728Command /vis/filtering/trajectories/list
2729Guidance :
2730List objects registered with list manager
2731
2732Parameter : name
2733 Parameter type : s
2734 Omittable : True
2735
2736
2737
2738Command /vis/filtering/trajectories/mode
2739Guidance :
2740Set mode of operation
2741
2742Parameter : mode
2743 Parameter type : s
2744 Omittable : False
2745 Candidates : soft hard
2746
2747Command directory path : /vis/filtering/trajectories/create/
2748
2749
2750Guidance :
2751Create trajectory filters and messengers.
2752
2753 Sub-directories :
2754 Commands :
2755 chargeFilter * Create a chargeFilter model and associated messengers.
2756 particleFilter * Create a particleFilter model and associated messengers.
2757 originVolumeFilter * Create a originVolumeFilter model and associated messengers.
2758 attributeFilter * Create a attributeFilter model and associated messengers.
2759
2760
2761Command /vis/filtering/trajectories/create/chargeFilter
2762Guidance :
2763Create a chargeFilter model and associated messengers.
2764Generated model becomes current.
2765
2766Parameter : model-name
2767 Parameter type : s
2768 Omittable : True
2769
2770
2771
2772Command /vis/filtering/trajectories/create/particleFilter
2773Guidance :
2774Create a particleFilter model and associated messengers.
2775Generated model becomes current.
2776
2777Parameter : model-name
2778 Parameter type : s
2779 Omittable : True
2780
2781
2782
2783Command /vis/filtering/trajectories/create/originVolumeFilter
2784Guidance :
2785Create a originVolumeFilter model and associated messengers.
2786Generated model becomes current.
2787
2788Parameter : model-name
2789 Parameter type : s
2790 Omittable : True
2791
2792
2793
2794Command /vis/filtering/trajectories/create/attributeFilter
2795Guidance :
2796Create a attributeFilter model and associated messengers.
2797Generated model becomes current.
2798
2799Parameter : model-name
2800 Parameter type : s
2801 Omittable : True
2802
2803Command directory path : /vis/filtering/trajectories/chargeFilter-0/
2804
2805
2806Guidance :
2807Commands for chargeFilter-0 model.
2808
2809 Sub-directories :
2810 Commands :
2811 add * Add command
2812 invert * Invert command
2813 active * Active command
2814 verbose * Verbose command
2815 reset * Reset command
2816
2817
2818Command /vis/filtering/trajectories/chargeFilter-0/add
2819Guidance :
2820Add command
2821
2822Parameter :
2823 Parameter type : s
2824 Omittable : False
2825
2826
2827
2828Command /vis/filtering/trajectories/chargeFilter-0/invert
2829Guidance :
2830Invert command
2831
2832Parameter : Bool
2833 Parameter type : b
2834 Omittable : False
2835
2836
2837
2838Command /vis/filtering/trajectories/chargeFilter-0/active
2839Guidance :
2840Active command
2841
2842Parameter : Bool
2843 Parameter type : b
2844 Omittable : False
2845
2846
2847
2848Command /vis/filtering/trajectories/chargeFilter-0/verbose
2849Guidance :
2850Verbose command
2851
2852Parameter : Bool
2853 Parameter type : b
2854 Omittable : False
2855
2856
2857
2858Command /vis/filtering/trajectories/chargeFilter-0/reset
2859Guidance :
2860Reset command
2861
2862Command directory path : /vis/filtering/trajectories/particleFilter-0/
2863
2864
2865Guidance :
2866Commands for particleFilter-0 model.
2867
2868 Sub-directories :
2869 Commands :
2870 add * Add command
2871 invert * Invert command
2872 active * Active command
2873 verbose * Verbose command
2874 reset * Reset command
2875
2876
2877Command /vis/filtering/trajectories/particleFilter-0/add
2878Guidance :
2879Add command
2880
2881Parameter :
2882 Parameter type : s
2883 Omittable : False
2884
2885
2886
2887Command /vis/filtering/trajectories/particleFilter-0/invert
2888Guidance :
2889Invert command
2890
2891Parameter : Bool
2892 Parameter type : b
2893 Omittable : False
2894
2895
2896
2897Command /vis/filtering/trajectories/particleFilter-0/active
2898Guidance :
2899Active command
2900
2901Parameter : Bool
2902 Parameter type : b
2903 Omittable : False
2904
2905
2906
2907Command /vis/filtering/trajectories/particleFilter-0/verbose
2908Guidance :
2909Verbose command
2910
2911Parameter : Bool
2912 Parameter type : b
2913 Omittable : False
2914
2915
2916
2917Command /vis/filtering/trajectories/particleFilter-0/reset
2918Guidance :
2919Reset command
2920
2921Command directory path : /vis/filtering/trajectories/originVolumeFilter-0/
2922
2923
2924Guidance :
2925Commands for originVolumeFilter-0 model.
2926
2927 Sub-directories :
2928 Commands :
2929 add * Add command
2930 invert * Invert command
2931 active * Active command
2932 verbose * Verbose command
2933 reset * Reset command
2934
2935
2936Command /vis/filtering/trajectories/originVolumeFilter-0/add
2937Guidance :
2938Add command
2939
2940Parameter :
2941 Parameter type : s
2942 Omittable : False
2943
2944
2945
2946Command /vis/filtering/trajectories/originVolumeFilter-0/invert
2947Guidance :
2948Invert command
2949
2950Parameter : Bool
2951 Parameter type : b
2952 Omittable : False
2953
2954
2955
2956Command /vis/filtering/trajectories/originVolumeFilter-0/active
2957Guidance :
2958Active command
2959
2960Parameter : Bool
2961 Parameter type : b
2962 Omittable : False
2963
2964
2965
2966Command /vis/filtering/trajectories/originVolumeFilter-0/verbose
2967Guidance :
2968Verbose command
2969
2970Parameter : Bool
2971 Parameter type : b
2972 Omittable : False
2973
2974
2975
2976Command /vis/filtering/trajectories/originVolumeFilter-0/reset
2977Guidance :
2978Reset command
2979
2980Command directory path : /vis/filtering/trajectories/attributeFilter-0/
2981
2982
2983Guidance :
2984Commands for attributeFilter-0 model.
2985
2986 Sub-directories :
2987 Commands :
2988 setAttribute * Set command
2989 invert * Invert command
2990 active * Active command
2991 verbose * Verbose command
2992 reset * Reset command
2993 addInterval * Set interval.
2994 addValue * Set value.
2995
2996
2997Command /vis/filtering/trajectories/attributeFilter-0/setAttribute
2998Guidance :
2999Set command
3000
3001Parameter :
3002 Parameter type : s
3003 Omittable : False
3004
3005
3006
3007Command /vis/filtering/trajectories/attributeFilter-0/invert
3008Guidance :
3009Invert command
3010
3011Parameter : Bool
3012 Parameter type : b
3013 Omittable : False
3014
3015
3016
3017Command /vis/filtering/trajectories/attributeFilter-0/active
3018Guidance :
3019Active command
3020
3021Parameter : Bool
3022 Parameter type : b
3023 Omittable : False
3024
3025
3026
3027Command /vis/filtering/trajectories/attributeFilter-0/verbose
3028Guidance :
3029Verbose command
3030
3031Parameter : Bool
3032 Parameter type : b
3033 Omittable : False
3034
3035
3036
3037Command /vis/filtering/trajectories/attributeFilter-0/reset
3038Guidance :
3039Reset command
3040
3041
3042
3043Command /vis/filtering/trajectories/attributeFilter-0/addInterval
3044Guidance :
3045Set interval.
3046
3047Parameter :
3048 Parameter type : s
3049 Omittable : False
3050
3051
3052
3053Command /vis/filtering/trajectories/attributeFilter-0/addValue
3054Guidance :
3055Set value.
3056
3057Parameter :
3058 Parameter type : s
3059 Omittable : False
3060
3061Command directory path : /vis/filtering/hits/
3062
3063
3064Guidance :
3065Hit filtering commands.
3066
3067 Sub-directories :
3068 /vis/filtering/hits/create/ Create hit filters and messengers.
3069 /vis/filtering/hits/attributeFilter-0/ Commands for attributeFilter-0 model.
3070 Commands :
3071 list * List objects registered with list manager
3072 mode * Set mode of operation
3073
3074
3075Command /vis/filtering/hits/list
3076Guidance :
3077List objects registered with list manager
3078
3079Parameter : name
3080 Parameter type : s
3081 Omittable : True
3082
3083
3084
3085Command /vis/filtering/hits/mode
3086Guidance :
3087Set mode of operation
3088
3089Parameter : mode
3090 Parameter type : s
3091 Omittable : False
3092 Candidates : soft hard
3093
3094Command directory path : /vis/filtering/hits/create/
3095
3096
3097Guidance :
3098Create hit filters and messengers.
3099
3100 Sub-directories :
3101 Commands :
3102 attributeFilter * Create a attributeFilter model and associated messengers.
3103
3104
3105Command /vis/filtering/hits/create/attributeFilter
3106Guidance :
3107Create a attributeFilter model and associated messengers.
3108Generated model becomes current.
3109
3110Parameter : model-name
3111 Parameter type : s
3112 Omittable : True
3113
3114Command directory path : /vis/filtering/hits/attributeFilter-0/
3115
3116
3117Guidance :
3118Commands for attributeFilter-0 model.
3119
3120 Sub-directories :
3121 Commands :
3122 setAttribute * Set command
3123 invert * Invert command
3124 active * Active command
3125 verbose * Verbose command
3126 reset * Reset command
3127 addInterval * Set interval.
3128 addValue * Set value.
3129
3130
3131Command /vis/filtering/hits/attributeFilter-0/setAttribute
3132Guidance :
3133Set command
3134
3135Parameter :
3136 Parameter type : s
3137 Omittable : False
3138
3139
3140
3141Command /vis/filtering/hits/attributeFilter-0/invert
3142Guidance :
3143Invert command
3144
3145Parameter : Bool
3146 Parameter type : b
3147 Omittable : False
3148
3149
3150
3151Command /vis/filtering/hits/attributeFilter-0/active
3152Guidance :
3153Active command
3154
3155Parameter : Bool
3156 Parameter type : b
3157 Omittable : False
3158
3159
3160
3161Command /vis/filtering/hits/attributeFilter-0/verbose
3162Guidance :
3163Verbose command
3164
3165Parameter : Bool
3166 Parameter type : b
3167 Omittable : False
3168
3169
3170
3171Command /vis/filtering/hits/attributeFilter-0/reset
3172Guidance :
3173Reset command
3174
3175
3176
3177Command /vis/filtering/hits/attributeFilter-0/addInterval
3178Guidance :
3179Set interval.
3180
3181Parameter :
3182 Parameter type : s
3183 Omittable : False
3184
3185
3186
3187Command /vis/filtering/hits/attributeFilter-0/addValue
3188Guidance :
3189Set value.
3190
3191Parameter :
3192 Parameter type : s
3193 Omittable : False
3194
3195Command directory path : /vis/geometry/
3196
3197
3198Guidance :
3199Operations on vis attributes of Geant4 geometry.
3200
3201 Sub-directories :
3202 /vis/geometry/set/ Set vis attributes of Geant4 geometry.
3203 Commands :
3204 list * Lists vis attributes of logical volume(s).
3205 restore * Restores vis attributes of logical volume(s).
3206
3207
3208Command /vis/geometry/list
3209Guidance :
3210Lists vis attributes of logical volume(s).
3211"all" lists all logical volumes.
3212
3213Parameter : logical-volume-name
3214 Parameter type : s
3215 Omittable : True
3216 Default value : all
3217
3218
3219
3220Command /vis/geometry/restore
3221Guidance :
3222Restores vis attributes of logical volume(s).
3223
3224Parameter : logical-volume-name
3225 Parameter type : s
3226 Omittable : True
3227 Default value : all
3228
3229Command directory path : /vis/geometry/set/
3230
3231
3232Guidance :
3233Set vis attributes of Geant4 geometry.
3234
3235 Sub-directories :
3236 Commands :
3237 colour * Sets colour of logical volume(s).
3238 daughtersInvisible * Sets daughters of logical volume(s) invisible.
3239 lineStyle * Sets line style of logical volume(s) drawing.
3240 lineWidth * Sets line width of logical volume(s) drawing.
3241 forceAuxEdgeVisible * Sets auxiliary (soft) edges of logical volume(s) drawing visible.
3242 forceSolid * Sets logical volume(s) drawing always to be as solid (surface drawing).
3243 forceWireframe * Sets logical volume(s) drawing always to be as wireframe.
3244 visibility * Sets visibility of logical volume(s).
3245
3246
3247Command /vis/geometry/set/colour
3248Guidance :
3249Sets colour of logical volume(s).
3250"all" sets all logical volumes.
3251Optionally propagates down hierarchy to given depth.
3252
3253Parameter : logical-volume-name
3254 Parameter type : s
3255 Omittable : True
3256 Default value : all
3257
3258Parameter : depth
3259Depth of propagation (-1 means unlimited depth).
3260 Parameter type : d
3261 Omittable : True
3262 Default value : 0
3263
3264Parameter : red
3265Red component or a string, e.g., "blue", in which case succeeding colour components are ignored.
3266 Parameter type : s
3267 Omittable : True
3268 Default value : 1.
3269
3270Parameter : green
3271 Parameter type : d
3272 Omittable : True
3273 Default value : 1
3274
3275Parameter : blue
3276 Parameter type : d
3277 Omittable : True
3278 Default value : 1
3279
3280Parameter : opacity
3281 Parameter type : d
3282 Omittable : True
3283 Default value : 1
3284
3285
3286
3287Command /vis/geometry/set/daughtersInvisible
3288Guidance :
3289Sets daughters of logical volume(s) invisible.
3290"all" sets all logical volumes.
3291Optionally propagates down hierarchy to given depth.
3292
3293Parameter : logical-volume-name
3294 Parameter type : s
3295 Omittable : True
3296 Default value : all
3297
3298Parameter : depth
3299Depth of propagation (-1 means unlimited depth).
3300 Parameter type : d
3301 Omittable : True
3302 Default value : 0
3303
3304Parameter : daughtersInvisible
3305 Parameter type : b
3306 Omittable : True
3307 Default value : 0
3308
3309
3310
3311
3312Command /vis/geometry/set/lineStyle
3313Guidance :
3314Sets line style of logical volume(s) drawing.
3315"all" sets all logical volumes.
3316Optionally propagates down hierarchy to given depth.
3317
3318Parameter : logical-volume-name
3319 Parameter type : s
3320 Omittable : True
3321 Default value : all
3322
3323Parameter : depth
3324Depth of propagation (-1 means unlimited depth).
3325 Parameter type : d
3326 Omittable : True
3327 Default value : 0
3328
3329Parameter : lineStyle
3330 Parameter type : s
3331 Omittable : True
3332 Default value : unbroken
3333 Candidates : unbroken dashed dotted
3334
3335
3336
3337Command /vis/geometry/set/lineWidth
3338Guidance :
3339Sets line width of logical volume(s) drawing.
3340"all" sets all logical volumes.
3341Optionally propagates down hierarchy to given depth.
3342
3343Parameter : logical-volume-name
3344 Parameter type : s
3345 Omittable : True
3346 Default value : all
3347
3348Parameter : depth
3349Depth of propagation (-1 means unlimited depth).
3350 Parameter type : d
3351 Omittable : True
3352 Default value : 0
3353
3354Parameter : lineWidth
3355 Parameter type : d
3356 Omittable : True
3357 Default value : 1
3358
3359
3360
3361Command /vis/geometry/set/forceAuxEdgeVisible
3362Guidance :
3363Sets auxiliary (soft) edges of logical volume(s) drawing visible.
3364"all" sets all logical volumes.
3365Optionally propagates down hierarchy to given depth.
3366
3367Parameter : logical-volume-name
3368 Parameter type : s
3369 Omittable : True
3370 Default value : all
3371
3372Parameter : depth
3373Depth of propagation (-1 means unlimited depth).
3374 Parameter type : d
3375 Omittable : True
3376 Default value : 0
3377
3378Parameter : forceAuxEdgeVisible
3379 Parameter type : b
3380 Omittable : True
3381 Default value : 0
3382
3383
3384
3385Command /vis/geometry/set/forceSolid
3386Guidance :
3387Sets logical volume(s) drawing always to be as solid (surface drawing).
3388"all" sets all logical volumes.
3389Optionally propagates down hierarchy to given depth.
3390
3391Parameter : logical-volume-name
3392 Parameter type : s
3393 Omittable : True
3394 Default value : all
3395
3396Parameter : depth
3397Depth of propagation (-1 means unlimited depth).
3398 Parameter type : d
3399 Omittable : True
3400 Default value : 0
3401
3402Parameter : forceSolid
3403 Parameter type : b
3404 Omittable : True
3405 Default value : 0
3406
3407
3408
3409Command /vis/geometry/set/forceWireframe
3410Guidance :
3411Sets logical volume(s) drawing always to be as wireframe.
3412"all" sets all logical volumes.
3413Optionally propagates down hierarchy to given depth.
3414
3415Parameter : logical-volume-name
3416 Parameter type : s
3417 Omittable : True
3418 Default value : all
3419
3420Parameter : depth
3421Depth of propagation (-1 means unlimited depth).
3422 Parameter type : d
3423 Omittable : True
3424 Default value : 0
3425
3426Parameter : forceWireframe
3427 Parameter type : b
3428 Omittable : True
3429 Default value : 0
3430
3431
3432
3433Command /vis/geometry/set/visibility
3434Guidance :
3435Sets visibility of logical volume(s).
3436"all" sets all logical volumes.
3437Optionally propagates down hierarchy to given depth.
3438
3439Parameter : logical-volume-name
3440 Parameter type : s
3441 Omittable : True
3442 Default value : all
3443
3444Parameter : depth
3445Depth of propagation (-1 means unlimited depth).
3446 Parameter type : d
3447 Omittable : True
3448 Default value : 0
3449
3450Parameter : visibility
3451 Parameter type : b
3452 Omittable : True
3453 Default value : 1
3454
3455Command directory path : /vis/scene/
3456
3457
3458Guidance :
3459Operations on Geant4 scenes.
3460
3461 Sub-directories :
3462 /vis/scene/add/ Add model to current scene.
3463 Commands :
3464 create * Creates an empty scene.
3465 endOfEventAction * Accumulate or refresh the viewer for each new event.
3466 endOfRunAction * Accumulate or refresh the viewer for each new run.
3467 list * Lists scene(s).
3468 notifyHandlers * Notifies scene handlers and forces re-rendering.
3469 select * Selects a scene
3470
3471
3472Command /vis/scene/create
3473Guidance :
3474Creates an empty scene.
3475Invents a name if not supplied. This scene becomes current.
3476
3477Parameter : scene-name
3478 Parameter type : s
3479 Omittable : True
3480
3481
3482
3483Command /vis/scene/endOfEventAction
3484Guidance :
3485Accumulate or refresh the viewer for each new event.
3486"accumulate": viewer accumulates hits, etc., event by event, or
3487"refresh": viewer shows them at end of event or, for direct-screen
3488 viewers, refreshes the screen just before drawing the next event.
3489
3490Parameter : action
3491 Parameter type : s
3492 Omittable : True
3493 Default value : refresh
3494 Candidates : accumulate refresh
3495
3496Parameter : maxNumber
3497Maximum number of events kept. Unlimited if negative.
3498 Parameter type : i
3499 Omittable : True
3500 Default value : 100
3501
3502
3503
3504Command /vis/scene/endOfRunAction
3505Guidance :
3506Accumulate or refresh the viewer for each new run.
3507"accumulate": viewer accumulates hits, etc., run by run, or
3508"refresh": viewer shows them at end of run or, for direct-screen
3509 viewers, refreshes the screen just before drawing the first
3510 event of the next run.
3511The detector remains or is redrawn.
3512
3513Parameter : action
3514 Parameter type : s
3515 Omittable : True
3516 Default value : refresh
3517 Candidates : accumulate refresh
3518
3519
3520
3521Command /vis/scene/list
3522Guidance :
3523Lists scene(s).
3524"help /vis/verbose" for definition of verbosity.
3525
3526Parameter : scene-name
3527 Parameter type : s
3528 Omittable : True
3529 Default value : all
3530
3531Parameter : verbosity
3532 Parameter type : s
3533 Omittable : True
3534 Default value : warnings
3535
3536
3537
3538Command /vis/scene/notifyHandlers
3539Guidance :
3540Notifies scene handlers and forces re-rendering.
3541Notifies the handler(s) of the specified scene and forces a
3542reconstruction of any graphical databases.
3543Clears and refreshes all viewers of current scene.
3544 The default action "refresh" does not issue "update" (see
3545 /vis/viewer/update).
3546If "flush" is specified, it issues an "update" as well as
3547 "refresh" - "update" and initiates post-processing
3548 for graphics systems which need it.
3549The default for <scene-name> is the current scene name.
3550This command does not change current scene, scene handler or viewer.
3551
3552Parameter : scene-name
3553 Parameter type : s
3554 Omittable : True
3555 Default value : taken from the current value
3556
3557Parameter : refresh-flush
3558 Parameter type : s
3559 Omittable : True
3560 Default value : refresh
3561 Candidates : r refresh f flush
3562
3563
3564
3565Command /vis/scene/select
3566Guidance :
3567Selects a scene
3568Makes the scene current. "/vis/scene/list" to see
3569 possible scene names.
3570
3571Parameter : scene-name
3572 Parameter type : s
3573 Omittable : False
3574
3575Command directory path : /vis/scene/add/
3576
3577
3578Guidance :
3579Add model to current scene.
3580
3581 Sub-directories :
3582 Commands :
3583 axes * Add axes.
3584 eventID * Adds eventID to current scene.
3585 ghosts * Adds ghost volumes (G4FlavoredParallelWorld) to the current scene.
3586 hits * Adds hits to current scene.
3587 logicalVolume * Adds a logical volume to the current scene,
3588 logo * Adds a G4 logo to the current scene.
3589 scale * Adds an annotated scale line to the current scene.
3590 text * Adds text to current scene.
3591 trajectories * Adds trajectories to current scene.
3592 userAction * Add Vis User Action, if any, to current scene.
3593 volume * Adds a physical volume to current scene, with optional clipping volume.
3594
3595
3596Command /vis/scene/add/axes
3597Guidance :
3598Add axes.
3599Draws axes at (x0, y0, z0) of given length.
3600
3601Parameter : x0
3602 Parameter type : d
3603 Omittable : True
3604 Default value : 0
3605
3606Parameter : y0
3607 Parameter type : d
3608 Omittable : True
3609 Default value : 0
3610
3611Parameter : z0
3612 Parameter type : d
3613 Omittable : True
3614 Default value : 0
3615
3616Parameter : length
3617 Parameter type : d
3618 Omittable : True
3619 Default value : 1
3620
3621Parameter : unit
3622 Parameter type : s
3623 Omittable : True
3624 Default value : m
3625
3626
3627
3628Command /vis/scene/add/eventID
3629Guidance :
3630Adds eventID to current scene.
3631Run and event numbers are drawn at end of event or run when
3632 the scene in which they are added is current.
3633
3634Parameter : size
3635Screen size of text in pixels.
3636 Parameter type : i
3637 Omittable : True
3638 Default value : 18
3639
3640Parameter : x-position
3641x screen position in range -1 < x < 1.
3642 Parameter type : d
3643 Omittable : True
3644 Default value : -0.95
3645
3646Parameter : y-position
3647y screen position in range -1 < y < 1.
3648 Parameter type : d
3649 Omittable : True
3650 Default value : 0.9
3651
3652
3653
3654Command /vis/scene/add/ghosts
3655Guidance :
3656Adds ghost volumes (G4FlavoredParallelWorld) to the current scene.
3657Selects by particle.
3658
3659Parameter : particle
3660 Parameter type : s
3661 Omittable : True
3662 Default value : all
3663
3664
3665
3666Command /vis/scene/add/hits
3667Guidance :
3668Adds hits to current scene.
3669Hits are drawn at end of event when the scene in which
3670they are added is current.
3671
3672
3673
3674Command /vis/scene/add/logicalVolume
3675Guidance :
3676Adds a logical volume to the current scene,
3677Shows boolean components (if any), voxels (if any) and readout geometry
3678(if any). Note: voxels are not constructed until start of run -
3679 "/run/beamOn".
3680
3681Parameter : logical-volume-name
3682 Parameter type : s
3683 Omittable : False
3684
3685Parameter : depth-of-descent
3686Depth of descent of geometry hierarchy.
3687 Parameter type : i
3688 Omittable : True
3689 Default value : 1
3690
3691Parameter : booleans-flag
3692 Parameter type : b
3693 Omittable : True
3694 Default value : 1
3695
3696Parameter : voxels-flag
3697 Parameter type : b
3698 Omittable : True
3699 Default value : 1
3700
3701Parameter : readout-flag
3702 Parameter type : b
3703 Omittable : True
3704 Default value : 1
3705
3706
3707
3708Command /vis/scene/add/logo
3709Guidance :
3710Adds a G4 logo to the current scene.
3711The placement, if automatic, is similar to that of scale -
3712"help /vis/scene/add/scale" for more information.
3713
3714Parameter : height
3715 Parameter type : d
3716 Omittable : True
3717 Default value : 1
3718
3719Parameter : unit
3720 Parameter type : s
3721 Omittable : True
3722 Default value : m
3723
3724Parameter : direction
3725'x', 'y' or 'z' - otherwise defaults to 'x'.
3726 Parameter type : s
3727 Omittable : True
3728 Default value : x
3729
3730Parameter : red
3731 Parameter type : d
3732 Omittable : True
3733 Default value : 0
3734
3735Parameter : green
3736 Parameter type : d
3737 Omittable : True
3738 Default value : 1
3739
3740Parameter : blue
3741 Parameter type : d
3742 Omittable : True
3743 Default value : 0
3744
3745Parameter : auto|manual
3746Automatic placement or manual placement at (xmid,ymid,zmid).
3747 Parameter type : s
3748 Omittable : True
3749 Default value : auto
3750 Candidates : auto manual
3751
3752Parameter : xmid
3753 Parameter type : d
3754 Omittable : True
3755 Default value : 0
3756
3757Parameter : ymid
3758 Parameter type : d
3759 Omittable : True
3760 Default value : 0
3761
3762Parameter : zmid
3763 Parameter type : d
3764 Omittable : True
3765 Default value : 0
3766
3767Parameter : unit
3768 Parameter type : s
3769 Omittable : True
3770 Default value : m
3771
3772
3773
3774Command /vis/scene/add/scale
3775Guidance :
3776Adds an annotated scale line to the current scene.
3777An annotated line in the specified direction with tick marks at the
3778end. If autoPlacing is true it is required to be centred at the
3779front, right, bottom corner of the world space, comfortably outside
3780the existing bounding box/sphere so that existing objects do not
3781obscure it. Otherwise it is required to be drawn with mid-point at
3782(xmid, ymid, zmid).
3783
3784The auto placing algorithm might be:
3785 x = xmin + (1 + comfort) * (xmax - xmin);
3786 y = ymin - comfort * (ymax - ymin);
3787 z = zmin + (1 + comfort) * (zmax - zmin);
3788 if direction == x then (x - length,y,z) to (x,y,z);
3789 if direction == y then (x,y,z) to (x,y + length,z);
3790 if direction == z then (x,y,z - length) to (x,y,z);
3791
3792Parameter : length
3793 Parameter type : d
3794 Omittable : True
3795 Default value : 1
3796
3797Parameter : unit
3798 Parameter type : s
3799 Omittable : True
3800 Default value : m
3801
3802Parameter : direction
3803'x', 'y' or 'z' - otherwise defaults to 'x'.
3804 Parameter type : s
3805 Omittable : True
3806 Default value : x
3807
3808Parameter : red
3809 Parameter type : d
3810 Omittable : True
3811 Default value : 1
3812
3813Parameter : green
3814 Parameter type : d
3815 Omittable : True
3816 Default value : 0
3817
3818Parameter : blue
3819 Parameter type : d
3820 Omittable : True
3821 Default value : 0
3822
3823Parameter : auto|manual
3824Automatic placement or manual placement at (xmid,ymid,zmid).
3825 Parameter type : s
3826 Omittable : True
3827 Default value : auto
3828 Candidates : auto manual
3829
3830Parameter : xmid
3831 Parameter type : d
3832 Omittable : True
3833 Default value : 0
3834
3835Parameter : ymid
3836 Parameter type : d
3837 Omittable : True
3838 Default value : 0
3839
3840Parameter : zmid
3841 Parameter type : d
3842 Omittable : True
3843 Default value : 0
3844
3845Parameter : unit
3846 Parameter type : s
3847 Omittable : True
3848 Default value : m
3849
3850
3851
3852Command /vis/scene/add/text
3853Guidance :
3854Adds text to current scene.
3855
3856Parameter : x
3857x
3858 Parameter type : d
3859 Omittable : True
3860 Default value : 0
3861
3862Parameter : y
3863y
3864 Parameter type : d
3865 Omittable : True
3866 Default value : 0
3867
3868Parameter : z
3869z
3870 Parameter type : d
3871 Omittable : True
3872 Default value : 0
3873
3874Parameter : unit
3875 Parameter type : s
3876 Omittable : True
3877 Default value : m
3878
3879Parameter : font_size
3880pixels
3881 Parameter type : d
3882 Omittable : True
3883 Default value : 12
3884
3885Parameter : x_offset
3886pixels
3887 Parameter type : d
3888 Omittable : True
3889 Default value : 0
3890
3891Parameter : y_offset
3892pixels
3893 Parameter type : d
3894 Omittable : True
3895 Default value : 0
3896
3897Parameter : text
3898The rest of the line is text.
3899 Parameter type : s
3900 Omittable : True
3901 Default value : Hello G4
3902
3903
3904
3905Command /vis/scene/add/trajectories
3906Guidance :
3907Adds trajectories to current scene.
3908Causes trajectories, if any, to be drawn at the end of processing an
3909event. Switches on trajectory storing and sets the
3910default trajectory type.
3911The command line parameter list determines the default trajectory type.
3912If it contains the string "smooth", auxiliary inter-step points will
3913be inserted to improve the smoothness of the drawing of a curved
3914trajectory.
3915If it contains the string "rich", significant extra information will
3916be stored in the trajectory (G4RichTrajectory) amenable to modeling
3917and filtering with "/vis/modeling/trajectories/create/drawByAttribute"
3918and "/vis/filtering/trajectories/create/attributeFilter" commands.
3919It may contain both strings in any order.
3920
3921To switch off trajectory storing: "/tracking/storeTrajectory 0".
3922See also "/vis/scene/endOfEventAction".
3923Note: This only sets the default. Independently of the result of this
3924command, a user may instantiate a trajectory that overrides this default
3925in PreUserTrackingAction.
3926
3927Parameter : default-trajectory-type
3928 Parameter type : s
3929 Omittable : True
3930
3931
3932
3933Command /vis/scene/add/userAction
3934Guidance :
3935Add Vis User Action, if any, to current scene.
3936Optional arguments define the extent of the callback drawing. You may
3937not need this if the extent has been defined in the original
3938SetUserAction or is defined by other components of the scene. But if
3939the user action is the only component of the scene, you will certainly
3940need to set the extent either in SetUserAction or here. A scene must
3941have an extent one way or another so that the viewer can calculate
3942how to point the camera.
3943
3944Parameter : xmin
3945 Parameter type : d
3946 Omittable : True
3947 Default value : 0
3948
3949Parameter : xmax
3950 Parameter type : d
3951 Omittable : True
3952 Default value : 0
3953
3954Parameter : ymin
3955 Parameter type : d
3956 Omittable : True
3957 Default value : 0
3958
3959Parameter : ymax
3960 Parameter type : d
3961 Omittable : True
3962 Default value : 0
3963
3964Parameter : zmin
3965 Parameter type : d
3966 Omittable : True
3967 Default value : 0
3968
3969Parameter : zmax
3970 Parameter type : d
3971 Omittable : True
3972 Default value : 0
3973
3974Parameter : unit
3975 Parameter type : s
3976 Omittable : True
3977 Default value : cm
3978
3979
3980
3981Command /vis/scene/add/volume
3982Guidance :
3983Adds a physical volume to current scene, with optional clipping volume.
3984If physical-volume-name is "world" (the default), the top of the
3985main geometry tree (material world) is added. If "worlds", the
3986top of all worlds - material world and parallel worlds, if any - are
3987added. Otherwise a search of all worlds is made, taking the first
3988matching occurence only. To see a representation of the geometry
3989hierarchy of the worlds, try "/vis/drawTree [worlds]" or one of the
3990driver/browser combinations that have the required functionality,
3991e.g., HepRepFile/XML with the WIRED3/4 browser.
3992If clip-volume-type is specified, the subsequent parameters are used to
3993to define a clipping volume. For example,
3994"vis/scene/add/volume ! ! ! -box km 0 1 0 1 0 1" will draw the world
3995with the positive octant cut away.
3996If clip-volume-type is prepended with '-', the clip-volume is subtracted
3997(cutaway). (This is the default if there is no prepended character.)
3998If '*' is prepended, the intersection of the physical-volume and the
3999clip-volume is made. (You can make a section/DCUT with a thin box, for
4000example).
4001For "box", the parameters are xmin,xmax,ymin,ymax,zmin,zmax.
4002Only "box" is programmed at present.
4003
4004Parameter : physical-volume-name
4005 Parameter type : s
4006 Omittable : True
4007 Default value : world
4008
4009Parameter : copy-no
4010If negative, matches any copy no. First name match is taken.
4011 Parameter type : i
4012 Omittable : True
4013 Default value : -1
4014
4015Parameter : depth-of-descent
4016Depth of descent of geometry hierarchy. Default = unlimited depth.
4017 Parameter type : i
4018 Omittable : True
4019 Default value : -1
4020
4021Parameter : clip-volume-type
4022[-|*]type. See general guidance.
4023 Parameter type : s
4024 Omittable : True
4025 Default value : none
4026 Candidates : none box -box *box
4027
4028Parameter : parameter-unit
4029 Parameter type : s
4030 Omittable : True
4031 Default value : m
4032
4033Parameter : parameter-1
4034 Parameter type : d
4035 Omittable : True
4036 Default value : 0
4037
4038Parameter : parameter-2
4039 Parameter type : d
4040 Omittable : True
4041 Default value : 0
4042
4043Parameter : parameter-3
4044 Parameter type : d
4045 Omittable : True
4046 Default value : 0
4047
4048Parameter : parameter-4
4049 Parameter type : d
4050 Omittable : True
4051 Default value : 0
4052
4053Parameter : parameter-5
4054 Parameter type : d
4055 Omittable : True
4056 Default value : 0
4057
4058Parameter : parameter-6
4059 Parameter type : d
4060 Omittable : True
4061 Default value : 0
4062
4063Command directory path : /vis/sceneHandler/
4064
4065
4066Guidance :
4067Operations on Geant4 scene handlers.
4068
4069 Sub-directories :
4070 Commands :
4071 attach * Attaches scene to current scene handler.
4072 create * Creates an scene handler for a specific graphics system.
4073 list * Lists scene handler(s).
4074 select * Selects a scene handler.
4075
4076
4077Command /vis/sceneHandler/attach
4078Guidance :
4079Attaches scene to current scene handler.
4080If scene-name is omitted, current scene is attached. To see scenes and
4081scene handlers, use "/vis/scene/list" and "/vis/sceneHandler/list"
4082
4083Parameter : scene-name
4084 Parameter type : s
4085 Omittable : True
4086 Default value : taken from the current value
4087
4088
4089
4090Command /vis/sceneHandler/create
4091Guidance :
4092Creates an scene handler for a specific graphics system.
4093Attaches current scene, if any. (You can change attached scenes with
4094"/vis/sceneHandler/attach".) Invents a scene handler name if not
4095
4096supplied. This scene handler becomes current.
4097
4098Parameter : graphics-system-name
4099 Parameter type : s
4100 Omittable : False
4101 Candidates : XXX XXXFile XXXStored XXXSG ATree DAWNFILE GAGTree HepRepXML HepRepFile RayTracer VRML1FILE VRML2FILE DAWN OGLIX OGLSX OGLIXm OGLSXm OIX RayTracerX VRML1 VRML2
4102
4103Parameter : scene-handler-name
4104 Parameter type : s
4105 Omittable : True
4106 Default value : taken from the current value
4107
4108
4109
4110Command /vis/sceneHandler/list
4111Guidance :
4112Lists scene handler(s).
4113"help /vis/verbose" for definition of verbosity.
4114
4115Parameter : scene-handler-name
4116 Parameter type : s
4117 Omittable : True
4118 Default value : all
4119
4120Parameter : verbosity
4121 Parameter type : s
4122 Omittable : True
4123 Default value : warnings
4124
4125
4126
4127Command /vis/sceneHandler/select
4128Guidance :
4129Selects a scene handler.
4130Makes the scene handler current. "/vis/sceneHandler/list" to see
4131 possible scene handler names.
4132
4133Parameter : scene-handler-name
4134 Parameter type : s
4135 Omittable : False
4136
4137Command directory path : /vis/viewer/
4138
4139
4140Guidance :
4141Operations on Geant4 viewers.
4142
4143 Sub-directories :
4144 /vis/viewer/set/ Set view parameters of current viewer.
4145 Commands :
4146 addCutawayPlane * Add cutaway plane A*x + B*y + C*z + D = 0 to current viewer.
4147 changeCutawayPlane * Change cutaway plane.
4148 clear * Clears viewer.
4149 clearCutawayPlanes * Clear cutaway planes of current viewer.
4150 clearTransients * Clears transients from viewer.
4151 clone * Clones viewer.
4152 create * Creates a viewer for the specified scene handler.
4153 dolly * Incremental dolly.
4154 dollyTo * Dolly to specific coordinate.
4155 flush * Compound command: "/vis/viewer/refresh" + "/vis/viewer/update".
4156 list * Lists viewers(s).
4157 pan * Incremental pan.
4158 panTo * Pan to specific coordinate.
4159 rebuild * Forces rebuild of graphical database.
4160 refresh * Refreshes viewer.
4161 reset * Resets viewer.
4162 scale * Incremental (non-uniform) scaling.
4163 scaleTo * Absolute (non-uniform) scaling.
4164 select * Selects viewer.
4165 update * Triggers graphical database post-processing for viewers
4166using that technique.
4167 zoom * Incremental zoom.
4168 zoomTo * Absolute zoom.
4169
4170
4171Command /vis/viewer/addCutawayPlane
4172Guidance :
4173Add cutaway plane A*x + B*y + C*z + D = 0 to current viewer.
4174
4175Parameter : x
4176Coordinate of point on the plane.
4177 Parameter type : d
4178 Omittable : True
4179 Default value : 0
4180
4181Parameter : y
4182Coordinate of point on the plane.
4183 Parameter type : d
4184 Omittable : True
4185 Default value : 0
4186
4187Parameter : z
4188Coordinate of point on the plane.
4189 Parameter type : d
4190 Omittable : True
4191 Default value : 0
4192
4193Parameter : unit
4194Unit of point on the plane.
4195 Parameter type : s
4196 Omittable : True
4197 Default value : m
4198
4199Parameter : nx
4200Component of plane normal.
4201 Parameter type : d
4202 Omittable : True
4203 Default value : 1
4204
4205Parameter : ny
4206Component of plane normal.
4207 Parameter type : d
4208 Omittable : True
4209 Default value : 0
4210
4211Parameter : nz
4212Component of plane normal.
4213 Parameter type : d
4214 Omittable : True
4215 Default value : 0
4216
4217
4218
4219Command /vis/viewer/changeCutawayPlane
4220Guidance :
4221Change cutaway plane.
4222
4223Parameter : index
4224Index of plane: 0, 1, 2.
4225 Parameter type : i
4226 Omittable : False
4227
4228Parameter : x
4229Coordinate of point on the plane.
4230 Parameter type : d
4231 Omittable : True
4232 Default value : 0
4233
4234Parameter : y
4235Coordinate of point on the plane.
4236 Parameter type : d
4237 Omittable : True
4238 Default value : 0
4239
4240Parameter : z
4241Coordinate of point on the plane.
4242 Parameter type : d
4243 Omittable : True
4244 Default value : 0
4245
4246Parameter : unit
4247Unit of point on the plane.
4248 Parameter type : s
4249 Omittable : True
4250 Default value : m
4251
4252Parameter : nx
4253Component of plane normal.
4254 Parameter type : d
4255 Omittable : True
4256 Default value : 1
4257
4258Parameter : ny
4259Component of plane normal.
4260 Parameter type : d
4261 Omittable : True
4262 Default value : 0
4263
4264Parameter : nz
4265Component of plane normal.
4266 Parameter type : d
4267 Omittable : True
4268 Default value : 0
4269
4270
4271
4272Command /vis/viewer/clear
4273Guidance :
4274Clears viewer.
4275By default, clears current viewer. Specified viewer becomes current.
4276"/vis/viewer/list" to see possible viewer names.
4277
4278Parameter : viewer-name
4279 Parameter type : s
4280 Omittable : True
4281 Default value : taken from the current value
4282
4283
4284
4285Command /vis/viewer/clearCutawayPlanes
4286Guidance :
4287Clear cutaway planes of current viewer.
4288
4289
4290
4291Command /vis/viewer/clearTransients
4292Guidance :
4293Clears transients from viewer.
4294By default, operates on current viewer. Specified viewer becomes current.
4295"/vis/viewer/list" to see possible viewer names.
4296
4297Parameter : viewer-name
4298 Parameter type : s
4299 Omittable : True
4300 Default value : taken from the current value
4301
4302
4303
4304Command /vis/viewer/clone
4305Guidance :
4306Clones viewer.
4307By default, clones current viewer. Clone becomes current.
4308Clone name, if not provided, is derived from the original name.
4309"/vis/viewer/list" to see possible viewer names.
4310
4311Parameter : original-viewer-name
4312 Parameter type : s
4313 Omittable : True
4314 Default value : taken from the current value
4315
4316Parameter : clone-name
4317 Parameter type : s
4318 Omittable : True
4319 Default value : none
4320
4321
4322
4323Command /vis/viewer/create
4324Guidance :
4325Creates a viewer for the specified scene handler.
4326Default scene handler is the current scene handler. Invents a name
4327if not supplied. (Note: the system adds information to the name
4328for identification - only the characters up to the first blank are
4329used for removing, selecting, etc.) This scene handler and viewer
4330become current.
4331
4332Parameter : scene-handler
4333 Parameter type : s
4334 Omittable : True
4335 Default value : taken from the current value
4336
4337Parameter : viewer-name
4338 Parameter type : s
4339 Omittable : True
4340 Default value : taken from the current value
4341
4342Parameter : window-size-hint
4343integer (pixels) for square window placed by window manager or X-Windows-type geometry string, e.g. 600x600-100+100
4344 Parameter type : s
4345 Omittable : True
4346 Default value : 600
4347
4348
4349
4350Command /vis/viewer/dolly
4351Guidance :
4352Incremental dolly.
4353Moves the camera incrementally towards target point.
4354
4355Parameter : increment
4356 Parameter type : d
4357 Omittable : True
4358 Default value : taken from the current value
4359
4360Parameter : Unit
4361 Parameter type : s
4362 Omittable : True
4363 Default value : m
4364 Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
4365
4366
4367
4368Command /vis/viewer/dollyTo
4369Guidance :
4370Dolly to specific coordinate.
4371Places the camera towards target point relative to standard camera point.
4372
4373Parameter : distance
4374 Parameter type : d
4375 Omittable : True
4376 Default value : taken from the current value
4377
4378Parameter : Unit
4379 Parameter type : s
4380 Omittable : True
4381 Default value : m
4382 Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
4383
4384
4385
4386Command /vis/viewer/flush
4387Guidance :
4388Compound command: "/vis/viewer/refresh" + "/vis/viewer/update".
4389Useful for refreshing and initiating post-processing for graphics
4390systems which need post-processing. By default, acts on current
4391viewer. "/vis/viewer/list" to see possible viewers. Viewer
4392becomes current.
4393
4394Parameter : viewer-name
4395 Parameter type : s
4396 Omittable : True
4397 Default value : taken from the current value
4398
4399
4400
4401Command /vis/viewer/list
4402Guidance :
4403Lists viewers(s).
4404See "/vis/verbose" for definition of verbosity.
4405
4406Parameter : viewer-name
4407 Parameter type : s
4408 Omittable : True
4409 Default value : all
4410
4411Parameter : verbosity
4412 Parameter type : s
4413 Omittable : True
4414 Default value : warnings
4415
4416
4417
4418Command /vis/viewer/pan
4419Guidance :
4420Incremental pan.
4421Moves the camera incrementally right and up by these amounts (as seen
4422from viewpoint direction).
4423
4424Parameter : right-increment
4425 Parameter type : d
4426 Omittable : True
4427 Default value : taken from the current value
4428
4429Parameter : up-increment
4430 Parameter type : d
4431 Omittable : True
4432 Default value : taken from the current value
4433
4434Parameter : unit
4435 Parameter type : s
4436 Omittable : True
4437 Default value : m
4438
4439
4440
4441Command /vis/viewer/panTo
4442Guidance :
4443Pan to specific coordinate.
4444Places the camera in this position right and up relative to standard
4445target point (as seen from viewpoint direction).
4446
4447Parameter : right
4448 Parameter type : d
4449 Omittable : True
4450 Default value : taken from the current value
4451
4452Parameter : up
4453 Parameter type : d
4454 Omittable : True
4455 Default value : taken from the current value
4456
4457Parameter : unit
4458 Parameter type : s
4459 Omittable : True
4460 Default value : m
4461
4462
4463
4464Command /vis/viewer/rebuild
4465Guidance :
4466Forces rebuild of graphical database.
4467By default, acts on current viewer. "/vis/viewer/list"
4468to see possible viewers. Viewer becomes current.
4469
4470Parameter : viewer-name
4471 Parameter type : s
4472 Omittable : True
4473 Default value : taken from the current value
4474
4475
4476
4477Command /vis/viewer/refresh
4478Guidance :
4479Refreshes viewer.
4480By default, acts on current viewer. "/vis/viewer/list"
4481to see possible viewers. Viewer becomes current.
4482
4483Parameter : viewer-name
4484 Parameter type : s
4485 Omittable : True
4486 Default value : taken from the current value
4487
4488
4489
4490Command /vis/viewer/reset
4491Guidance :
4492Resets viewer.
4493By default, acts on current viewer. "/vis/viewer/list"
4494to see possible viewers. Viewer becomes current.
4495
4496Parameter : viewer-name
4497 Parameter type : s
4498 Omittable : True
4499 Default value : taken from the current value
4500
4501
4502
4503Command /vis/viewer/scale
4504Guidance :
4505Incremental (non-uniform) scaling.
4506Multiplies components of current scaling by components of this factor.
4507 Scales (x,y,z) by corresponding components of the resulting factor.
4508
4509
4510Parameter : x-scale-multiplier
4511 Parameter type : d
4512 Omittable : True
4513 Default value : taken from the current value
4514
4515Parameter : y-scale-multiplier
4516 Parameter type : d
4517 Omittable : True
4518
4519 Default value : taken from the current value
4520
4521Parameter : z-scale-multiplier
4522 Parameter type : d
4523 Omittable : True
4524 Default value : taken from the current value
4525
4526
4527
4528Command /vis/viewer/scaleTo
4529Guidance :
4530Absolute (non-uniform) scaling.
4531Scales (x,y,z) by corresponding components of this factor.
4532
4533Parameter : x-scale-factor
4534 Parameter type : d
4535 Omittable : True
4536 Default value : taken from the current value
4537
4538Parameter : y-scale-factor
4539 Parameter type : d
4540 Omittable : True
4541 Default value : taken from the current value
4542
4543Parameter : z-scale-factor
4544 Parameter type : d
4545 Omittable : True
4546 Default value : taken from the current value
4547
4548
4549
4550Command /vis/viewer/select
4551Guidance :
4552Selects viewer.
4553Specify viewer by name. "/vis/viewer/list" to see possible viewers.
4554
4555Parameter : viewer-name
4556 Parameter type : s
4557 Omittable : False
4558
4559
4560
4561Command /vis/viewer/update
4562Guidance :
4563Triggers graphical database post-processing for viewers
4564using that technique.
4565For such viewers the view only becomes visible with this command.
4566By default, acts on current viewer. "/vis/viewer/list"
4567to see possible viewers. Viewer becomes current.
4568
4569Parameter : viewer-name
4570 Parameter type : s
4571 Omittable : True
4572 Default value : taken from the current value
4573
4574
4575
4576Command /vis/viewer/zoom
4577Guidance :
4578Incremental zoom.
4579Multiplies current magnification by this factor.
4580
4581Parameter : multiplier
4582 Parameter type : d
4583 Omittable : True
4584 Default value : taken from the current value
4585
4586
4587
4588Command /vis/viewer/zoomTo
4589Guidance :
4590Absolute zoom.
4591Magnifies standard magnification by this factor.
4592
4593Parameter : factor
4594 Parameter type : d
4595 Omittable : True
4596 Default value : taken from the current value
4597
4598Command directory path : /vis/viewer/set/
4599
4600
4601Guidance :
4602Set view parameters of current viewer.
4603
4604 Sub-directories :
4605 Commands :
4606 all * Copies view parameters.
4607 autoRefresh * Sets auto-refresh.
4608 auxiliaryEdge * Sets visibility of auxiliary edges
4609 background * Set background colour and transparency (default black and opaque).
4610 culling * Set culling options.
4611 cutawayMode * Sets cutaway mode - add (union) or multiply (intersection).
4612 edge * Edges become visible/invisible in surface mode.
4613 explodeFactor * Moves top-level drawn volumes by this factor from this centre.
4614 globalLineWidthScale * Multiplies line widths by this factor.
4615 globalMarkerScale * Multiplies marker sizes by this factor.
4616 hiddenEdge * Edges become hidden/seen in wireframe or surface mode.
4617 hiddenMarker * If true, closer objects hide markers. Otherwise, markers always show.
4618 lightsMove * Lights move with camera or with object
4619 lightsThetaPhi * Set direction from target to lights.
4620 lightsVector * Set direction from target to lights.
4621 lineSegmentsPerCircle * Set number of sides per circle for polygon/polyhedron drawing.
4622 projection * Orthogonal or perspective projection.
4623 sectionPlane * Set plane for drawing section (DCUT).
4624 style * Set style of drawing - w[ireframe] or s[urface].
4625 upThetaPhi * Set up vector.
4626 upVector * Set up vector.
4627 viewpointThetaPhi * Set direction from target to camera.
4628 viewpointVector * Set direction from target to camera.
4629
4630
4631Command /vis/viewer/set/all
4632Guidance :
4633Copies view parameters.
4634Copies view parameters (except the autoRefresh status) from
4635from-viewer to current viewer.
4636
4637Parameter : from-viewer-name
4638 Parameter type : s
4639 Omittable : False
4640
4641
4642
4643Command /vis/viewer/set/autoRefresh
4644Guidance :
4645Sets auto-refresh.
4646If true, view is automatically refreshed after a change of
4647view parameters.
4648
4649Parameter : auto-refresh
4650 Parameter type : b
4651 Omittable : True
4652 Default value : 0
4653
4654
4655
4656Command /vis/viewer/set/auxiliaryEdge
4657Guidance :
4658Sets visibility of auxiliary edges
4659Auxiliary edges, i.e., those that are part of a curved surface,
4660sometimes called soft edges, become visible/invisible.
4661
4662Parameter : edge
4663 Parameter type : b
4664 Omittable : True
4665 Default value : 0
4666
4667
4668
4669
4670Command /vis/viewer/set/background
4671Guidance :
4672Set background colour and transparency (default black and opaque).
4673Accepts (a) RGB triplet. e.g., ".3 .4 .5", or
4674(b) string such as "white", "black", "grey", "red"...
4675(c) an additional number for opacity, e.g., ".3 .4 .5 .6"
4676 or "grey ! ! .6" (note "!"'s for unused green and blue parameters),
4677 e.g. "! ! ! 0." for a transparent background.
4678
4679Parameter : red_or_string
4680 Parameter type : s
4681 Omittable : True
4682 Default value : 0.
4683
4684Parameter : green
4685 Parameter type : d
4686 Omittable : True
4687 Default value : 0
4688
4689Parameter : blue
4690 Parameter type : d
4691 Omittable : True
4692 Default value : 0
4693
4694Parameter : opacity
4695 Parameter type : d
4696 Omittable : True
4697 Default value : 1
4698
4699
4700
4701Command /vis/viewer/set/culling
4702Guidance :
4703Set culling options.
4704"global": enables/disables all other culling options.
4705"coveredDaughters": culls, i.e., eliminates, volumes that would not
4706be seen because covered by ancester volumes in surface drawing mode,
4707and then only if the ancesters are visible and opaque, and then only
4708if no sections or cutaways are in operation. Intended solely to
4709improve the speed of rendering visible volumes.
4710"invisible": culls objects with the invisible attribute set.
4711"density": culls volumes with density lower than threshold. Useful
4712for eliminating "container volumes" with no physical correspondence,
4713whose material is usually air. If this is selected, provide threshold
4714density and unit (g/cm3 mg/cm3 or kg/m3).
4715
4716Parameter : culling-option
4717 Parameter type : s
4718 Omittable : False
4719 Candidates : global coveredDaughters invisible density
4720
4721Parameter : action
4722 Parameter type : b
4723 Omittable : True
4724 Default value : 1
4725
4726Parameter : density-threshold
4727 Parameter type : d
4728 Omittable : True
4729 Default value : 0.01
4730
4731Parameter : unit
4732 Parameter type : s
4733 Omittable : True
4734 Default value : g/cm3
4735 Candidates : g/cm3, mg/cm3 kg/m3
4736
4737
4738
4739Command /vis/viewer/set/cutawayMode
4740Guidance :
4741Sets cutaway mode - add (union) or multiply (intersection).
4742
4743Parameter : cutaway-mode
4744 Parameter type : s
4745 Omittable : False
4746 Default value : union
4747 Candidates : add union multiply intersection
4748
4749
4750
4751Command /vis/viewer/set/edge
4752Guidance :
4753Edges become visible/invisible in surface mode.
4754
4755Parameter : edge
4756 Parameter type : b
4757 Omittable : True
4758 Default value : 1
4759
4760
4761
4762Command /vis/viewer/set/explodeFactor
4763Guidance :
4764Moves top-level drawn volumes by this factor from this centre.
4765
4766Parameter : explodeFactor
4767 Parameter type : d
4768 Omittable : True
4769 Default value : 1
4770 Parameter range : explodeFactor>=1.
4771
4772Parameter : x
4773Coordinate of explode centre.
4774 Parameter type : d
4775 Omittable : True
4776 Default value : 0
4777
4778Parameter : y
4779Coordinate of explode centre.
4780 Parameter type : d
4781 Omittable : True
4782 Default value : 0
4783
4784Parameter : z
4785Coordinate of explode centre.
4786 Parameter type : d
4787 Omittable : True
4788 Default value : 0
4789
4790Parameter : unit
4791Unit of explode centre.
4792 Parameter type : s
4793 Omittable : True
4794 Default value : m
4795
4796
4797
4798Command /vis/viewer/set/globalLineWidthScale
4799Guidance :
4800Multiplies line widths by this factor.
4801
4802Parameter : scale-factor
4803 Parameter type : d
4804 Omittable : True
4805 Default value : 1
4806
4807
4808
4809Command /vis/viewer/set/globalMarkerScale
4810Guidance :
4811Multiplies marker sizes by this factor.
4812
4813Parameter : scale-factor
4814 Parameter type : d
4815 Omittable : True
4816 Default value : 1
4817
4818
4819
4820Command /vis/viewer/set/hiddenEdge
4821Guidance :
4822Edges become hidden/seen in wireframe or surface mode.
4823
4824Parameter : hidden-edge
4825 Parameter type : b
4826 Omittable : True
4827 Default value : 1
4828
4829
4830
4831Command /vis/viewer/set/hiddenMarker
4832Guidance :
4833If true, closer objects hide markers. Otherwise, markers always show.
4834
4835Parameter : hidden-marker
4836 Parameter type : b
4837 Omittable : True
4838 Default value : 1
4839
4840
4841
4842Command /vis/viewer/set/lightsMove
4843Guidance :
4844Lights move with camera or with object
4845
4846Parameter : lightsMove
4847 Parameter type : s
4848 Omittable : False
4849 Candidates : cam camera with-camera obj object with-object
4850
4851
4852
4853Command /vis/viewer/set/lightsThetaPhi
4854Guidance :
4855Set direction from target to lights.
4856
4857Parameter : theta
4858 Parameter type : d
4859 Omittable : True
4860 Default value : 60
4861
4862Parameter : phi
4863 Parameter type : d
4864 Omittable : True
4865 Default value : 45
4866
4867Parameter : unit
4868 Parameter type : s
4869 Omittable : True
4870 Default value : deg
4871
4872
4873
4874Command /vis/viewer/set/lightsVector
4875Guidance :
4876Set direction from target to lights.
4877
4878Parameter : x
4879 Parameter type : d
4880 Omittable : True
4881 Default value : 1
4882
4883Parameter : y
4884 Parameter type : d
4885 Omittable : True
4886 Default value : 1
4887
4888Parameter : z
4889 Parameter type : d
4890 Omittable : True
4891 Default value : 1
4892
4893
4894
4895Command /vis/viewer/set/lineSegmentsPerCircle
4896Guidance :
4897Set number of sides per circle for polygon/polyhedron drawing.
4898Refers to graphical representation of objects with curved lines/surfaces.
4899
4900Parameter : line-segments
4901 Parameter type : i
4902 Omittable : True
4903 Default value : 24
4904
4905
4906
4907Command /vis/viewer/set/projection
4908Guidance :
4909Orthogonal or perspective projection.
4910
4911Parameter : projection
4912 Parameter type : s
4913 Omittable : True
4914 Default value : orthogonal
4915 Candidates : o orthogonal p perspective
4916
4917Parameter : field-half-angle
4918 Parameter type : d
4919 Omittable : True
4920 Default value : 30
4921
4922Parameter : unit
4923 Parameter type : s
4924 Omittable : True
4925 Default value : deg
4926
4927
4928
4929Command /vis/viewer/set/sectionPlane
4930Guidance :
4931Set plane for drawing section (DCUT).
4932E.g., for a y-z plane at x = 1 cm:
4933"/vis/viewer/set/sectionPlane on 1 0 0 cm 1 0 0".
4934To turn off: /vis/viewer/set/sectionPlane off
4935
4936Parameter : Selector
4937 Parameter type : c
4938 Omittable : True
4939 Default value : on
4940
4941Parameter : x
4942Coordinate of point on the plane.
4943 Parameter type : d
4944 Omittable : True
4945 Default value : 0
4946
4947Parameter : y
4948Coordinate of point on the plane.
4949 Parameter type : d
4950 Omittable : True
4951 Default value : 0
4952
4953Parameter : z
4954Coordinate of point on the plane.
4955 Parameter type : d
4956 Omittable : True
4957 Default value : 0
4958
4959Parameter : unit
4960Unit of point on the plane.
4961 Parameter type : s
4962 Omittable : True
4963 Default value : m
4964
4965Parameter : nx
4966Component of plane normal.
4967 Parameter type : d
4968 Omittable : True
4969 Default value : 1
4970
4971Parameter : ny
4972Component of plane normal.
4973 Parameter type : d
4974 Omittable : True
4975 Default value : 0
4976
4977Parameter : nz
4978Component of plane normal.
4979 Parameter type : d
4980 Omittable : True
4981 Default value : 0
4982
4983
4984
4985Command /vis/viewer/set/style
4986Guidance :
4987Set style of drawing - w[ireframe] or s[urface].
4988(Hidden line drawing is controlled by "/vis/viewer/set/hiddenEdge".)
4989
4990Parameter : style
4991 Parameter type : s
4992 Omittable : False
4993
4994
4995
4996Command /vis/viewer/set/upThetaPhi
4997Guidance :
4998Set up vector.
4999Viewer will attempt always to show this direction upwards.
5000
5001Parameter : theta
5002 Parameter type : d
5003 Omittable : True
5004 Default value : 90
5005
5006Parameter : phi
5007 Parameter type : d
5008 Omittable : True
5009 Default value : 90
5010
5011Parameter : unit
5012 Parameter type : s
5013 Omittable : True
5014 Default value : deg
5015
5016
5017
5018Command /vis/viewer/set/upVector
5019Guidance :
5020Set up vector.
5021Viewer will attempt always to show this direction upwards.
5022
5023Parameter : x
5024 Parameter type : d
5025 Omittable : True
5026 Default value : 0
5027
5028Parameter : y
5029 Parameter type : d
5030 Omittable : True
5031 Default value : 1
5032
5033Parameter : z
5034 Parameter type : d
5035 Omittable : True
5036 Default value : 0
5037
5038
5039
5040Command /vis/viewer/set/viewpointThetaPhi
5041Guidance :
5042Set direction from target to camera.
5043Also changes lightpoint direction if lights are set to move with camera.
5044
5045Parameter : theta
5046 Parameter type : d
5047 Omittable : True
5048 Default value : 60
5049
5050Parameter : phi
5051 Parameter type : d
5052
5053 Omittable : True
5054 Default value : 45
5055
5056Parameter : unit
5057 Parameter type : s
5058 Omittable : True
5059 Default value : deg
5060
5061
5062
5063Command /vis/viewer/set/viewpointVector
5064Guidance :
5065Set direction from target to camera.
5066Also changes lightpoint direction if lights are set to move with camera.
5067
5068Parameter : x
5069 Parameter type : d
5070 Omittable : True
5071 Default value : 1
5072
5073Parameter : y
5074 Parameter type : d
5075 Omittable : True
5076 Default value : 1
5077
5078Parameter : z
5079 Parameter type : d
5080 Omittable : True
5081 Default value : 1
5082
Note: See TracBrowser for help on using the repository browser.