home *** CD-ROM | disk | FTP | other *** search
/ Really Useful CD 1 / ReallyUsefulCD1.iso / extras / graphics / fractrace / _fractrace / _help < prev    next >
Encoding:
Text File  |  1990-07-05  |  10.1 KB  |  197 lines
  1. Document with FracTrace.
  2. ------------------------
  3.  
  4. FracTrace is a Public Domain program. It may be copied and shared freely, as
  5. long as the files that go with the program are not modified. The program may
  6. not be sold or made commercial profit of in any way, with the exception of
  7. Archive's 'CareWare'!
  8. The images created with FracTrace may be used in whatever way though!
  9.  
  10.  
  11. What is FracTrace?
  12.  
  13. FracTrace is yet another program to display fractal sets (Mandelbrot and 
  14. Julia of z=z^2+c, currently). It does this by means of simple raytracing;
  15. raycasting would be a better term though! The fractal set is rendered as a
  16. continuous height field (a 'surface', in normal English) which is lit by a 
  17. light-source with parallel beams.
  18. For each point on the height field the program calculates the intensity, 
  19. depending on the angle of the incident light-ray with the surface normal in
  20. that point. An option in the program allows for additional shadow 
  21. calculations as well!
  22. The program is fully RISC OS compatible and will perform most of its 
  23. processes in the background.
  24.  
  25.  
  26. The logic of FracTrace:
  27.  
  28. The different parameters needed to specify the surface's characteristics
  29. are set using a script language: "FTS" (which stands for FracTrace Script).
  30. The commands of this script can be used to exactly define what the program
  31. should output.
  32. The program also allows the user to calculate a potential map (a 2D-array
  33. which holds the potential for each point on the surface), which can be
  34. used, saved and reloaded, when rendering the 3D-image of the surface.
  35. Using this map will speed up the program by a certain factor. It is more
  36. memory-consuming though!
  37. When the rendering process is finished, the image can be saved as a 
  38. standard mode 12 sprite.
  39.  
  40.  
  41. How to use FracTrace?
  42.  
  43. FracTrace (version 2.00 and above) runs completely from the RISC OS desktop.
  44. Double-clicking on its icon in a filer-window starts the program... After a
  45. succesful load, the program installs itself on the iconbar.
  46.  
  47. Clicking with Select (left-button) on the icon causes the 'report window' to
  48. be opened: via this window, the program informs the user on what it's doing!
  49.  
  50. Clicking with Adjust (right-button) on the icon causes the 'view window' to
  51. be opened: this window shows the image that is rendered.
  52.  
  53. Clicking with Menu (middle-button) on the icon brings up the icon menu, which
  54. allows the user to see the program info ('About this program'...) and to quit
  55. the program when you wish to do so!
  56.  
  57. Clicking Menu over one of the windows ('report','view' and 'panel') provided
  58. by FracTrace brings up the 'Main FracTrace Menu': this menu gives you the 
  59. actual control over the program, its items are described below...
  60.  
  61. Title      : Choosing this item allows you to enter a title-name for the 
  62.              current image and its control parameters. Don't use more than
  63.              8 characters!
  64.  
  65. Misc       : The miscellaneous submenu. From this submenu you can toggle the 
  66.              'auto-parse' option (see below), toggle 'multitask' mode,
  67.              open the RISC OS directory filer of your saving directory, abort
  68.              the current process, or resume it.
  69.              Setting the 'auto-parse' option will cause FTS files to be
  70.              parsed immediately when they're dragged into the program.
  71.              When 'multitask' mode is deselected, processes such as 
  72.              calculating a potential map and raytracing take over the whole
  73.              machine, ie. they don't multitask but they're faster!
  74.              The 'open filer' option opens the filer of the directory in
  75.              which FracTrace stores its output files. Normally, when you 
  76.              want to save a file (Map, Image, or Script), you can drag the
  77.              icon in a filer, which is the 'Acorn proposed' way of saving 
  78.              files. However, when the program is rendering multiple images,
  79.              then called 'frames' (for animation sequences), each 'frame'
  80.              must be saved when rendering is finished, without the 
  81.              intervention of the user. This is done in a directory that is 
  82.              specified beforehand.
  83.              The options 'abort' and 'resume' are for aborting and resuming a
  84.              process respectively.   
  85.  
  86. Save       : From this submenu you can save your files:
  87.              Map ... Saves the current map.
  88.              Image ... Saves last rendered image.
  89.              Script ... Saves a script file containing FTS commands for the
  90.                       current parameter-settings.
  91.              Saving is done in the conventional way, ie. by dragging the icon
  92.              in a filer window.   
  93.              Savepath ... Set the saving-directory for frames (see above).
  94.                           This is also done by dragging the icon in a filer.
  95.  
  96. Process    : From this submenu you start one of the processes, being:
  97.              Parse: Starts parsing (ie. interpreting) the last loaded FTS
  98.                     file.
  99.              Raytrace: Starts rendering the surface using the parameters set
  100.                        in the last parsed FTS file.
  101.              Calculate: Starts calculating the potential map for a surface
  102.                         using the parameters of the last parsed FTS file.
  103.              Any of these processes can be aborted at any time by either:
  104.               - clicking on 'abort' in the 'report' window or icon menu. 
  105.               - clicking any mouse button when in non-'multitask' mode.
  106.              Note that only one of these processes can be active at a time.
  107.  
  108. Show       : With this submenu you can open the windows of FracTrace.
  109.              The 'view' window shows the image of the current surface. When
  110.              the program is rendering a surface, the contents of this window
  111.              are only updated between each row of points being rendered.
  112.              Clicking with select in this window causes an immediate update.
  113.              The 'panel' window shows the parameters and their current
  114.              values. The values may be changed at any time by clicking on 
  115.              the value's icon and entering a new value from the keyboard.
  116.              When you wish to update the parameters with the new values,
  117.              click on the 'OK' icon in the right-hand bottom corner of this
  118.              window, otherwise click on the 'Cancel' icon to preserve the
  119.              parameters' values. Note that clicking on the window's back-
  120.              ground has the same effect as clicking on 'OK'!
  121.              The 'report' window is used by the program to inform the user of
  122.              what it's doing. This window is constantly updated, except when
  123.              no process is active, or when a process is running with
  124.              'multitask' mode switched off.
  125.  
  126. Map        : From this submenu you can claim space for a map, with the 
  127.              'claim map' option, you can free the space for this map, with
  128.              the 'free map' option, and you can select to use the map when
  129.              rendering a surface with the 'use map' option.
  130.              The 'claim map' option tries to allocate enough space from the
  131.              free pool to hold the data of a potential map. The size of this
  132.              amount of space depends on the resolution of the surface you
  133.              want to render (which is also the resolution of the map).
  134.              When there isn't enough space left, the program will report an
  135.              error and will show the amount of free space (in Kb) required.
  136.              The user can then try to free some memory elsewhere using the
  137.              Task Manager!
  138.              The 'free map' option just frees the space allocated by 'claim
  139.              map', returning the memory to the WIMP's free pool.
  140.              The 'use map' option must be toggled on if you want the program
  141.              to use the map when it is rendering an image.
  142.              Note that when no map is claimed, all the submenu-options 
  143.              concerning the map are 'shaded', ie. they can't be selected,
  144.              because at that point, they simply are of no use! These are:
  145.              'save map', 'calculate', 'free map' and 'use map'. You will also
  146.              get an error when you want to load a map file and you haven't
  147.              claimed map space.
  148.  
  149.  
  150. It is possible to abort a process, quit FracTrace, and resume the same 
  151. process at a later date. This is done by writing down the line-number at 
  152. which you abort the process, and entering this line-number in the 'resume'
  153. option-icon in the Control Panel with your next FracTrace session. When you
  154. set this option and subsequently start the raytracing process, it will resume
  155. at the line-number you entered in the icon!
  156.  
  157. If you are rendering multiple frames and want a new potential map to be 
  158. recalculated for each different frame, you can do so by setting the
  159. 'recalculate' option in the Control Panel!
  160.  
  161. These explanations may seem 'cryptic' (and so they are!), but the best way
  162. of getting to know FracTrace is by experimenting with the demo-files,
  163. and trying to make some variations.
  164.  
  165.  
  166. How to use FTS?
  167. ---------------
  168. An FTS file is just a text (ASCII) file as can be made with !Edit.
  169. When you drag an FTS file over one of the FracTrace windows it will be
  170. loaded (provided it isn't longer than 4000 bytes), and -with the default
  171. configuration settings- will be parsed automatically. When the 'auto-parse'
  172. option is switched off, parsing can explicitly be started by selecting 
  173. 'parse' from the process submenu.
  174. An explanation of each of the commands provided by FTS is given in the
  175. file 'FTS-Def'.
  176.  
  177.  
  178. Comments of the author:
  179. -----------------------
  180. This version of FracTrace certainly isn't the last to be released. As I (or
  181. you) encounter bugs or 'ill behaviour' in the program, I will try to fix 
  182. them in future versions and provide you with the updated releases!
  183. If you find any bugs, have any comments or ideas you'd like to see 
  184. implemented, write to the address below...
  185.  
  186. Address :          Carl Declerck
  187.                    Vrijgeweidestraat 24
  188.                    B-2800 Mechelen
  189.                    Belgium
  190. Phone   :          015-41.96.49
  191.  
  192. I can also be reached at Archive BBS as: Carl Declerck (#1071).
  193. If you mail any comments, please allow about one week for a reply!
  194.  
  195.  
  196.                                                               Carl Declerck.
  197.