home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / povray3a / Docs / RISCOS < prev   
Text File  |  1996-08-17  |  7KB  |  168 lines
  1. Persistence of Vision Ray Tracer V3.00
  2. Copyright POV-Team (see Docs.POVLegal for details)
  3. RISC OS port V0.03 (14th August 1996)
  4.  
  5.  This is a RISC OS port of The Persistence of Vision(tm) Ray Tracer v3.00a.
  6. It was compiled using the Unix text only version of the source code.
  7.  
  8.  This document assumes that the user is familiar with RISC OS terminology.
  9. It is designed to explain the changes that were necessary to POV-Ray so that
  10. it could be used under RISC OS. The rest of the documentation contained in
  11. this package is the original. Any references in that documentation to
  12. platform specific information should be ignored unless the RISC OS equivalent
  13. is given here.
  14.  
  15. Output file type
  16. ----------------
  17.  24bit colour Targa files are the standard output file type and can be viewed
  18. using ChangeFSI. If your intention is to create FLC/FLI animations using
  19. ppm2fli, then you should ensure that the output file type is PPM (option
  20. +FP).
  21.  
  22. Filenames
  23. ---------
  24.  In this RISC OS version, filenames containing MS-DOS style extensions are
  25. converted so that the extension becomes a directory name. For example, a
  26. scene file called atmos1.pov will become pov.atmos1. If the same file is
  27. referred to as pov.atmos1 then no conversion takes place. POV-Ray will then
  28. look for the scene named atmos1 in the directory called pov. The following
  29. extensions are common and therefore should exist as directories, where
  30. necessary, for the scenes you wish to trace:-
  31.  
  32.  pov - contains scene description files
  33.  ini - contains option files
  34.  tga - output directory for targa files
  35.  png - output directory for Portable Network Graphics files
  36.  gif - input directory for gif files (not output)
  37.  inc - contains include files
  38.  
  39. The standard include directory contains most of these and a few more.
  40. Unfortunately, due to the fact that the directory separator character is now
  41. the same as the MSDOS extension separator there is a small restriction on
  42. filenames. POV-Ray assumes that any filename that is three characters or less
  43. in length is an extension, therefor it is wise to ensure that all scene names
  44. are longer than this.
  45.  
  46. Before attempting to run POV-Ray
  47. --------------------------------
  48. • you should double-click on the obey file called !SetPaths to initialise a
  49.   number of system variables. This performs the following actions:-
  50.   
  51.   • it sets up a path variable that can be used to reference any special
  52.     files with minimal typing, for example, POV:Res800.ini. This is
  53.     unlikely to be required, but is provided just in case.
  54.     
  55.   • it adds the directory containing POV-Ray to your run path so that POV-Ray
  56.     can be run from within any work directory without specifiying it's full
  57.     pathname.
  58.     
  59.   • Lastly, a special system variable called POV$ini is optionally set that
  60.     contains the name of an .ini file that will be read in by POV-Ray on
  61.     startup. If this is not required, then the line can be commented out by
  62.     prefixing it with a | after which the file should be double-clicked again
  63.     to make the change occur.
  64.  
  65. • POV-Ray expects to find a directory, named after the MS-DOS extension of
  66.   the output file, within the Currently Selected Directory (CSD). For
  67.   example, for Targa files, you should make sure that there is a directory
  68.   called tga, otherwise POV-Ray will stop with the message 'Error opening
  69.   output file - Not found'.
  70.  
  71. • You should alter any path names in povrayrc so that they correctly point to
  72.   the relevant directories on your hard disc. Any path names used in the
  73.   Library_Path option should be RISC OS style ones. If your editor supports
  74.   it (as do !Edit, !Zap and !StrongEd), path names of directories can easily
  75.   be pasted into a file by shift-dragging it to it's window where it will
  76.   be inserted at the cursor position.
  77.  
  78. • You should set the CSD to be the one that contains the input directory
  79.   (usually pov) and the output directory of the scene(s) you wish to trace,
  80.   for example,
  81.   
  82. DocsDemo (This should be set as the CSD)
  83.       |
  84.       + pov (input dir.)
  85.       |  |
  86.       |  atmos1 (scene file)
  87.       |
  88.       |
  89.       |
  90.       + tga (output dir.)
  91.          |
  92.          atmos1 (image file)
  93.    
  94.   
  95.   It is quite easy to set a directory to be the CSD from a task window by
  96.   typing into it:-
  97.   
  98.   dir<SPACE>
  99.   
  100.   and then shift dragging the directory into the task window where it's full
  101.   path name will be added to the command. Pressing RETURN will then execute
  102.   the command.
  103.   It is possible to supply path names of scenes to trace such as:-
  104.   
  105.   ADFS::HardDisc4.$.Graphics.DocsDemo.pov.atmos1
  106.   
  107.   or
  108.   
  109.   if the CSD is the Graphics directory then:-
  110.   
  111.   DocsDemo.pov.atmos1
  112.   
  113.   but in these cases you must also supply the output filename as well,
  114.   because POV-Ray will strip the path name from the input filename completely
  115.   and construct an output filename from what's left. This means that it will
  116.   attempt to write the file to:-
  117.  
  118.   tga.atmos1 instead of DocsDemo.tga.atmos1 (assuming Targa file output).
  119.   Explicitly specifying an output filename using the +O switch will override
  120.   this effect.
  121.  
  122. Examples
  123. --------
  124. From within a task window:-
  125.  
  126.  *dir ADFS::HardDisc4.$.ProgDev.povray3.DocsDemo
  127.  *povray +IAtmos1
  128.  
  129. This will create a Targa image of the scene named pov.atmos1 where the
  130. directory pov exists in the CSD. The image will be stored as tga.atmos1 where
  131. the directory tga also exists in the CSD.
  132.  
  133.  *dir ADFS::HardDisc4.$.ProgDev.povray3.POV3Demo.Anim.Ambient
  134.  *povray Ambient
  135.  
  136. This will read in the .ini file named ini.Ambient (from the CSD) and ray
  137. trace ten frames of animation. The input file name is taken from the .ini
  138. file and the output filenames are generated automatically. Each is numbered
  139. so that it is different from the last.
  140.   
  141. Start up options
  142. ----------------
  143.  At startup, the system variable POV$ini (POVINI in the original
  144. documentation) is read to find a default .ini file from which many POV-Ray
  145. options can be set. An error will be generated if the file given (if
  146. any) cannot be found. Alternatively, the file povrayrc, in the same directory
  147. as POV-Ray, is searched for and it's contents used as the default settings.
  148. If povrayrc is not found then the file povray.ini from the current directory
  149. is used. If this does not exist then no error is given and POV-Ray uses it's
  150. own set of defaults.
  151.  
  152. Bug reports
  153. -----------
  154.  Any bugs can be reported to me at the Email address below, but please note
  155. that if the bug is in a complicated, 3D raytracing type algorithm from the
  156. original source code then I may not be able to understand it, never mind fix
  157. it :-), but I'll try (such bug reports should be directed to the POV-Team
  158. anyway).
  159.  
  160. Acknowledgment
  161. ----------------
  162. Thanks to:
  163. The POV-Ray Team for making the source code so portable.
  164. Rosemary Miskin for testing this RISC OS port.
  165.  
  166. Lee Noar
  167. <leenoar@argonet.co.uk>
  168.