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.1 by greg, Thu Oct 27 15:56:04 1994 UTC vs.
Revision 2.11 by greg, Thu Jul 6 12:23:37 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 110 | Line 106 | it is saved.
106   Loading a writable file always clears the "Read Only" check box.
107  
108   If an error is encountered while trying to load the file, a message
109 < will be printed in the box at the bottom and it will be necessary to
114 < load another file.
115 < (I.e. any previous information will be lost.)
109 > will be printed in the box at the bottom.
110  
111   .File.Save
112  
# Line 341 | 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 355 | 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 373 | 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 507 | 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 526 | 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 536 | 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 571 | 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 584 | 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 626 | 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 635 | 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 650 | 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 751 | Line 745 | to maintain a specific pixel aspect ratio (1 by defaul
745  
746   The default value for this variable is "512".
747  
748 + .Views.Rawsave
749 +
750 + The "Rawsave" check box determines whether or not the raw output picture
751 + from rpict will be saved.
752 + The default action (box unchecked) is to remove this file, since it
753 + takes up disk space and is not generally useful.
754 + However, if you wish to perform some special filtering function on
755 + the file, this file can be renamed instead of removed by checking this box.
756 + The final name in this case will be the same as the finished
757 + picture, except with a ".rwp" suffix.
758 +
759   .Views.Copy
760  
761   The "Copy" button in the Views screen permits those variables
# Line 763 | Line 768 | untouched.
768  
769   .Views.Revert
770  
771 < The "Revert" button is a convenient way to revert to the original
771 > The "Revert" button is a convenient way to revert to the original
772   values in the rad input file.
773   Only the variables on the Views screen will be affected, but any changes
774   to these variables since the last save will be lost.
# Line 822 | Line 827 | details.)
827  
828   .Options.Penumbras
829  
830 < The "Penumbras" setting determines whether or not Radiance will
830 > The "Penumbras" setting determines whether or not Radiance will
831   make a special effort to generate soft shadows from area light sources.
832   Since this is a potentially expensive calculation, penumbras should
833   only be switched "On" when they are really needed.
# Line 850 | Line 855 | vary according to the location and characteristics of
855  
856   .Options.AmbDelete
857  
858 < The "Delete" button next to the "Ambfile" window on the Options
858 > The "Delete" button next to the "Ambfile" window on the Options
859   screens allows you to remove the named ambient file.
860   This is usually done when a change to one or more rad variables
861   casts doubt on the accuracy of the values stored in this file.
# Line 881 | Line 886 | a given rendering has progressed.
886   Normally, progress reports and errors during batch renderings
887   are sent to the error file given by the root of the rad input
888   file name followed by the ".err" suffix.
889 < (See the "Errors" topic under the "Action" screen category.)
889 > (See the "CheckErr" topic under the "Action" screen category.)
890   If you wish these reports and errors to be directed to a different
891   file, follow the time interval by a space and a file name.
892  
893   No setting on this variable means do not report rendering progress.
894 < A zero setting means the same thing, and may be used when a
894 > A zero setting means the same thing, and may be used when a
895   separate error file is desired but progress reports are not.
896  
897   .Options.Oconv
# Line 927 | Line 932 | since rad does not have the intelligence to do it for
932  
933   The "render opts" window is used to specify additional options to
934   the rview(1) and rpict(1) rendering programs.
935 < Most of the important parameters are computed by rad, so this
935 > Most of the important parameters are computed by rad, so this
936   window is usually used to override specific parameters or to give
937   additional information, such as which materials to exclude from the
938   interreflection calculation.
# Line 980 | Line 985 | foreground.
985   The next set of buttons provides for the control of a batch
986   rendering process, taking place in the background.
987   Finally, the bottom set of buttons allows you to preview what would
988 < happen during a batch rendering, or (equivalently) make a script of
988 > happen during a batch rendering, or (equivalently) make a script of
989   UNIX commands for later execution.
990  
991   When the Action screen is first brought up, the message window
# Line 1055 | Line 1060 | unfortunately.)
1060  
1061   .Action.Rview
1062  
1063 < The "rview" button on the Action screen starts an interactive
1064 < rendering for the selected view, indicated by the menu button
1063 > The "rview" button on the Action screen starts an interactive
1064 > rendering for the selected view, indicated by the menu button
1065   just to the right.
1066 < Other views may be accessed within rview using the "L name"
1067 < command, and new views can be added with the "V name"
1066 > Other views may be accessed within rview using the "L name"
1067 > command, and new views can be added with the "V name"
1068   command.
1064 (See the rview(1) man page and the "View" topic in the current
1065 help category for more information.)
1069  
1070 < If the octree is out-of-date, it will be rebuilt before rendering
1070 > When using the "V" command to change an existing view, do not
1071 > give it an existing name because the previous view will not be overridden.
1072 > Instead, give it a new name (or no name, which will show up as
1073 > a number later), then use the Views screen to override the previous
1074 > view definition with the new one.
1075 > (See the "View" topic in the current
1076 > help category, the "Change" topic under "Views" and the rview(1)
1077 > manual page for more information.)
1078 >
1079 > If the octree is out-of-date, it will be rebuilt before rendering
1080   begins.
1081  
1082   .Action.View
1083  
1084   The Action screen contains two menus for selecting views.
1085 < The top menu, next to the "rview" button, sets the view to start
1085 > The top menu, next to the "rview" button, sets the view to start
1086   with in rview, and is selected from the current view list.
1087 < The second view menu, next to the "Start" button for batch
1087 > The second view menu, next to the "Start" button for batch
1088   rendering, selects the view or views to render in batch mode.
1089 < If the special entry "ALL" is selected, then every view in the
1089 > If the special entry "ALL" is selected, then every view in the
1090   current list will be rendered if it hasn't been already.
1091  
1092 < The batch rendering view menu also selects the view or views
1092 > The view menu next to the "rview" button will be disabled if there
1093 > is only one view to choose from.
1094 > The view menu next to the "Start" button will be disabled if there
1095 > is a batch job in progress, and thus the view cannot be changed.
1096 >
1097 > The batch rendering view menu also selects the view or views
1098   to use in producing a script during a dry run.
1099  
1100   .Action.Start
1101  
1102 < The "Start" button for batch rendering on the Action screen
1103 < initiates a rad rendering process in the background using the
1102 > The "Start" button for batch rendering on the Action screen
1103 > initiates a rad rendering process in the background using the
1104   selected view or views shown on the menu button to the right.
1105  
1106   If any of the rad variables have been changed since the
# Line 1092 | Line 1109 | your changes before starting a background process.
1109   If you discard these changes, then the batch rendering will be
1110   conducted using the previously saved values.
1111  
1112 < Once a background process is going, the "Start" button is
1113 < disabled, and rendering progress can be monitored by checking
1112 > Once a background process is going, the "Start" button is
1113 > disabled, and rendering progress can be monitored by checking
1114   the error file periodically.
1115 < (This file is named by the root of the rad input file followed by
1115 > (This file is named by the root of the rad input file followed by
1116   ".err".)
1117 < When a batch process is started or already running, this button
1118 < will be disabled.
1117 > When a batch process is started or already running, or when a
1118 > process is on another host and its status is unknown,
1119 > this button will be disabled.
1120  
1121 < The background process can be killed during this or later
1121 > The background process can be killed during this or later
1122   invocations of trad using the "Kill" button.
1123 + If the process was started on another machine and the status is unknown,
1124 + it will be necessary to run trad from the other host or remove the error
1125 + file manually before starting a background process on this machine.
1126 + This is to protect you from the great confusion that results when two
1127 + machines are working from the same project file.
1128  
1129   .Action.Kill
1130  
1131 < The batch rendering "Kill" button kills the
1131 > The batch rendering "Kill" button kills the
1132   background process started earlier with the "Start" button.
1133 < The rad process id is taken from the first line of the error file,
1133 > The rad process id is taken from the first line of the error file,
1134   and this process and all its children are killed when the
1135   button is pressed.
1136  
1137 < So long as there is an ambient file specified in the Options
1138 < screen, no data is lost by killing and restarting a batch
1137 > So long as there is an ambient file specified in the Options
1138 > screen, no data is lost by killing and restarting a batch
1139   rendering, though some new startup costs will be incurred.
1140  
1141 < The "Kill" button is disabled if no running batch process is
1142 < detected.
1141 > The "Kill" button is disabled if no running batch process is
1142 > detected on the current host machine.
1143  
1144   .Action.CheckErr
1145  
1146   Pressing the "Check errors" button
1147 < displays the contents of the batch rendering error file, named
1148 < by the root of the current rad input file followed by the ".err"
1147 > displays the contents of the batch rendering error file, named
1148 > by the root of the current rad input file followed by the ".err"
1149   suffix.
1150 < This file will contain the command lines executed by rad so far,
1151 < and may or may not contain additional progress reports from
1150 > This file will contain the command lines executed by rad so far,
1151 > and may or may not contain additional progress reports from
1152   rpict, depending on the initial setting of the "REPORT" variable.
1153  
1154   If no error file exists, this button will be disabled.
# Line 1133 | Line 1156 | If no error file exists, this button will be disabled.
1156   .Action.Script
1157  
1158   The dry run "Script" button runs rad with the
1159 < "-n" option so that you may see the commands that would be
1159 > "-n" option so that you may see the commands that would be
1160   executed during a batch run without actually executing them.
1161 < If a file is named in the window next to this button, the output
1161 > If a file is named in the window next to this button, the output
1162   will simply be written to that file.
1163 < If no file is named, a temporary file is created and an editor
1163 > If no file is named, a temporary file is created and an editor
1164   window is opened on it.
1165  
1166   Producing a dry run also writes the "Optfile" if one is specified
# Line 1145 | Line 1168 | on the Options screen.
1168   This may be useful for computing rendering parameters for rtrace(1)
1169   or rpiece(1).
1170  
1171 < The view or views are selected by the same menu used for
1171 > The view or views are selected by the same menu used for
1172   batch rendering.
1173 < (See the "View" topic under the current help category for more
1173 > (See the "View" topic under the current help category for more
1174   information.)
1175  
1176   .Action.Edit
1177  
1178 < The dry run "Edit" button is used to edit the named script file
1178 > The dry run "Edit" button is used to edit the named script file
1179   created by pressing the "Script" button.
1180   If no file is named, this button is ineffective.
1181  
1182   .Action.Delete
1183  
1184 < The "Delete" button removes the named script file, created by the
1184 > The "Delete" button removes the named script file, created by the
1185   "Script" button.
1186 < If no file is named, or the named file does not exist, this button has
1186 > If no file is named, or the named file does not exist, this button has
1187   no effect.
1188  
1189   .Results.Intro
1190  
1191   This button selects the trad Results screen.
1192 < This screen permits rendered pictures to be displayed,
1192 > This screen permits rendered pictures to be displayed,
1193   converted to other image formats, and printed.
1194 < Only finished pictures may be converted or printed, but
1195 < incomplete pictures (i.e. aborted renderings or renderings in
1194 > Only finished pictures may be converted or printed, but
1195 > incomplete pictures (i.e. aborted renderings or renderings in
1196   progress) may be displayed interactively.
1197  
1198   The left-hand window shows a list of completed views, and the
1199 < right-hand window shows views that have been started but not
1199 > right-hand window shows views that have been started but not
1200   finished.
1201 < Note that other views may not even be started, thus may not
1201 > Note that other views may not even be started, thus may not
1202   appear in either list.
1203 < Also, just because a view appears on the Results screen, it does
1204 < not mean that view is up-to-date with respect to the Radiance
1203 > Also, just because a view appears on the Results screen, it does
1204 > not mean that view is up-to-date with respect to the Radiance
1205   input files.
1206 < (The best way currently to tell which pictures are out-of-date
1207 < is to press the "Script" button on the Action screen and examine
1206 > (The best way currently to tell which pictures are out-of-date
1207 > is to press the "Script" button on the Action screen and examine
1208   the output.)
1209  
1210   .Results.Finished
# Line 1214 | Line 1237 | Shift-click also allows views to be added to the selec
1237  
1238   .Results.Rescan
1239  
1240 < The "Rescan" button on the Results screen is used to update the
1241 < finished and unfinished view lists, in case one or more pictures
1240 > The "Rescan" button on the Results screen is used to update the
1241 > finished and unfinished view lists, in case one or more pictures
1242   has completed since the Results screen was brought up.
1243  
1244   .Results.Delete

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines