home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: Graphics / Graphics.zip / povpan10.zip / POVPanel.HLP (.txt) < prev    next >
OS/2 Help File  |  1994-07-21  |  99KB  |  450 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Index ΓòÉΓòÉΓòÉ
  3.  
  4. POV-Panel 1.0 Help Index 
  5.  
  6.  POV-Panel is a graphical interface for POV-Ray 2.0  This help file explains 
  7. the operation of POV-Panel.  The following topics are available: 
  8.  
  9.      Introduction 
  10.      Options Help 
  11.      Menu Help 
  12.      External Programs 
  13.      History 
  14.      Registration and Author Information 
  15.  
  16.   Tab to the topic of interest and press <Enter>, or double-click with the 
  17.  mouse. 
  18.  
  19.  
  20. ΓòÉΓòÉΓòÉ 2. Introduction ΓòÉΓòÉΓòÉ
  21.  
  22. Introduction 
  23.  
  24.  POV-Panel is intended to help anyone who is not overly fond of typing out the 
  25. thirty or so command-line arguments to the POV-Ray compiler.  I don't mean to 
  26. criticize POV-Ray here, only to note that with a product as complex as POV-Ray, 
  27. POV-Panel comes in very handy. 
  28.  
  29.  POV-Panel was developed for POV-Ray 2.0 and any derivatives thereof, 
  30. specifically OS/2 versions.  POV-Panel will not be ported to any other 
  31. platforms.  This is both because it was written in VX-REXX 2.0 which is not 
  32. available on any other platform, and also because I love OS/2, and have had it 
  33. up to here with most other PC "operating systems" (with the exception of 
  34. Linux). 
  35.  
  36.  You can edit your scripts and compile from POV-Panel, or if you prefer a 
  37. different editor, then you can set that up too, and hide the built-in editor. 
  38. All options supported on the OS/2 platform are available, which is to say that 
  39. there is no display-as-you-compile or press-a-key-when-done. You can also hook 
  40. up an output image viewer to POV-Panel. 
  41.  
  42.  If anyone has any wishes or comments, please mail me.  Also, please register. 
  43. It is only $10.  Here is a link to my personal info.  You don't need to 
  44. register to make a comment, though, but if I add something you asked for, then 
  45. I think you should probably register.  POV-Panel isn't nag-ware in any way, 
  46. however. It may become so in future version, if few people register. 
  47.  
  48.  
  49. ΓòÉΓòÉΓòÉ 3. Options Help ΓòÉΓòÉΓòÉ
  50.  
  51. Options Help 
  52.  
  53.  As you look at POV-Panel, you will notice that there are several group-boxes, 
  54. divided into "options".  Help is available for the following options: 
  55.  
  56.      Image Options 
  57.      File Options 
  58.      Various Options 
  59.      Execution Options 
  60.      POV Script 
  61.  
  62.  
  63. ΓòÉΓòÉΓòÉ 3.1. Image Options ΓòÉΓòÉΓòÉ
  64.  
  65. Image Options 
  66.  
  67.  The Image Options look like this: 
  68.  
  69.  These options control the image size, trace portion, anti-aliasing, jitter, 
  70. bounding slabs, and quality of the final image. 
  71.  
  72.  The overall final output image size is determined by the "Width" (x) and 
  73. "Height" (y) boxes.  They are in pixels. 
  74.  
  75.  If you are continuing a trace, or only want to go to a certain point, enable 
  76. the "Trace Only Image Portion" check-box, and then set the relevant area in the 
  77. "X:"  (from x), "to" (to x), "Y:"  (from y), and "to" (to y) boxes.  These are 
  78. in pixels. 
  79.  
  80.  Anti-aliasing gives a higher-quality image, but takes longer, and is usually 
  81. only enabled for the final image, or for fine detail pre-viewing. Anti-aliasing 
  82. is enabled with the "Enable" check-box in the "Anti-Aliasing" group-box.  The 
  83. "Tolerance" and "Rays" values are for fine control (see POV-Ray manual), but 
  84. usually work well at their default settings.  Enabling jitter is on by default, 
  85. which also improves the quality, but is dependent on anti-aliasing being on 
  86. (see manual). 
  87.  
  88.  Bounding slabs speeds up compilation without decreasing quality, and I am not 
  89. sure why the POV-Team allows it to be turned off, but if they do, I do.  You 
  90. can set what the threshold is, however.  If there are less objects than this 
  91. number, bounding slabs may not be faster, and so is disabled. 
  92.  
  93.  The "Quality" slider bar decides which of POV-Ray's options get used in the 
  94. compilation.  Setting this to 9 gives maximum quality, while 1 gives only a 
  95. rough black-and-white sketch with no shadows.  See the manual for more details. 
  96.  
  97.  
  98. ΓòÉΓòÉΓòÉ 3.2. File Options ΓòÉΓòÉΓòÉ
  99.  
  100. File Options 
  101.  
  102.  The "File Options" determine the output format, and the output filename (if 
  103. relevant).  Choose your desired format by clicking on the corresponding 
  104. radio-button.  The filename extension is automatically set, so do not include 
  105. this in the filename. 
  106.  
  107.  
  108. ΓòÉΓòÉΓòÉ 3.3. Various Options ΓòÉΓòÉΓòÉ
  109.  
  110. Various Options 
  111.  
  112.  These options are the ones that probably won't be changed too often, and that 
  113. really didn't fit in all that nicely with the rest.  They are more obscure than 
  114. the rest, and probably most people set them and leave them. In a future 
  115. version, if I run out of room on the screen, I may move these options to the 
  116. Settings notebook. 
  117.  
  118.  "POV Compatibility" sets the language level.  This enables error-free 
  119. compilation of POV-Ray 1.x scripts with POV-Ray 2.x. 
  120.  
  121.  "Symbol Table Size" sets the number of symbols allowed.  This is usually used 
  122. to conserve memory during compilation on memory-constrained systems (DOS). 
  123. "Buffer Size" is similar to "Symbol Table Size", and conserves memory when 
  124. necessary.  These two options can usually just be left. 
  125.  
  126.  "Verbose" toggles the compilation message level between high and low. 
  127.  
  128.  I have had trouble getting "Allow Trace Interruption" to work properly, but 
  129. that is in the implementation of POV-Ray, not in POV-Panel. When it works, it 
  130. saves the picture when a button is pressed, to allow stopping a compilation 
  131. without losing the work to date (usually to allow sleep).  This slows down the 
  132. compile, so use only when necessary. "Continue Trace" allows you to resume a 
  133. previously started picture. 
  134.  
  135.  Use the "Animation Clock" to set a clock value for animating a series of 
  136. pictures. 
  137.  
  138.  
  139. ΓòÉΓòÉΓòÉ 3.4. Execution Options ΓòÉΓòÉΓòÉ
  140.  
  141. Quick Options 
  142.  
  143.  You can switch the Trace Button between compiling and just displaying the 
  144. POV-Ray command.  This can be useful for beginners who would like to learn 
  145. more, and want to see what they are doing, but also for more experienced users 
  146. who want to know exactly what they are doing. 
  147.  
  148.  In this mode, pressing the button displays the command rather than executing 
  149. it. 
  150.  
  151.  
  152. ΓòÉΓòÉΓòÉ 3.5. POV Script ΓòÉΓòÉΓòÉ
  153.  
  154. Built-In Editor 
  155.  
  156.  This is the built-in editor.  It is a fairly mundane implementation of an MLE, 
  157. but is sufficiently nice for most work. 
  158.  
  159.  
  160. ΓòÉΓòÉΓòÉ 4. Menu Help ΓòÉΓòÉΓòÉ
  161.  
  162. Menu Help 
  163.  
  164.  Help for the following menus follows: 
  165.  
  166.      File 
  167.      Utilities 
  168.      Options 
  169.      Help 
  170.  
  171.  
  172. ΓòÉΓòÉΓòÉ 4.1. File ΓòÉΓòÉΓòÉ
  173.  
  174. File 
  175.  
  176.  The "File" menu consists of the following items: 
  177.  
  178.      New 
  179.      Open... 
  180.      Save 
  181.      Save as... 
  182.      Exit 
  183.  
  184.   These are fairly self-explanatory.  Various menu options become disabled when 
  185.  using an external editor.  You will be prompted to save unsaved work if you 
  186.  attempt an action which would lose changes if performed unconditionally. 
  187.  
  188.  
  189. ΓòÉΓòÉΓòÉ 4.2. Utilities ΓòÉΓòÉΓòÉ
  190.  
  191. Utilities 
  192.  
  193.  The "Utilities" menu consists of the following items: 
  194.  
  195.      Editor 
  196.      Image viewer 
  197.      Moray 
  198.  
  199.   The "Editor" item becomes enabled when the built-in editor is disabled.  It 
  200.  launches a copy of the editor. 
  201.  
  202.   The "Image Viewer" item launches your favorite image viewer with the current 
  203.  image in it.  This has to be in TARGA format, as I haven't seen any editors 
  204.  that allow for viewing other POV_Ray supported formats.  If this is 
  205.  inconvenient, mail me with details, and I'll see what I can do. 
  206.  
  207.   "Moray" launches Moray for you.  It currently does nothing else. 
  208.  
  209.  
  210. ΓòÉΓòÉΓòÉ 4.3. Options ΓòÉΓòÉΓòÉ
  211.  
  212. Options 
  213.  
  214.  The "Options" menu consists of the following items: 
  215.  
  216.      File paths 
  217.      Preferences 
  218.      Save options 
  219.  
  220.   "File paths" brings up the notebook for the path settings.  It contains the 
  221.  following pages: 
  222.  
  223.      POV-Ray Paths 
  224.      Util Paths 
  225.      Other Paths 
  226.      Lib Paths 1 and 2 
  227.  
  228.   "Preferences" has two items: 
  229.  
  230.      Pause CMD before exit 
  231.      Use built-in editor 
  232.  
  233.   "Pause CMD before exit" leaves the CMD window paused when the compilation is 
  234.  complete.  This is mainly useful if you keep working in the foreground, and 
  235.  want to see what happened in the CMD window before it disappears.  Unchecking 
  236.  this is handy for starting 50 compiles, and then going to work.  That frees up 
  237.  some resources as each session finishes. 
  238.  
  239.   "Use built-in editor" enables and disables the MLE editor. 
  240.  
  241.   "Save options" saves all modified settings to the INI file immediately, 
  242.  instead of waiting until application is closed. 
  243.  
  244.  
  245. ΓòÉΓòÉΓòÉ 4.3.1. POV-Ray Paths ΓòÉΓòÉΓòÉ
  246.  
  247. POV-Ray Paths 
  248.  
  249.  This option brings up the POV-Ray Paths settings: 
  250.  
  251.  Set the "POV_Ray EXE Path" to wherever you keep POV-Ray with the "Find" 
  252. button.  This speeds up the compilations as the path doesn't have to be 
  253. traversed.  This also allows you to rename the executable for whatever reason. 
  254.  
  255.  The "POV-Ray Manual Path" allows POV-Panel to find the manual for the item on 
  256. the Help menu. 
  257.  
  258.  
  259. ΓòÉΓòÉΓòÉ 4.3.2. Util Paths ΓòÉΓòÉΓòÉ
  260.  
  261. Util Paths 
  262.  
  263.  After POV-Ray Paths is the Util Paths settings page: 
  264.  
  265.  Set the Moray path, the path of the program you use for viewing the output, 
  266. and the path of your external editor here, respectively. 
  267.  
  268.  
  269. ΓòÉΓòÉΓòÉ 4.3.3. Other Paths ΓòÉΓòÉΓòÉ
  270.  
  271. Other Paths 
  272.  
  273.  The third page is the Other Paths settings page: 
  274.  
  275.  Set this to the path of the program you wish to use to view the manual. 
  276. Through judicious use of this setting and the manual path, you should be able 
  277. to accomodate almost any combination of viewers and file formats, in case you 
  278. want to convert the text file to INF, or whatever. 
  279.  
  280.  
  281. ΓòÉΓòÉΓòÉ 4.3.4. Lib Paths 1 and 2 ΓòÉΓòÉΓòÉ
  282.  
  283. Lib Paths 1 and 2 
  284.  
  285.  These screens are used to set up the ten! library paths that POV-Ray lets you 
  286. have (does anyone use ten paths ?). They look like the following: 
  287.  
  288.  
  289. ΓòÉΓòÉΓòÉ 4.4. Help ΓòÉΓòÉΓòÉ
  290.  
  291. Help 
  292.  
  293.  The "Help" menu consists of the following items: 
  294.  
  295.      Help index 
  296.      POV-Ray manual 
  297.      Product information 
  298.  
  299.  
  300. ΓòÉΓòÉΓòÉ 4.4.1. Help Index ΓòÉΓòÉΓòÉ
  301.  
  302. Help Index 
  303.  
  304.  You might be familiar with this item, as it brings you to the beginning of 
  305. this very box :) This is a useful starting point when you don't know what you 
  306. are looking for yet. 
  307.  
  308.  
  309. ΓòÉΓòÉΓòÉ 4.4.2. POV-Ray manual ΓòÉΓòÉΓòÉ
  310.  
  311. POV-Ray manual 
  312.  
  313.  This will look like whatever you have it set up as.  I personally have it set 
  314. up as EPM with povray.doc, and it looks as follows: 
  315.  
  316.  Whatever program you have running here is beyond my control, and pretty much 
  317. independent to do what it wants. 
  318.  
  319.  
  320. ΓòÉΓòÉΓòÉ 4.4.3. Product information ΓòÉΓòÉΓòÉ
  321.  
  322. Product information 
  323.  
  324.  The obligatory about box.  This little about box tells you about the version, 
  325. who wrote it :)  and when.  If you click on the logo, you will get more 
  326. detailed version information.  This may be useful to check when corresponding 
  327. with me about bugs (who, me?)  and so on. 
  328.  
  329.  
  330. ΓòÉΓòÉΓòÉ 5. External Programs ΓòÉΓòÉΓòÉ
  331.  
  332. External Programs 
  333.  
  334.  The following external programs can be hooked up to POV-Panel: 
  335.  
  336.      POV-Ray 
  337.      POV-Ray Manual Viewer 
  338.      External Editor 
  339.      Output Image Viewer 
  340.      Moray 
  341.  
  342.  
  343. ΓòÉΓòÉΓòÉ 5.1. POV-Ray ΓòÉΓòÉΓòÉ
  344.  
  345. POV-Ray 
  346.  
  347.  You pretty much have to set this one up :)  When you press "Start Ray Trace 
  348. Now", you will get a screen something like this: 
  349.  
  350.  
  351. ΓòÉΓòÉΓòÉ 5.2. POV-Ray Manual Viewer ΓòÉΓòÉΓòÉ
  352.  
  353. POV-Ray Manual Viewer 
  354.  
  355.  When you have the Paths properly configured, you can press "POV-Ray Manual" on 
  356. the Help menu and read the POV-Ray manual.  On my computer it looks like this: 
  357.  
  358.  
  359. ΓòÉΓòÉΓòÉ 5.3. External Editor ΓòÉΓòÉΓòÉ
  360.  
  361. External Editor 
  362.  
  363.  If you prefer using a different editor than the built-in one, then you can use 
  364. any editor of your choice.  Just add the path to the Path setings, and disable 
  365. the internal editor.  Then when you press "File", "Use..."  you get a screen 
  366. something like this: 
  367.  
  368.  
  369. ΓòÉΓòÉΓòÉ 5.4. Output Image Viewer ΓòÉΓòÉΓòÉ
  370.  
  371. Output Image Viewer 
  372.  
  373.  You can also hook up a picture viewer, and pressing "Image viewer" will get 
  374. you something like this: 
  375.  
  376.  
  377. ΓòÉΓòÉΓòÉ 5.5. Moray ΓòÉΓòÉΓòÉ
  378.  
  379. Moray 
  380.  
  381.  I don't use DOS any more, so no picture here.  When this is set up, it just 
  382. launches Moray from the command-line, with whatever options you put in the path 
  383. setting box. 
  384.  
  385.  
  386. ΓòÉΓòÉΓòÉ 6. POV-Panel History ΓòÉΓòÉΓòÉ
  387.  
  388. POV-Panel History 
  389.  
  390.  1.0      POV-Panel 1.0 was originally developed in only 3 days, while studying 
  391.           for exams (ah, such is the human mind).  I came across a similar 
  392.           product, but was dissatisfied with it, and hence POV-Panel was born. 
  393.           It has since been polished, and cost me a fortune in midnight oil. 
  394.  
  395.   Plug:  I must say that I am extremely impressed with Watcom VX-REXX 2.0b!  It 
  396.  is very easy and powerful, and I didn't encounter any problems I couldn't work 
  397.  my way around.  That is high praise indeed for such a new product.  Just about 
  398.  the only thing I could wish for is a bit more speed.  Highly Recommended.  The 
  399.  people at Watcom were very helpful in listening to my problems, and making 
  400.  suggestions.  Special thanks go to Eric Guiguere and Paul Prescod for helping 
  401.  out with a couple of tricky areas.  They can be found rummaging around 
  402.  comp.lang.rexx on the Internet. By the way, I have no association with Watcom, 
  403.  apart from loving their products. 
  404.  
  405.  
  406. ΓòÉΓòÉΓòÉ 7. About The Author... ΓòÉΓòÉΓòÉ
  407.  
  408. Carsten Whimster 
  409.  
  410.  Carsten is an undergraduate Computer Science student at the University of 
  411. Waterloo, and an huge OS/2 enthusiast as of OS/2 2.0.  He is currently in his 
  412. third year, taking operating system, language, and compiler courses whenever 
  413. possible.  This summer and fall he is working at the University of Waterloo as 
  414. a tutor (course assistant) for CS241, an introductory course to compilers.  He 
  415. is also a TEAM-OS/2 member. 
  416.  
  417.  Carsten is a beginning OS/2 PM programmer with a few projects on the go, and 
  418. many more in his head.  He uses Watcom C/C++ 10.0, Watcom VX-REXX 2.0b, and 
  419. occasionally emx08h with gcc 2.5.7. 
  420.  
  421.  Carsten is the associate editor for EDM/2, which is why he is familiar enough 
  422. with IPFC to go to all the trouble of making a decent help-facility for such a 
  423. small program.  EDM/2 is a free programmer's newsletter for OS/2 developers, 
  424. and can be found (among other places) at ftp-os2.cdrom.com in 
  425. pub/os2/2_x/program/newsltr. 
  426.  
  427.  You may reach Carsten... 
  428.  
  429.  ...via email: 
  430.  
  431. bcrwhims@uwaterloo.ca  - Internet 
  432.  
  433. gopher://descartes.math.uwaterloo.ca:70/h0/mathSOC/.csc/.www/.bcrwhimster/homepage.html 
  434. - Mosaic homepage 
  435.  
  436. To register, send money ($10 US or CAN) and directions on how to contact you 
  437. to: 
  438.  
  439. Carsten Whimster
  440. 318 Spruce Street, main house
  441. Waterloo, Ontario
  442. Canada
  443.  
  444.  
  445. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  446.  
  447. POV-Ray 2.0 for OS/2 can be found at ftp-os2.cdrom.com in the 
  448. pub/os2/2_x/graphics. 
  449.  
  450.  The Persistence of Vision RayTracer is copyrighted by the POV-Team.