home *** CD-ROM | disk | FTP | other *** search
/ Becoming a Computer Animator / COMPANIMATE.ISO / pc / utils / povcomm / povcomm.doc < prev    next >
Encoding:
Text File  |  1994-06-14  |  16.8 KB  |  365 lines

  1. +++++++++++++++++++++ POV COMMANDER (ver 2.0) ++++++++++++++++++++++++++++++
  2.  
  3. NEW THIS VERSION :
  4.     -Major overhall! All known bugs fixed.
  5.     -New load windows to choose your files.
  6.     -Sorted Files Screen.
  7.     -Slicker, friendlier interface.
  8.     -Complete on-line help system.
  9.     -Non-crippled! All options are available and work
  10.        as in the registered version. There is only one 
  11.        shareware screen on the final exit.
  12.  
  13. This program is designed to make the use of the POV raytracing program
  14. easier. The documentation assumes that you have a basic knowledge of
  15. how either POV 1.0 or 2.0 works. POV Commander also allows you to assign
  16. other programs, 3D modellers, and ray-tracing utilities to User Configurable
  17. buttons - and the ability to run all of these and POV with a click of the 
  18. mouse. There is even a built in on-screen file manager with a drag-and-drop
  19. style interface to make assigning of directories, files and user 
  20. configurable buttons quick and easy! Advanced options include the ability
  21. to edit your POV text files, multiple traces of different POV files with 
  22. one click of the mouse, the ability to save your favorite library paths,and a 
  23. view include file option that allows you to see which files are being included in
  24. a graphical display. All POV options are assignable as easy as clicking your mouse!
  25.  
  26.  
  27. REQUIREMENTS : DOS 5.0 , and Microsoft compatible mouse.
  28.              (And the POV Raytracing program, of course!)
  29.  
  30. THIS PROGRAM IS SHAREWARE. YOU MAY USE THIS PROGRAM FOR A TRIAL PERIOD
  31. OF 30 DAYS, AFTER WHICH TIME YOU MUST REGISTER IT IF YOU INTEND TO 
  32. CONTINUE USING IT. BY REGISTERING THIS PROGRAM, YOU WILL RECEIVE YOUR
  33. REGISTERED NAME AND PASSWORD THAT WILL CLEAR THE SHAREWARE SCREEN. YOU 
  34. WILL ALSO BE GIVEN FUTURE UPGRADES OF VERSIONS 2.0 OF THE PROGRAM FREE. 
  35. SEE "ORDER.DOC" FOR ORDERING INFORMATION. THE PRICE IS $10. 
  36. THIS  PROGRAM IS A full WORKING COPY - WITH ONLY A SHAREWARE WARNING ON
  37. THE FINAL EXIT OF THE PROGRAM.
  38.  
  39. THE AUTHOR RESERVES ALL RIGHTS TO THIS PROGRAM. THE AUTHOR DOES NOT
  40. WARRANT THIS PROGRAM'S FITNESS OR SUITABILITY FOR ANY PURPOSE. ALL 
  41. USERS SHOULD USE IT AT THEIR OWN RISK. THE ONLY THING THAT IS GUARANTEED
  42. IS THAT IT WILL TAKE UP A LITTLE HARD DRIVE SPACE.
  43.  
  44. The author will make a reasonable effort to correct problems and software
  45. bugs relating to documented features of the program for registered users.
  46. The author intends to make continuing improvements to the program. To this 
  47. end, comments and suggestions are welcomed. (Even from non-registered users.)
  48.  
  49. Users may contact the author, Matthew O. Alvey on America Online under
  50. user name NIHIL777, or in writing at:
  51.  
  52.         3436 Kendale Dr.
  53.         Ft. Wayne, IN. 46835
  54.  
  55. or over Internet at address:  NIHIL777@AOL.COM
  56.  
  57. *************************************************************************
  58. 1.0     THE POV COMMANDER ENVIRONMENT
  59.  
  60. **IMPORTANT!!** The first time you start POV COMMANDER change to the directory 
  61. that contains POV COMMANDER and type "START". Otherwise the program
  62. will not function properly. Always use 'START' each time you run the program.
  63. You must also know in advance where the POV raytracing program is on your 
  64. hard drive.
  65.  
  66. The POV Commander environment is based on a point-and-click concept.
  67. It is completely mouse driven. All options are chosen by left clicking on them. 
  68. Some items are even assigned by clicking and dragging, so that there is a minimal 
  69. amount of keyboard use. 
  70.  
  71. The left side of the screen is devoted to the File Commander. This lets
  72. you browse through your drives and find files with the ease of the mouse.
  73. From here you will drag-and-drop the files and directories you want, as
  74. well as assign your user configurable buttons. 
  75. At the bottom of the file window are eight buttons that allow you to 
  76. save, load, run POV ect.
  77. There is also a file mask selector, accessed by clicking on the line that
  78. displays the current directory.
  79.  
  80. The right half of the screen contains all of your POV options. These are
  81. all set with the click of the mouse. The bottom right half of the screen
  82. contains more large buttons to view the include chain, trace multiple POV
  83. files, and four other buttons which you can assign to run any other
  84. programs you want (3d modellers, ect.).
  85.  
  86. There is a menu bar at the top of the screen, and a status line bar at the
  87. bottom of the screen. Keep an eye on the Status bar, as it will let you
  88. know what you can do in any given situation.
  89.  
  90. 1.1  DEF Files
  91.  
  92. POV Commander works with .DEF files. These files contain all of the
  93. POV options that you set - anti-aliasing values, include directories, ect.
  94. This is the file that POV will use to trace your picture. All your work
  95. will be saved in a file with an extension of .DEF. POV COMMANDER 
  96. automatically loads the last .DEF file you used in your last POV COMMANDER
  97. session.
  98.  
  99. **************************************************************************
  100. 2.0     THE MENUS
  101. **************************************************************************
  102.  
  103. 2.1  The FILE menu.
  104.  
  105. NEW     The new option resets all of the POV options to their defaults,
  106.         if you were previously working on a file, you are first asked
  107.         if you want to save it.
  108.  
  109. LOAD    This option brings up a screen from which you may choose the
  110.     desired DEF file. See the File Commander section for another 
  111.     way of loading DEF files. This option is only here for menu-heads.
  112.  
  113. SAVE    This option will save the currently loaded DEF file to the POV
  114.         directory. This is where it needs to be for POV to use it.
  115.  
  116. SAVE AS This allows you to save the current DEF file under a new name.
  117.  
  118. EXIT    This option allows you to exit the POV COMMANDER back to DOS.
  119.  
  120. LAST 5 DEF FILES WORKED ON.
  121.         Under the EXIT option will be listed the last 5 DEF files that
  122.         you have worked on. This is a quick-load option for files that
  123.         you work on often. Just click on the name and the file will be
  124.         loaded!
  125.  
  126.  
  127. 2.2 The OPTIONS menu
  128.  
  129. RUN POV This option saves your current DEF file if it needs saving and
  130.         runs POV using that file as its definition. When POV is finished
  131.         you will return to the COMMANDER.
  132.  
  133. EDIT    This allows you to see your POV file as text and edit it. 
  134.     Files other than your currently selected .POV file may be viewed
  135.     by double-clicking on them in the File Commander window.
  136.         **REGISTERED VERSION ONLY**
  137.  
  138. VIEW INCLUDE CHAIN  This allows you to view graphically the other files    
  139.         that are being included in your POV file. Any files that cannot
  140.     be found in the paths listed in your Library Paths are marked
  141.     as such.
  142.     This option is usefull in order to see if you have included all
  143.     of the necessary library paths that POV will need.
  144.  
  145. BATCH RUNNER  This brings up a window which allows you to trace more than     
  146.         one POV file at a time in succession. While this window is up, the
  147.     File Commander is still active, so that you can drag and drop up
  148.     to 50 .DEF files to be traced in a row. If you don't like the order
  149.     that you have put the .DEF files in, just drag and drop the out of 
  150.     place files to whichever of the 50 positions you want it to be at. 
  151.     Unwanted files can be deleted by double-clicking on them. To start
  152.     completely fresh, hit the clear button. When you are ready to trace
  153.     all of the .DEF files you have listed, hit the RUN POV button. Be
  154.     sure that you have the 'Abort with a keypress' option turned on for
  155.     each of those .DEF files, otherwise you will be tracing pictures for
  156.     a long time with no way to abort them! (Except mabey ctrl-C, I haven't 
  157.     tried.)
  158.     You can also now load and save your Batch files.
  159.  
  160. HEIGHT & WIDTH  This pop-up window contains many height and width values  
  161.         that you may choose by clicking on them with the left mouse
  162.         button. If you have an odd size that you use frequently, you can
  163.         enter up to three of these, by clicking in the box and entering
  164.         your custom height and width values. The change start and end values
  165.     checkbox will automatically update the start row, start column, ect.
  166.     values after you hit O.K., if you have these items turned on. 
  167.  
  168. PALLET TYPE  This allows you to choose the appropriate pallet type for your 
  169.         video card.
  170.  
  171. BUFFER SIZE  This allows you to enter how you want POV to write its image file 
  172.     to disk. You can set it to write after each line is rendered, or set it 
  173.     to write after so many Kilobytes. As with many of these options, see
  174.     the POV documentation.
  175.  
  176. OUTPUT FILE NAME  This allows you to choose what file format POV uses
  177.         when writing image files to disk.
  178.  
  179. OUTPUT FILE PATH  This is where you can choose one of the default paths for
  180.         you output picture.  You can also assign an output file path by dragging 
  181.     one from the file window and dropping it in the file output path display 
  182.     box, right below your output file name on the main screen. 
  183.  
  184. NUMBER OF SYMBOLS  This allows you to change the number of symbols value
  185.         that POV uses when reading POV files. Large POV files may need a high
  186.         value here. See POV Documentation.
  187.  
  188. CHANGE POV VERSION  This option toggles the screen between options from
  189.         POV version 1.0 and 2.0.  The options from ver. 2.0 that aren't 
  190.         available in 1.0 will be grayed out.
  191.  
  192. VIEW LAST OUTPUT  This option will flip you back to dos to see what happened with
  193.         POV, if there was an error.  When you are finished, hit a key to return.
  194.  
  195.  
  196. 2.3 The CONFIG Menu
  197.  
  198. PROGRAM LOCATIONS  This brings up a window that allows you to enter or
  199.         change the locations you have assigned for POVRAY.EXE and 
  200.         POVCOMM.EXE. 
  201.  
  202. SAVE CONFIGURATION  This allows you to save any changes you have made
  203.         to the POV COMMANDER configuration, which includes: custom heights,
  204.         program locations, user configurable buttons, custom colors, all the
  205.     files you have assigned in the batch runner, and the POV version you
  206.     are using. You will be prompted before exiting the program if the config
  207.     needs saving
  208.  
  209. POV VERSION  This allows you to set up POV Commander to use the appropriate    
  210.     version of POV. Choose 1.0 if you are using POV version 1.0, and 2.0
  211.     for POV version 2.0. This option is automatically set to 2.0, unless
  212.     you change it at some point.
  213.  
  214. SAVE LIBRARY PATHS  This option allows you to save you current library paths  
  215.     in a file for quick loading later. All files are saved with a *.PTH
  216.     in the same directory where POV Commander is. You can click on O.K.
  217.     to save under the current *.PTH name listed, or enter a new name.
  218.  
  219. LOAD LIBRARY PATHS  This option brings up a window from which you can
  220.     select a previously saved set of library paths.
  221.  
  222. AUTO SAVE ON/OFF  This turns the auto save function on/off. If you get tired
  223.     of answereing all of those "changes made, Save?" messages, turn
  224.     this on.
  225.         
  226.  
  227.  
  228. **************************************************************************
  229. 3.0  THE FILE COMMANDER
  230.  
  231. 3.1 Changing directories and drives                        
  232.  
  233. All files and directories are displayed within the File Commander Window.
  234. Directories are shown enclosed in <> signs. To change to that directory
  235. DOUBLE CLICK on the directory name. The symbol <.\> will take you back to 
  236. the root of the current drive, and <..\> will take you back one directory 
  237. in the current drive. These symbols will always be the first two listed in 
  238. the File Commander window. (Unless you are in the root drive.
  239. To change to a new drive, simply click on the drive letter, A:, B:, ect.,
  240. located at the top of the file commander.
  241.  
  242. To change which files are seen, click on the bar near the top of the File
  243. Commander that contains the path name. A popup window will appear that will
  244. allow you to choose a pre-defined file mask, or to enter one of your own.
  245. You may use any normal DOS wildcards. i.e. if you enter *.INC, only files
  246. with a .INC extion will be shown from then on in the File Commander window.
  247.  
  248. To highlight a file, click on it with the left mouse button. To load a 
  249. DEF file, click and hold it until the cursor changes to a hand. Drag it
  250. down to the bottom left hand corner of the status bar and release it on
  251. top of the old DEF file name displayed there. This is the quick way to 
  252. load a DEF file.
  253. The same method is used when assigning directories to library paths and
  254. assigning programs to the user configurable buttons. (see later)
  255.  
  256. You can also edit any file in the File Window by double clicking on it.
  257.  
  258. The Buttons across the bottom of the file commander work much the same
  259. as their menu counterparts. 
  260.  
  261. **************************************************************************
  262. 4.0 POV OPTIONS AND USER BUTTONS - right half of screen
  263.  
  264. 4.1 POV OPTIONS
  265.  
  266. POV VERSION this area shows which version of POV the commander is set up for.
  267.         See menu section.
  268.  
  269. HEIGHT  Click here to enter a new height value.
  270. WIDTH   Click here to enter a new width value.
  271.  
  272. DISPLAY TYPE  Click the checkbox to see the picture as it is being
  273.         rendered, and click within the display box to choose your
  274.         display card from the list presented.
  275. STATISTIC DISPLAY  Click this checkbox if you wish to see only the
  276.         statistics of your picture as it is being rendered.
  277.  
  278. ABORT WITH KEYPRESS  Allows you to abort the rendering image at any time.
  279.     (You might as well keep this turned on at all times, especially if
  280.     you are doing many POV files at once. Its the only easy way to get
  281.     out of a render, once its started!)
  282.  
  283. CONTINUE ABORTED IMAGE  Allows you to continue an aborted render.
  284.  
  285. PAUSE AFTER TRACE  This will pause POV after it is finished tracing a
  286.         picture to allow you to see it until a key is pressed.
  287.  
  288. CLOCK VALUE  Click the check box and enter the clock value for the
  289.         current trace when doing animation scenes.
  290.  
  291. INPUT FILE NAME  This box displays the POV file name that will be traced.
  292.         To assign a file to this box, just find it in the File Commander
  293.         window, click and drag it to the Input File Name Box. Drag and
  294.         drop - its that simple!
  295.  
  296. OUTPUT FILE NAME  Click the checkbox if you want your image saved to a
  297.         file, and enter a file name in the box.
  298.  
  299. OUTPUT FILE PATH  Drag a directory from the file window to assign a path
  300.         here, or click in this box to bring up a window where you can choose
  301.         various default paths.
  302.  
  303. RENDER QUALITY  This allows you to choose the quality of render you want.
  304.         Valid values are from 1 to 9.
  305.  
  306. ANTI-ALIASING  Click the checkbox and enter the values for these options
  307. NUMBER OF RAYS  if desired.
  308. JITTER
  309.  
  310. BOUNDING SLABS  Enter the minimum number of objects needed before boundings
  311.         are used.
  312.  
  313. START LINE  These values are used for tracing only a portion of the image.
  314. END LINE
  315.    or
  316. START ROW
  317. END ROW
  318. START COLUMN
  319. END COLUMN
  320.  
  321. LIBRARY PATHS  These are assigned by dragging and dropping the desired 
  322.         path names from the File Commander to any on of the Library Path
  323.         positions. You may delete an undesired library path by double 
  324.     clicking on it.
  325.  
  326. VIEW INCLUDE CHAIN BUTTON See section 2.2.
  327.  
  328. POV BATCH RUNNER See section 2.2.
  329.  
  330. USER CONFIGURABLE BUTTONS  These buttons can be assigned to run any program     
  331.         on your hard drive. Simply find the program you want to run in
  332.         the file commander, and drag it with the mouse to one of the
  333.         user configurable buttons, and release your mouse button. A window 
  334.     will appear that will allow you to enter a title for the button, and any 
  335.     command line parameters that the program may need. If you include the 
  336.     symbol @POV anywhere in the command line box, the current POV file name
  337.     that is on-screen will be substituted whenever you run this program. This
  338.     is useful for POV utilities that require a POV file in its command line
  339.     arguments.
  340.     These buttons can be edited at any time by double clicking on them. The 
  341.     Clear option in the displayed window will erase whatever you have assigned 
  342.     to that button.
  343.         These buttons are useful for running 3D Modellers and the like
  344.         directly from POV Commander. Once a button is assigned and given a new title,
  345.     just click on it, and the program will be run. When the program is finished 
  346.     running, you will be returned to POV Commander!
  347.     **NOTE** Any time that POV Commander runs another program or runs POV itself,
  348.     no memory is used, because instead of using a TSR to track those programs, POV
  349.     Commander uses recursive batch files. That is why it is important to start
  350.     POV Commander with 'START.BAT'.
  351.  
  352.  
  353. Special Thanx to BETA testers Chris Dhoerman, Jim Babcock, and Timothy Bearmen!
  354.  
  355. Compiled with Borland C++ 4.0.
  356.  
  357. A SETI PRODUCTION.
  358. THELEMA - AGAPE - 93!
  359.  
  360. note: the view TGA option was not included in this version due to technical 
  361.       difficulties (i.e. I can't get the true color image to dither to 256 
  362.       colors correctly!). Hopefully I will have it in a new version soon.
  363.       Thanx for all your support!
  364.  
  365.