musrsim/geant4/LEMuSR/doc/commands/_vis_viewer_.html
2006-02-23 17:30:21 +00:00

194 lines
6.5 KiB
HTML

<html><head><title>Commands in /vis/viewer/</title></head>
<body bgcolor="#ffffff"><h2>/vis/viewer/</h2><p>
Operations on Geant4 viewers.<br>
<p><hr><p>
<h2>Sub-directories : </h2><dl>
<p><br><p><dt><a href="_vis_viewer_set_.html">/vis/viewer/set/</a>
<p><dd>Set view parameters of current viewer.
</dl><p><hr><p>
<h2>Commands : </h2><dl>
<p><br><p><dt><b>clear [<i>viewer-name</i>]</b>
<p><dd>
Clears viewer.<br>
By default, clears current viewer. Specified viewer becomes current.
"/vis/viewer/list" to see possible viewer names.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>viewer-name
<td>type s
<td>Omittable : current value is used as the default value.
<td></table>
<p><br><p><dt><b>create [<i>scene-handler</i>] [<i>viewer-name</i>] [<i>window-size-hint</i>]</b>
<p><dd>
Creates a viewer for the specified scene handler.<br>
Default scene handler is the current scene handler. Invents a name
if not supplied. (Note: the system adds information to the name
for identification - only the characters up to the first blank are
used for removing, selecting, etc.) This scene handler and viewer
become current.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>scene-handler
<td>type s
<td>Omittable : current value is used as the default value.
<td><tr><td>viewer-name
<td>type s
<td>Omittable : current value is used as the default value.
<td><tr><td>window-size-hint
<td>type i
<td>Omittable : default value = 600
<td></table>
<p><br><p><dt><b>dolly [<i>increment</i>] [<i>Unit</i>]</b>
<p><dd>
Incremental dolly.<br>
Moves the camera incrementally towards target point.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>increment
<td>type d
<td>Omittable : current value is used as the default value.
<td><tr><td>Unit
<td>type s
<td>Omittable : default value = m
<td>Parameter candidates : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
</table>
<p><br><p><dt><b>dollyTo [<i>distance</i>] [<i>Unit</i>]</b>
<p><dd>
Dolly to specific coordinate.<br>
Places the camera towards target point relative to standard camera point.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>distance
<td>type d
<td>Omittable : current value is used as the default value.
<td><tr><td>Unit
<td>type s
<td>Omittable : default value = m
<td>Parameter candidates : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
</table>
<p><br><p><dt><b>flush [<i>viewer-name</i>]</b>
<p><dd>
Compound command: "/vis/viewer/refresh" + "/vis/viewer/update".<br>
Useful for refreshing and initiating post-processing for graphics
systems which need post-processing. By default, acts on current
viewer. "/vis/viewer/list" to see possible viewers. Viewer
becomes current.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>viewer-name
<td>type s
<td>Omittable : current value is used as the default value.
<td></table>
<p><br><p><dt><b>list [<i>viewer-name</i>] [<i>verbosity</i>]</b>
<p><dd>
Lists viewers(s).<br>
See "/vis/verbose" for definition of verbosity.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>viewer-name
<td>type s
<td>Omittable : default value = all
<td><tr><td>verbosity
<td>type s
<td>Omittable : default value = 0
<td></table>
<p><br><p><dt><b>pan [<i>right-increment</i>] [<i>up-increment</i>] [<i>unit</i>]</b>
<p><dd>
Incremental pan.<br>
Moves the camera incrementally right and up by these amounts (as seen
from viewpoint direction).<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>right-increment
<td>type d
<td>Omittable : current value is used as the default value.
<td><tr><td>up-increment
<td>type d
<td>Omittable : current value is used as the default value.
<td><tr><td>unit
<td>type s
<td>Omittable : default value = m
<td></table>
<p><br><p><dt><b>panTo [<i>right</i>] [<i>up</i>] [<i>unit</i>]</b>
<p><dd>
Pan to specific coordinate.<br>
Places the camera in this position right and up relative to standard
target point (as seen from viewpoint direction).<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>right
<td>type d
<td>Omittable : current value is used as the default value.
<td><tr><td>up
<td>type d
<td>Omittable : current value is used as the default value.
<td><tr><td>unit
<td>type s
<td>Omittable : default value = m
<td></table>
<p><br><p><dt><b>refresh [<i>viewer-name</i>]</b>
<p><dd>
Refreshes viewer.<br>
By default, acts on current viewer. "/vis/viewer/list"
to see possible viewers. Viewer becomes current.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>viewer-name
<td>type s
<td>Omittable : current value is used as the default value.
<td></table>
<p><br><p><dt><b>reset [<i>viewer-name</i>]</b>
<p><dd>
Resets viewer.<br>
By default, acts on current viewer. "/vis/viewer/list"
to see possible viewers. Viewer becomes current.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>viewer-name
<td>type s
<td>Omittable : current value is used as the default value.
<td></table>
<p><br><p><dt><b>select [<i>viewer-name</i>]</b>
<p><dd>
Selects viewer.<br>
Specify viewer by name. "/vis/viewer/list" to see possible viewers.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>viewer-name
<td>type s
<td><td></table>
<p><br><p><dt><b>update [<i>viewer-name</i>]</b>
<p><dd>
Triggers graphical database post-processing for viewers
using that technique.<br>
For such viewers the view only becomes visible with this command.
By default, acts on current viewer. "/vis/viewer/list"
to see possible viewers. Viewer becomes current.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>viewer-name
<td>type s
<td>Omittable : current value is used as the default value.
<td></table>
<p><br><p><dt><b>zoom [<i>multiplier</i>]</b>
<p><dd>
Incremental zoom.<br>
Multiplies current magnification by this factor.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>multiplier
<td>type d
<td>Omittable : current value is used as the default value.
<td></table>
<p><br><p><dt><b>zoomTo [<i>factor</i>]</b>
<p><dd>
Absolute zoom.<br>
Magnifies standard magnification by this factor.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>factor
<td>type d
<td>Omittable : current value is used as the default value.
<td></table>
</dl></body></html>