1 | <html><head><title>Commands in /vis/viewer/set/</title></head> |
---|
2 | <body bgcolor="#ffffff"><h2>/vis/viewer/set/</h2><p> |
---|
3 | Set view parameters of current viewer.<br> |
---|
4 | <p><hr><p> |
---|
5 | <h2>Sub-directories : </h2><dl> |
---|
6 | </dl><p><hr><p> |
---|
7 | <h2>Commands : </h2><dl> |
---|
8 | <p><br><p><dt><b>all [<i>from-viewer-name</i>]</b> |
---|
9 | <p><dd> |
---|
10 | Copies view parameters.<br> |
---|
11 | Copies view parameters (except the autoRefresh status) from |
---|
12 | from-viewer to current viewer.<br> |
---|
13 | <p><dd>Available at all Geant4 states. |
---|
14 | <p><dd>Parameters<table border=1> |
---|
15 | <tr><td>from-viewer-name |
---|
16 | <td>type s |
---|
17 | <td><td></table> |
---|
18 | <p><br><p><dt><b>autoRefresh [<i>auto-refresh</i>]</b> |
---|
19 | <p><dd> |
---|
20 | Sets auto-refresh.<br> |
---|
21 | If true, view is automatically refreshed after a change of |
---|
22 | view parameters.<br> |
---|
23 | <p><dd>Available at all Geant4 states. |
---|
24 | <p><dd>Parameters<table border=1> |
---|
25 | <tr><td>auto-refresh |
---|
26 | <td>type b |
---|
27 | <td>Omittable : default value = 1 |
---|
28 | <td></table> |
---|
29 | <p><br><p><dt><b>auxiliaryEdge [<i>edge</i>]</b> |
---|
30 | <p><dd> |
---|
31 | Sets visibility of auxiliary edges<br> |
---|
32 | Auxiliary edges, i.e., those that are part of a curved surface, |
---|
33 | sometimes called soft edges, become visible/invisible.<br> |
---|
34 | <p><dd>Available at all Geant4 states. |
---|
35 | <p><dd>Parameters<table border=1> |
---|
36 | <tr><td>edge |
---|
37 | <td>type b |
---|
38 | <td>Omittable : default value = 1 |
---|
39 | <td></table> |
---|
40 | <p><br><p><dt><b>background [<i>red_or_string</i>] [<i>green</i>] [<i>blue</i>] [<i>opacity</i>]</b> |
---|
41 | <p><dd> |
---|
42 | Set background colour and transparency (default black and opaque).<br> |
---|
43 | Accepts (a) RGB triplet. e.g., ".3 .4 .5", or |
---|
44 | (b) string such as "white", "black", "grey", "red"... |
---|
45 | (c) an additional number for opacity, e.g., ".3 .4 .5 .6" |
---|
46 | or "grey ! ! .6" (note "!"'s for unused green and blue parameters), |
---|
47 | e.g. "! ! ! 0." for a transparent background.<br> |
---|
48 | <p><dd>Available at all Geant4 states. |
---|
49 | <p><dd>Parameters<table border=1> |
---|
50 | <tr><td>red_or_string |
---|
51 | <td>type s |
---|
52 | <td>Omittable : default value = 0. |
---|
53 | <td><tr><td>green |
---|
54 | <td>type d |
---|
55 | <td>Omittable : default value = 0 |
---|
56 | <td><tr><td>blue |
---|
57 | <td>type d |
---|
58 | <td>Omittable : default value = 0 |
---|
59 | <td><tr><td>opacity |
---|
60 | <td>type d |
---|
61 | <td>Omittable : default value = 1 |
---|
62 | <td></table> |
---|
63 | <p><br><p><dt><b>culling [<i>culling-option</i>] [<i>action</i>] [<i>density-threshold</i>] [<i>unit</i>]</b> |
---|
64 | <p><dd> |
---|
65 | Set culling options.<br> |
---|
66 | "global": enables/disables all other culling options.<br> |
---|
67 | "coveredDaughters": culls, i.e., eliminates, volumes that would not |
---|
68 | be seen because covered by ancester volumes in surface drawing mode, |
---|
69 | and then only if the ancesters are visible and opaque, and then only |
---|
70 | if no sections or cutaways are in operation. Intended solely to |
---|
71 | improve the speed of rendering visible volumes.<br> |
---|
72 | "invisible": culls objects with the invisible attribute set.<br> |
---|
73 | "density": culls volumes with density lower than threshold. Useful |
---|
74 | for eliminating "container volumes" with no physical correspondence, |
---|
75 | whose material is usually air. If this is selected, provide threshold |
---|
76 | density and unit (g/cm3 mg/cm3 or kg/m3).<br> |
---|
77 | <p><dd>Available at all Geant4 states. |
---|
78 | <p><dd>Parameters<table border=1> |
---|
79 | <tr><td>culling-option |
---|
80 | <td>type s |
---|
81 | <td><td>Parameter candidates : global coveredDaughters invisible density |
---|
82 | <tr><td>action |
---|
83 | <td>type b |
---|
84 | <td>Omittable : default value = 1 |
---|
85 | <td><tr><td>density-threshold |
---|
86 | <td>type d |
---|
87 | <td>Omittable : default value = 0.01 |
---|
88 | <td><tr><td>unit |
---|
89 | <td>type s |
---|
90 | <td>Omittable : default value = g/cm3 |
---|
91 | <td>Parameter candidates : g/cm3, mg/cm3 kg/m3 |
---|
92 | </table> |
---|
93 | <p><br><p><dt><b>cutawayMode [<i>cutaway-mode</i>]</b> |
---|
94 | <p><dd> |
---|
95 | Sets cutaway mode - add (union) or multiply (intersection).<br> |
---|
96 | <p><dd>Available at all Geant4 states. |
---|
97 | <p><dd>Parameters<table border=1> |
---|
98 | <tr><td>cutaway-mode |
---|
99 | <td>type s |
---|
100 | <td><td>Parameter candidates : add union multiply intersection |
---|
101 | </table> |
---|
102 | <p><br><p><dt><b>edge [<i>edge</i>]</b> |
---|
103 | <p><dd> |
---|
104 | Edges become visible/invisible in surface mode.<br> |
---|
105 | <p><dd>Available at all Geant4 states. |
---|
106 | <p><dd>Parameters<table border=1> |
---|
107 | <tr><td>edge |
---|
108 | <td>type b |
---|
109 | <td>Omittable : default value = 1 |
---|
110 | <td></table> |
---|
111 | <p><br><p><dt><b>explodeFactor [<i>explodeFactor</i>] [<i>x</i>] [<i>y</i>] [<i>z</i>] [<i>unit</i>]</b> |
---|
112 | <p><dd> |
---|
113 | Moves top-level drawn volumes by this factor from this centre.<br> |
---|
114 | <p><dd>Available at all Geant4 states. |
---|
115 | <p><dd>Parameters<table border=1> |
---|
116 | <tr><td>explodeFactor |
---|
117 | <td>type d |
---|
118 | <td>Omittable : default value = 1 |
---|
119 | <td>Parameter range : explodeFactor>=1. |
---|
120 | <tr><td>x |
---|
121 | <td>type d |
---|
122 | <td>Omittable : default value = 0 |
---|
123 | <td><tr><td>y |
---|
124 | <td>type d |
---|
125 | <td>Omittable : default value = 0 |
---|
126 | <td><tr><td>z |
---|
127 | <td>type d |
---|
128 | <td>Omittable : default value = 0 |
---|
129 | <td><tr><td>unit |
---|
130 | <td>type s |
---|
131 | <td>Omittable : default value = m |
---|
132 | <td></table> |
---|
133 | <p><br><p><dt><b>globalLineWidthScale [<i>scale-factor</i>]</b> |
---|
134 | <p><dd> |
---|
135 | Multiplies line widths by this factor.<br> |
---|
136 | <p><dd>Available at all Geant4 states. |
---|
137 | <p><dd>Parameters<table border=1> |
---|
138 | <tr><td>scale-factor |
---|
139 | <td>type d |
---|
140 | <td>Omittable : default value = 1 |
---|
141 | <td></table> |
---|
142 | <p><br><p><dt><b>globalMarkerScale [<i>scale-factor</i>]</b> |
---|
143 | <p><dd> |
---|
144 | Multiplies marker sizes by this factor.<br> |
---|
145 | <p><dd>Available at all Geant4 states. |
---|
146 | <p><dd>Parameters<table border=1> |
---|
147 | <tr><td>scale-factor |
---|
148 | <td>type d |
---|
149 | <td>Omittable : default value = 1 |
---|
150 | <td></table> |
---|
151 | <p><br><p><dt><b>hiddenEdge [<i>hidden-edge</i>]</b> |
---|
152 | <p><dd> |
---|
153 | Edges become hidden/seen in wireframe or surface mode.<br> |
---|
154 | <p><dd>Available at all Geant4 states. |
---|
155 | <p><dd>Parameters<table border=1> |
---|
156 | <tr><td>hidden-edge |
---|
157 | <td>type b |
---|
158 | <td>Omittable : default value = 1 |
---|
159 | <td></table> |
---|
160 | <p><br><p><dt><b>hiddenMarker [<i>hidden-marker</i>]</b> |
---|
161 | <p><dd> |
---|
162 | If true, closer objects hide markers. Otherwise, markers always show.<br> |
---|
163 | <p><dd>Available at all Geant4 states. |
---|
164 | <p><dd>Parameters<table border=1> |
---|
165 | <tr><td>hidden-marker |
---|
166 | <td>type b |
---|
167 | <td>Omittable : default value = 1 |
---|
168 | <td></table> |
---|
169 | <p><br><p><dt><b>lightsMove [<i>lightsMove</i>]</b> |
---|
170 | <p><dd> |
---|
171 | Lights move with camera or with object<br> |
---|
172 | <p><dd>Available at all Geant4 states. |
---|
173 | <p><dd>Parameters<table border=1> |
---|
174 | <tr><td>lightsMove |
---|
175 | <td>type s |
---|
176 | <td><td>Parameter candidates : cam camera with-camera obj object with-object |
---|
177 | </table> |
---|
178 | <p><br><p><dt><b>lightsThetaPhi [<i>theta</i>] [<i>phi</i>] [<i>unit</i>]</b> |
---|
179 | <p><dd> |
---|
180 | Set direction from target to lights.<br> |
---|
181 | <p><dd>Available at all Geant4 states. |
---|
182 | <p><dd>Parameters<table border=1> |
---|
183 | <tr><td>theta |
---|
184 | <td>type d |
---|
185 | <td>Omittable : default value = 60 |
---|
186 | <td><tr><td>phi |
---|
187 | <td>type d |
---|
188 | <td>Omittable : default value = 45 |
---|
189 | <td><tr><td>unit |
---|
190 | <td>type s |
---|
191 | <td>Omittable : default value = deg |
---|
192 | <td></table> |
---|
193 | <p><br><p><dt><b>lightsVector [<i>x</i>] [<i>y</i>] [<i>z</i>]</b> |
---|
194 | <p><dd> |
---|
195 | Set direction from target to lights.<br> |
---|
196 | <p><dd>Available at all Geant4 states. |
---|
197 | <p><dd>Parameters<table border=1> |
---|
198 | <tr><td>x |
---|
199 | <td>type d |
---|
200 | <td>Omittable : default value = 1 |
---|
201 | <td><tr><td>y |
---|
202 | <td>type d |
---|
203 | <td>Omittable : default value = 1 |
---|
204 | <td><tr><td>z |
---|
205 | <td>type d |
---|
206 | <td>Omittable : default value = 1 |
---|
207 | <td></table> |
---|
208 | <p><br><p><dt><b>lineSegmentsPerCircle [<i>line-segments</i>]</b> |
---|
209 | <p><dd> |
---|
210 | Set number of sides per circle for polygon/polyhedron drawing.<br> |
---|
211 | Refers to graphical representation of objects with curved lines/surfaces.<br> |
---|
212 | <p><dd>Available at all Geant4 states. |
---|
213 | <p><dd>Parameters<table border=1> |
---|
214 | <tr><td>line-segments |
---|
215 | <td>type i |
---|
216 | <td>Omittable : default value = 24 |
---|
217 | <td></table> |
---|
218 | <p><br><p><dt><b>picking [<i>picking</i>]</b> |
---|
219 | <p><dd> |
---|
220 | Sets picking, if available.<br> |
---|
221 | If true, view is set up for picking, if available. |
---|
222 | For required actions, watch for instructions for viewer.<br> |
---|
223 | <p><dd>Available at all Geant4 states. |
---|
224 | <p><dd>Parameters<table border=1> |
---|
225 | <tr><td>picking |
---|
226 | <td>type b |
---|
227 | <td>Omittable : default value = 1 |
---|
228 | <td></table> |
---|
229 | <p><br><p><dt><b>projection [<i>projection</i>] [<i>field-half-angle</i>] [<i>unit</i>]</b> |
---|
230 | <p><dd> |
---|
231 | Orthogonal or perspective projection.<br> |
---|
232 | <p><dd>Available at all Geant4 states. |
---|
233 | <p><dd>Parameters<table border=1> |
---|
234 | <tr><td>projection |
---|
235 | <td>type s |
---|
236 | <td>Omittable : default value = orthogonal |
---|
237 | <td>Parameter candidates : o orthogonal p perspective |
---|
238 | <tr><td>field-half-angle |
---|
239 | <td>type d |
---|
240 | <td>Omittable : default value = 30 |
---|
241 | <td><tr><td>unit |
---|
242 | <td>type s |
---|
243 | <td>Omittable : default value = deg |
---|
244 | <td></table> |
---|
245 | <p><br><p><dt><b>sectionPlane [<i>Selector</i>] [<i>x</i>] [<i>y</i>] [<i>z</i>] [<i>unit</i>] [<i>nx</i>] [<i>ny</i>] [<i>nz</i>]</b> |
---|
246 | <p><dd> |
---|
247 | Set plane for drawing section (DCUT).<br> |
---|
248 | E.g., for a y-z plane at x = 1 cm: |
---|
249 | "/vis/viewer/set/sectionPlane on 1 0 0 cm 1 0 0". |
---|
250 | To turn off: /vis/viewer/set/sectionPlane off<br> |
---|
251 | <p><dd>Available at all Geant4 states. |
---|
252 | <p><dd>Parameters<table border=1> |
---|
253 | <tr><td>Selector |
---|
254 | <td>type c |
---|
255 | <td>Omittable : default value = on |
---|
256 | <td><tr><td>x |
---|
257 | <td>type d |
---|
258 | <td>Omittable : default value = 0 |
---|
259 | <td><tr><td>y |
---|
260 | <td>type d |
---|
261 | <td>Omittable : default value = 0 |
---|
262 | <td><tr><td>z |
---|
263 | <td>type d |
---|
264 | <td>Omittable : default value = 0 |
---|
265 | <td><tr><td>unit |
---|
266 | <td>type s |
---|
267 | <td>Omittable : default value = m |
---|
268 | <td><tr><td>nx |
---|
269 | <td>type d |
---|
270 | <td>Omittable : default value = 1 |
---|
271 | <td><tr><td>ny |
---|
272 | <td>type d |
---|
273 | <td>Omittable : default value = 0 |
---|
274 | <td><tr><td>nz |
---|
275 | <td>type d |
---|
276 | <td>Omittable : default value = 0 |
---|
277 | <td></table> |
---|
278 | <p><br><p><dt><b>style [<i>style</i>]</b> |
---|
279 | <p><dd> |
---|
280 | Set style of drawing - w[ireframe] or s[urface].<br> |
---|
281 | (Hidden line drawing is controlled by "/vis/viewer/set/hiddenEdge".)<br> |
---|
282 | <p><dd>Available at all Geant4 states. |
---|
283 | <p><dd>Parameters<table border=1> |
---|
284 | <tr><td>style |
---|
285 | <td>type s |
---|
286 | <td><td></table> |
---|
287 | <p><br><p><dt><b>upThetaPhi [<i>theta</i>] [<i>phi</i>] [<i>unit</i>]</b> |
---|
288 | <p><dd> |
---|
289 | Set up vector.<br> |
---|
290 | Viewer will attempt always to show this direction upwards.<br> |
---|
291 | <p><dd>Available at all Geant4 states. |
---|
292 | <p><dd>Parameters<table border=1> |
---|
293 | <tr><td>theta |
---|
294 | <td>type d |
---|
295 | <td>Omittable : default value = 90 |
---|
296 | <td><tr><td>phi |
---|
297 | <td>type d |
---|
298 | <td>Omittable : default value = 90 |
---|
299 | <td><tr><td>unit |
---|
300 | <td>type s |
---|
301 | <td>Omittable : default value = deg |
---|
302 | <td></table> |
---|
303 | <p><br><p><dt><b>upVector [<i>x</i>] [<i>y</i>] [<i>z</i>]</b> |
---|
304 | <p><dd> |
---|
305 | Set up vector.<br> |
---|
306 | Viewer will attempt always to show this direction upwards.<br> |
---|
307 | <p><dd>Available at all Geant4 states. |
---|
308 | <p><dd>Parameters<table border=1> |
---|
309 | <tr><td>x |
---|
310 | <td>type d |
---|
311 | <td>Omittable : default value = 0 |
---|
312 | <td><tr><td>y |
---|
313 | <td>type d |
---|
314 | <td>Omittable : default value = 1 |
---|
315 | <td><tr><td>z |
---|
316 | <td>type d |
---|
317 | <td>Omittable : default value = 0 |
---|
318 | <td></table> |
---|
319 | <p><br><p><dt><b>viewpointThetaPhi [<i>theta</i>] [<i>phi</i>] [<i>unit</i>]</b> |
---|
320 | <p><dd> |
---|
321 | Set direction from target to camera.<br> |
---|
322 | Also changes lightpoint direction if lights are set to move with camera.<br> |
---|
323 | <p><dd>Available at all Geant4 states. |
---|
324 | <p><dd>Parameters<table border=1> |
---|
325 | <tr><td>theta |
---|
326 | <td>type d |
---|
327 | <td>Omittable : default value = 60 |
---|
328 | <td><tr><td>phi |
---|
329 | <td>type d |
---|
330 | <td>Omittable : default value = 45 |
---|
331 | <td><tr><td>unit |
---|
332 | <td>type s |
---|
333 | <td>Omittable : default value = deg |
---|
334 | <td></table> |
---|
335 | <p><br><p><dt><b>viewpointVector [<i>x</i>] [<i>y</i>] [<i>z</i>]</b> |
---|
336 | <p><dd> |
---|
337 | Set direction from target to camera.<br> |
---|
338 | Also changes lightpoint direction if lights are set to move with camera.<br> |
---|
339 | <p><dd>Available at all Geant4 states. |
---|
340 | <p><dd>Parameters<table border=1> |
---|
341 | <tr><td>x |
---|
342 | <td>type d |
---|
343 | <td>Omittable : default value = 1 |
---|
344 | <td><tr><td>y |
---|
345 | <td>type d |
---|
346 | <td>Omittable : default value = 1 |
---|
347 | <td><tr><td>z |
---|
348 | <td>type d |
---|
349 | <td>Omittable : default value = 1 |
---|
350 | <td></table> |
---|
351 | </dl></body></html> |
---|