| 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 |
|
|
| 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 |
| 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. |
| 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 |
|
|
| 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. |
| 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 |
|
|
| 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 |
| 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. |
| 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 |
| 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. |
| 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 |
| 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 |
| 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. |
| 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. |
| 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 |
|
|
| 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. |
| 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. |
| 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. |
| 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 |
| 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. |
| 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 |
| 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. |
| 1058 |
< |
(See the rview(1) man page and the "View" topic in the current |
| 1058 |
> |
|
| 1059 |
> |
When using the "V" command to change an existing view, do not |
| 1060 |
> |
give it a 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 rview(1) man page and the "View" topic in the current |
| 1065 |
|
help category for more information.) |
| 1066 |
|
|
| 1067 |
< |
If the octree is out-of-date, it will be rebuilt before rendering |
| 1067 |
> |
If the octree is out-of-date, it will be rebuilt before rendering |
| 1068 |
|
begins. |
| 1069 |
|
|
| 1070 |
|
.Action.View |
| 1071 |
|
|
| 1072 |
|
The Action screen contains two menus for selecting views. |
| 1073 |
< |
The top menu, next to the "rview" button, sets the view to start |
| 1073 |
> |
The top menu, next to the "rview" button, sets the view to start |
| 1074 |
|
with in rview, and is selected from the current view list. |
| 1075 |
< |
The second view menu, next to the "Start" button for batch |
| 1075 |
> |
The second view menu, next to the "Start" button for batch |
| 1076 |
|
rendering, selects the view or views to render in batch mode. |
| 1077 |
< |
If the special entry "ALL" is selected, then every view in the |
| 1077 |
> |
If the special entry "ALL" is selected, then every view in the |
| 1078 |
|
current list will be rendered if it hasn't been already. |
| 1079 |
|
|
| 1080 |
< |
The batch rendering view menu also selects the view or views |
| 1080 |
> |
The view menu next to the "rview" button will be disabled if there |
| 1081 |
> |
is only one view to choose from. |
| 1082 |
> |
The view menu next to the "Start" button will be disabled if there |
| 1083 |
> |
is a batch job in progress, and thus the view cannot be changed. |
| 1084 |
> |
|
| 1085 |
> |
The batch rendering view menu also selects the view or views |
| 1086 |
|
to use in producing a script during a dry run. |
| 1087 |
|
|
| 1088 |
|
.Action.Start |
| 1089 |
|
|
| 1090 |
< |
The "Start" button for batch rendering on the Action screen |
| 1091 |
< |
initiates a rad rendering process in the background using the |
| 1090 |
> |
The "Start" button for batch rendering on the Action screen |
| 1091 |
> |
initiates a rad rendering process in the background using the |
| 1092 |
|
selected view or views shown on the menu button to the right. |
| 1093 |
|
|
| 1094 |
|
If any of the rad variables have been changed since the |
| 1097 |
|
If you discard these changes, then the batch rendering will be |
| 1098 |
|
conducted using the previously saved values. |
| 1099 |
|
|
| 1100 |
< |
Once a background process is going, the "Start" button is |
| 1101 |
< |
disabled, and rendering progress can be monitored by checking |
| 1100 |
> |
Once a background process is going, the "Start" button is |
| 1101 |
> |
disabled, and rendering progress can be monitored by checking |
| 1102 |
|
the error file periodically. |
| 1103 |
< |
(This file is named by the root of the rad input file followed by |
| 1103 |
> |
(This file is named by the root of the rad input file followed by |
| 1104 |
|
".err".) |
| 1105 |
< |
When a batch process is started or already running, this button |
| 1106 |
< |
will be disabled. |
| 1105 |
> |
When a batch process is started or already running, or when a |
| 1106 |
> |
process is on another host and its status is unknown, |
| 1107 |
> |
this button will be disabled. |
| 1108 |
|
|
| 1109 |
< |
The background process can be killed during this or later |
| 1109 |
> |
The background process can be killed during this or later |
| 1110 |
|
invocations of trad using the "Kill" button. |
| 1111 |
+ |
If the process was started on another machine and the status is unknown, |
| 1112 |
+ |
it will be necessary to run trad from the other host or remove the error |
| 1113 |
+ |
file manually before starting a background process on this machine. |
| 1114 |
+ |
This is to protect you from the great confusion that results when two |
| 1115 |
+ |
machines are working from the same project file. |
| 1116 |
|
|
| 1117 |
|
.Action.Kill |
| 1118 |
|
|
| 1119 |
< |
The batch rendering "Kill" button kills the |
| 1119 |
> |
The batch rendering "Kill" button kills the |
| 1120 |
|
background process started earlier with the "Start" button. |
| 1121 |
< |
The rad process id is taken from the first line of the error file, |
| 1121 |
> |
The rad process id is taken from the first line of the error file, |
| 1122 |
|
and this process and all its children are killed when the |
| 1123 |
|
button is pressed. |
| 1124 |
|
|
| 1125 |
< |
So long as there is an ambient file specified in the Options |
| 1126 |
< |
screen, no data is lost by killing and restarting a batch |
| 1125 |
> |
So long as there is an ambient file specified in the Options |
| 1126 |
> |
screen, no data is lost by killing and restarting a batch |
| 1127 |
|
rendering, though some new startup costs will be incurred. |
| 1128 |
|
|
| 1129 |
< |
The "Kill" button is disabled if no running batch process is |
| 1130 |
< |
detected. |
| 1129 |
> |
The "Kill" button is disabled if no running batch process is |
| 1130 |
> |
detected on the current host machine. |
| 1131 |
|
|
| 1132 |
|
.Action.CheckErr |
| 1133 |
|
|
| 1134 |
|
Pressing the "Check errors" button |
| 1135 |
< |
displays the contents of the batch rendering error file, named |
| 1136 |
< |
by the root of the current rad input file followed by the ".err" |
| 1135 |
> |
displays the contents of the batch rendering error file, named |
| 1136 |
> |
by the root of the current rad input file followed by the ".err" |
| 1137 |
|
suffix. |
| 1138 |
< |
This file will contain the command lines executed by rad so far, |
| 1139 |
< |
and may or may not contain additional progress reports from |
| 1138 |
> |
This file will contain the command lines executed by rad so far, |
| 1139 |
> |
and may or may not contain additional progress reports from |
| 1140 |
|
rpict, depending on the initial setting of the "REPORT" variable. |
| 1141 |
|
|
| 1142 |
|
If no error file exists, this button will be disabled. |
| 1144 |
|
.Action.Script |
| 1145 |
|
|
| 1146 |
|
The dry run "Script" button runs rad with the |
| 1147 |
< |
"-n" option so that you may see the commands that would be |
| 1147 |
> |
"-n" option so that you may see the commands that would be |
| 1148 |
|
executed during a batch run without actually executing them. |
| 1149 |
< |
If a file is named in the window next to this button, the output |
| 1149 |
> |
If a file is named in the window next to this button, the output |
| 1150 |
|
will simply be written to that file. |
| 1151 |
< |
If no file is named, a temporary file is created and an editor |
| 1151 |
> |
If no file is named, a temporary file is created and an editor |
| 1152 |
|
window is opened on it. |
| 1153 |
|
|
| 1154 |
|
Producing a dry run also writes the "Optfile" if one is specified |
| 1156 |
|
This may be useful for computing rendering parameters for rtrace(1) |
| 1157 |
|
or rpiece(1). |
| 1158 |
|
|
| 1159 |
< |
The view or views are selected by the same menu used for |
| 1159 |
> |
The view or views are selected by the same menu used for |
| 1160 |
|
batch rendering. |
| 1161 |
< |
(See the "View" topic under the current help category for more |
| 1161 |
> |
(See the "View" topic under the current help category for more |
| 1162 |
|
information.) |
| 1163 |
|
|
| 1164 |
|
.Action.Edit |
| 1165 |
|
|
| 1166 |
< |
The dry run "Edit" button is used to edit the named script file |
| 1166 |
> |
The dry run "Edit" button is used to edit the named script file |
| 1167 |
|
created by pressing the "Script" button. |
| 1168 |
|
If no file is named, this button is ineffective. |
| 1169 |
|
|
| 1170 |
|
.Action.Delete |
| 1171 |
|
|
| 1172 |
< |
The "Delete" button removes the named script file, created by the |
| 1172 |
> |
The "Delete" button removes the named script file, created by the |
| 1173 |
|
"Script" button. |
| 1174 |
< |
If no file is named, or the named file does not exist, this button has |
| 1174 |
> |
If no file is named, or the named file does not exist, this button has |
| 1175 |
|
no effect. |
| 1176 |
|
|
| 1177 |
|
.Results.Intro |
| 1178 |
|
|
| 1179 |
|
This button selects the trad Results screen. |
| 1180 |
< |
This screen permits rendered pictures to be displayed, |
| 1180 |
> |
This screen permits rendered pictures to be displayed, |
| 1181 |
|
converted to other image formats, and printed. |
| 1182 |
< |
Only finished pictures may be converted or printed, but |
| 1183 |
< |
incomplete pictures (i.e. aborted renderings or renderings in |
| 1182 |
> |
Only finished pictures may be converted or printed, but |
| 1183 |
> |
incomplete pictures (i.e. aborted renderings or renderings in |
| 1184 |
|
progress) may be displayed interactively. |
| 1185 |
|
|
| 1186 |
|
The left-hand window shows a list of completed views, and the |
| 1187 |
< |
right-hand window shows views that have been started but not |
| 1187 |
> |
right-hand window shows views that have been started but not |
| 1188 |
|
finished. |
| 1189 |
< |
Note that other views may not even be started, thus may not |
| 1189 |
> |
Note that other views may not even be started, thus may not |
| 1190 |
|
appear in either list. |
| 1191 |
< |
Also, just because a view appears on the Results screen, it does |
| 1192 |
< |
not mean that view is up-to-date with respect to the Radiance |
| 1191 |
> |
Also, just because a view appears on the Results screen, it does |
| 1192 |
> |
not mean that view is up-to-date with respect to the Radiance |
| 1193 |
|
input files. |
| 1194 |
< |
(The best way currently to tell which pictures are out-of-date |
| 1195 |
< |
is to press the "Script" button on the Action screen and examine |
| 1194 |
> |
(The best way currently to tell which pictures are out-of-date |
| 1195 |
> |
is to press the "Script" button on the Action screen and examine |
| 1196 |
|
the output.) |
| 1197 |
|
|
| 1198 |
|
.Results.Finished |
| 1225 |
|
|
| 1226 |
|
.Results.Rescan |
| 1227 |
|
|
| 1228 |
< |
The "Rescan" button on the Results screen is used to update the |
| 1229 |
< |
finished and unfinished view lists, in case one or more pictures |
| 1228 |
> |
The "Rescan" button on the Results screen is used to update the |
| 1229 |
> |
finished and unfinished view lists, in case one or more pictures |
| 1230 |
|
has completed since the Results screen was brought up. |
| 1231 |
|
|
| 1232 |
|
.Results.Delete |
