ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/util/trad.hlp
(Generate patch)

Comparing ray/src/util/trad.hlp (file contents):
Revision 2.2 by greg, Fri Oct 28 11:09:52 1994 UTC vs.
Revision 2.10 by greg, Tue Feb 21 14:27:06 1995 UTC

# Line 2 | Line 2
2  
3   This help file is associated with the trad interface to the Radiance
4   rad(1) program.  Trad consists of trad.wsh and one do_*.tcl file for
5 < each screen.  There are currently seven such screens:  Action, File,
6 < Options, Results, Scene, Views and Zone.
5 > each screen.  There are currently seven such screens:  File, Scene,
6 > Zone, Views, Options, Action and Results.
7  
8   .Trad.Intro
9  
# Line 48 | Line 48 | the left mouse button while holding the control key ov
48   curiosity in the main trad window.
49   (In general, only active windows are given help file links -- click
50   on these rather than the text labels.)
51 + Additional search capabilities are available over all topics using
52 + the "Grep" button.
53  
54   For help on the help facility itself, Control-click on the problem
55   help widget or on the window title in the upper right corner for
# Line 55 | Line 57 | more general information.
57   (To get back to trad-specific help, press the "HELP" button in the
58   main trad window or Control-click on a trad widget.)
59  
58 Once the help window has been displayed, it is usually best to
59 lower or iconify it rather than dismissing it if further help is
60 needed.
61 This way, you will not have to wait for the help file to be read in
62 all over again every time you have a question.
63
60   .Trad.Messages
61  
62 < Informative messages, commands executed by rad, and errors
62 > Informative messages, commands executed by rad, and errors
63   appear in the message window at the bottom of the trad frame.
64 < Growing the trad window means growing this message window, and
64 > Growing the trad window means growing this message window, and
65   not much else.
66   This is not really necessary, since the window will be grown
67   automatically if the message requires it.
# Line 339 | Line 335 | All other variables will be unaffected.
335  
336   .Scene.Revert
337  
338 < The "Revert" button is a convenient way to revert to the original
338 > The "Revert" button is a convenient way to revert to the original
339   values in the rad input file.
340   Only the variables on the Scene screen will be affected, but any changes
341   to these variables since the last save will be lost.
# Line 353 | Line 349 | This zone need not correspond exactly to any interior
349   walls, as it is used primarily to set rendering parameters and
350   standard viewpoints.
351  
352 < An interior zone means that standard viewpoints will be selected
352 > An interior zone means that standard viewpoints will be selected
353   from the inside of this box.
354   An exterior zone means that standard viewpoints will be selected
355   from the outside of this box.
356 < The default zone is an exterior one computed from the bounding box
356 > The default zone is an exterior one computed from the bounding box
357   of the entire scene.
358   (Note that this is not usually desirable.)
359  
# Line 371 | Line 367 | the rad manual page.
367  
368   .Zone.Type
369  
370 < There are two types of zones understood by rad, "Interior" and
370 > There are two types of zones understood by rad, "Interior" and
371   "Exterior".
372 < An interior zone is indicated when renderings generally take place
372 > An interior zone is indicated when renderings generally take place
373   inside a specified 3-d box.
374   A typical example might be a single room or auditorium.
375   An exterior zone is indicated when renderings generally take place
# Line 505 | Line 501 | used for exterior zones and 0.01 for interior zones.
501  
502   The "Copy" button on the Zone screen takes all values for this
503   screen from another rad input file, replacing the current values.
504 < Specifically, the rad variables "ZONE, DETAIL, INDIRECT,
504 > Specifically, the rad variables "ZONE, DETAIL, INDIRECT,
505   VARIABILITY and EXPOSURE" will be copied from the named file.
506  
507   All other variables will be left untouched.
508  
509   .Zone.Revert
510  
511 < The "Revert" button is a convenient way to revert to the original
511 > The "Revert" button is a convenient way to revert to the original
512   values in the rad input file.
513   Only the variables on the Zone screen will be affected, but any changes
514   to these variables since the last save will be lost.
# Line 524 | Line 520 | This screen provides a means of setting the multi-valu
520   "view" variable.
521   Each view setting is listed by name, or by number if no name has
522   been assigned.
523 < To add a new view, enter a unique name and specify the view
523 > To add a new view, enter a unique name and specify the view
524   options,
525   then press the "Add" or "Set Default" button.
526   If a view with the same name already exists, it is unconditionally
# Line 534 | Line 530 | and/or parameters, and press the "Change" button.
530   To remove an unwanted view, select it and press the "Delete" button.
531   To undo this action, simply press the "Add" button again.
532  
533 < The first view in the list is the default given to rview during
533 > The first view in the list is the default given to rview during
534   interactive rendering, and is the first view rendered in a batch run.
535   To change the default view, select the newly desired view and press
536   the "Set Default" button.
# Line 569 | Line 565 | The standard view is "X" is used if no views are speci
565  
566   Each view has a unique name, which may be chosen at the user's
567   discretion or taken from a list of standard views, described below.
568 < An invented name should be kept as short as possible, since it is
568 > An invented name should be kept as short as possible, since it is
569   added to the picture file name along with the standard ".pic" suffix.
570  
571   The standard views are specified by strings of the form
# Line 582 | Line 578 | means maximum X, lower case "y" means minimum Y and so
578   The final letter is the view type, where 'v' is perspective (the
579   default), 'l' is parallel, 'a' is angular fisheye, and 'h' is
580   hemispherical fisheye.
581 < A perspective view from maximum X, minimum Y would be "Xy" or
581 > A perspective view from maximum X, minimum Y would be "Xy" or
582   "Xyv".
583   A parallel view from maximum Z would be "Zl".
584   If "ZONE" is an interior zone, the standard views will
# Line 624 | Line 620 | view options, all of which begin with "-v".
620   Just briefly, the "-vt?" option sets the view type, where "?" is
621   replaced by one of the letters "v, l, a or h", corresponding to
622   perspective, parallel, angular and hemispherical fisheye, respectively.
623 < The "-vp x y z" option sets the view position (eyepoint), where "x y z"
623 > The "-vp x y z" option sets the view position (eyepoint), where "x y z"
624   is replaced by the position in 3-space.
625   The "-vd xd yd zd" option sets the view direction, where "xd yd zd"
626   is a vector pointing in the desired direction.
# Line 633 | Line 629 | the eyepoint from the look-at point.  Vector normaliza
629   unnecessary.)
630   The "-vh horiz" and "-vv vert" options set the horizontal and
631   vertical view sizes, respectively.
632 < For perspective views, these correspond to full camera angles in
632 > For perspective views, these correspond to full camera angles in
633   degrees.
634   For parallel views (using the "-vtl" option), they correspond to
635   image plane size in world coordinates.
# Line 648 | Line 644 | In particular, make sure that each option and each arg
644   space between it and whatever follows.
645  
646   Hitting return in the "Options" window is equivalent to pressing the
647 < "Add" button.
647 > "Add" button followed by the "Clear" button.
648  
649   .Views.Add
650  
# Line 761 | Line 757 | untouched.
757  
758   .Views.Revert
759  
760 < The "Revert" button is a convenient way to revert to the original
760 > The "Revert" button is a convenient way to revert to the original
761   values in the rad input file.
762   Only the variables on the Views screen will be affected, but any changes
763   to these variables since the last save will be lost.
# Line 820 | Line 816 | details.)
816  
817   .Options.Penumbras
818  
819 < The "Penumbras" setting determines whether or not Radiance will
819 > The "Penumbras" setting determines whether or not Radiance will
820   make a special effort to generate soft shadows from area light sources.
821   Since this is a potentially expensive calculation, penumbras should
822   only be switched "On" when they are really needed.
# Line 848 | Line 844 | vary according to the location and characteristics of
844  
845   .Options.AmbDelete
846  
847 < The "Delete" button next to the "Ambfile" window on the Options
847 > The "Delete" button next to the "Ambfile" window on the Options
848   screens allows you to remove the named ambient file.
849   This is usually done when a change to one or more rad variables
850   casts doubt on the accuracy of the values stored in this file.
# Line 879 | Line 875 | a given rendering has progressed.
875   Normally, progress reports and errors during batch renderings
876   are sent to the error file given by the root of the rad input
877   file name followed by the ".err" suffix.
878 < (See the "Errors" topic under the "Action" screen category.)
878 > (See the "CheckErr" topic under the "Action" screen category.)
879   If you wish these reports and errors to be directed to a different
880   file, follow the time interval by a space and a file name.
881  
882   No setting on this variable means do not report rendering progress.
883 < A zero setting means the same thing, and may be used when a
883 > A zero setting means the same thing, and may be used when a
884   separate error file is desired but progress reports are not.
885  
886   .Options.Oconv
# Line 925 | Line 921 | since rad does not have the intelligence to do it for
921  
922   The "render opts" window is used to specify additional options to
923   the rview(1) and rpict(1) rendering programs.
924 < Most of the important parameters are computed by rad, so this
924 > Most of the important parameters are computed by rad, so this
925   window is usually used to override specific parameters or to give
926   additional information, such as which materials to exclude from the
927   interreflection calculation.
# Line 978 | Line 974 | foreground.
974   The next set of buttons provides for the control of a batch
975   rendering process, taking place in the background.
976   Finally, the bottom set of buttons allows you to preview what would
977 < happen during a batch rendering, or (equivalently) make a script of
977 > happen during a batch rendering, or (equivalently) make a script of
978   UNIX commands for later execution.
979  
980   When the Action screen is first brought up, the message window
# Line 1053 | Line 1049 | unfortunately.)
1049  
1050   .Action.Rview
1051  
1052 < The "rview" button on the Action screen starts an interactive
1053 < rendering for the selected view, indicated by the menu button
1052 > The "rview" button on the Action screen starts an interactive
1053 > rendering for the selected view, indicated by the menu button
1054   just to the right.
1055 < Other views may be accessed within rview using the "L name"
1056 < command, and new views can be added with the "V name"
1055 > Other views may be accessed within rview using the "L name"
1056 > command, and new views can be added with the "V name"
1057   command.
1062 (See the rview(1) man page and the "View" topic in the current
1063 help category for more information.)
1058  
1059 < If the octree is out-of-date, it will be rebuilt before rendering
1059 > When using the "V" command to change an existing view, do not
1060 > give it an existing name because the previous view will not be overridden.
1061 > Instead, give it a new name (or no name, which will show up as
1062 > a number later), then use the Views screen to override the previous
1063 > view definition with the new one.
1064 > (See the "View" topic in the current
1065 > help category, the "Change" topic under "Views" and the rview(1)
1066 > manual page for more information.)
1067 >
1068 > If the octree is out-of-date, it will be rebuilt before rendering
1069   begins.
1070  
1071   .Action.View
1072  
1073   The Action screen contains two menus for selecting views.
1074 < The top menu, next to the "rview" button, sets the view to start
1074 > The top menu, next to the "rview" button, sets the view to start
1075   with in rview, and is selected from the current view list.
1076 < The second view menu, next to the "Start" button for batch
1076 > The second view menu, next to the "Start" button for batch
1077   rendering, selects the view or views to render in batch mode.
1078 < If the special entry "ALL" is selected, then every view in the
1078 > If the special entry "ALL" is selected, then every view in the
1079   current list will be rendered if it hasn't been already.
1080  
1081 < The batch rendering view menu also selects the view or views
1081 > The view menu next to the "rview" button will be disabled if there
1082 > is only one view to choose from.
1083 > The view menu next to the "Start" button will be disabled if there
1084 > is a batch job in progress, and thus the view cannot be changed.
1085 >
1086 > The batch rendering view menu also selects the view or views
1087   to use in producing a script during a dry run.
1088  
1089   .Action.Start
1090  
1091 < The "Start" button for batch rendering on the Action screen
1092 < initiates a rad rendering process in the background using the
1091 > The "Start" button for batch rendering on the Action screen
1092 > initiates a rad rendering process in the background using the
1093   selected view or views shown on the menu button to the right.
1094  
1095   If any of the rad variables have been changed since the
# Line 1090 | Line 1098 | your changes before starting a background process.
1098   If you discard these changes, then the batch rendering will be
1099   conducted using the previously saved values.
1100  
1101 < Once a background process is going, the "Start" button is
1102 < disabled, and rendering progress can be monitored by checking
1101 > Once a background process is going, the "Start" button is
1102 > disabled, and rendering progress can be monitored by checking
1103   the error file periodically.
1104 < (This file is named by the root of the rad input file followed by
1104 > (This file is named by the root of the rad input file followed by
1105   ".err".)
1106 < When a batch process is started or already running, this button
1107 < will be disabled.
1106 > When a batch process is started or already running, or when a
1107 > process is on another host and its status is unknown,
1108 > this button will be disabled.
1109  
1110 < The background process can be killed during this or later
1110 > The background process can be killed during this or later
1111   invocations of trad using the "Kill" button.
1112 + If the process was started on another machine and the status is unknown,
1113 + it will be necessary to run trad from the other host or remove the error
1114 + file manually before starting a background process on this machine.
1115 + This is to protect you from the great confusion that results when two
1116 + machines are working from the same project file.
1117  
1118   .Action.Kill
1119  
1120 < The batch rendering "Kill" button kills the
1120 > The batch rendering "Kill" button kills the
1121   background process started earlier with the "Start" button.
1122 < The rad process id is taken from the first line of the error file,
1122 > The rad process id is taken from the first line of the error file,
1123   and this process and all its children are killed when the
1124   button is pressed.
1125  
1126 < So long as there is an ambient file specified in the Options
1127 < screen, no data is lost by killing and restarting a batch
1126 > So long as there is an ambient file specified in the Options
1127 > screen, no data is lost by killing and restarting a batch
1128   rendering, though some new startup costs will be incurred.
1129  
1130 < The "Kill" button is disabled if no running batch process is
1131 < detected.
1130 > The "Kill" button is disabled if no running batch process is
1131 > detected on the current host machine.
1132  
1133   .Action.CheckErr
1134  
1135   Pressing the "Check errors" button
1136 < displays the contents of the batch rendering error file, named
1137 < by the root of the current rad input file followed by the ".err"
1136 > displays the contents of the batch rendering error file, named
1137 > by the root of the current rad input file followed by the ".err"
1138   suffix.
1139 < This file will contain the command lines executed by rad so far,
1140 < and may or may not contain additional progress reports from
1139 > This file will contain the command lines executed by rad so far,
1140 > and may or may not contain additional progress reports from
1141   rpict, depending on the initial setting of the "REPORT" variable.
1142  
1143   If no error file exists, this button will be disabled.
# Line 1131 | Line 1145 | If no error file exists, this button will be disabled.
1145   .Action.Script
1146  
1147   The dry run "Script" button runs rad with the
1148 < "-n" option so that you may see the commands that would be
1148 > "-n" option so that you may see the commands that would be
1149   executed during a batch run without actually executing them.
1150 < If a file is named in the window next to this button, the output
1150 > If a file is named in the window next to this button, the output
1151   will simply be written to that file.
1152 < If no file is named, a temporary file is created and an editor
1152 > If no file is named, a temporary file is created and an editor
1153   window is opened on it.
1154  
1155   Producing a dry run also writes the "Optfile" if one is specified
# Line 1143 | Line 1157 | on the Options screen.
1157   This may be useful for computing rendering parameters for rtrace(1)
1158   or rpiece(1).
1159  
1160 < The view or views are selected by the same menu used for
1160 > The view or views are selected by the same menu used for
1161   batch rendering.
1162 < (See the "View" topic under the current help category for more
1162 > (See the "View" topic under the current help category for more
1163   information.)
1164  
1165   .Action.Edit
1166  
1167 < The dry run "Edit" button is used to edit the named script file
1167 > The dry run "Edit" button is used to edit the named script file
1168   created by pressing the "Script" button.
1169   If no file is named, this button is ineffective.
1170  
1171   .Action.Delete
1172  
1173 < The "Delete" button removes the named script file, created by the
1173 > The "Delete" button removes the named script file, created by the
1174   "Script" button.
1175 < If no file is named, or the named file does not exist, this button has
1175 > If no file is named, or the named file does not exist, this button has
1176   no effect.
1177  
1178   .Results.Intro
1179  
1180   This button selects the trad Results screen.
1181 < This screen permits rendered pictures to be displayed,
1181 > This screen permits rendered pictures to be displayed,
1182   converted to other image formats, and printed.
1183 < Only finished pictures may be converted or printed, but
1184 < incomplete pictures (i.e. aborted renderings or renderings in
1183 > Only finished pictures may be converted or printed, but
1184 > incomplete pictures (i.e. aborted renderings or renderings in
1185   progress) may be displayed interactively.
1186  
1187   The left-hand window shows a list of completed views, and the
1188 < right-hand window shows views that have been started but not
1188 > right-hand window shows views that have been started but not
1189   finished.
1190 < Note that other views may not even be started, thus may not
1190 > Note that other views may not even be started, thus may not
1191   appear in either list.
1192 < Also, just because a view appears on the Results screen, it does
1193 < not mean that view is up-to-date with respect to the Radiance
1192 > Also, just because a view appears on the Results screen, it does
1193 > not mean that view is up-to-date with respect to the Radiance
1194   input files.
1195 < (The best way currently to tell which pictures are out-of-date
1196 < is to press the "Script" button on the Action screen and examine
1195 > (The best way currently to tell which pictures are out-of-date
1196 > is to press the "Script" button on the Action screen and examine
1197   the output.)
1198  
1199   .Results.Finished
# Line 1212 | Line 1226 | Shift-click also allows views to be added to the selec
1226  
1227   .Results.Rescan
1228  
1229 < The "Rescan" button on the Results screen is used to update the
1230 < finished and unfinished view lists, in case one or more pictures
1229 > The "Rescan" button on the Results screen is used to update the
1230 > finished and unfinished view lists, in case one or more pictures
1231   has completed since the Results screen was brought up.
1232  
1233   .Results.Delete

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines