home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 137.lha / Perim / Peri.doc < prev    next >
Text File  |  1986-11-20  |  21KB  |  444 lines
  1. /***************************************************************\
  2. **                                                             ** 
  3. **  Name       :- Peri v1.000-BETA                             ** 
  4. **                                                             ** 
  5. **  Author     :- Gregory A. Kendall, Brendallson Software     ** 
  6. **                                                             ** 
  7. **  Date       :- 25 April 1988                                ** 
  8. **                                                             ** 
  9. **  Updates    :- 25-Apr-88   Creation and Debug               ** 
  10. **                                                             ** 
  11. \***************************************************************/ 
  12.  
  13.                      Peri v1.000-Beta Manual 
  14.                       by Gregory A. Kendall 
  15.               Program written by Gregory A. Kendall 
  16.                           25 April 1988 
  17.  
  18.  
  19. Table Of Contents :---------------------------------------------- 
  20.  
  21.           I.    Introduction 
  22.                   A. About this program and Tracer3d 
  23.                   B. ShareWare and Brendallson 
  24.           II.   Getting Started 
  25.                   A. The Peri Environment 
  26.                   B. BackUp Disks 
  27.           III.  Peri Options 
  28.                   A. The LOAD   Option ( -l ) 
  29.                   B. The SAVE   Option ( -s ) 
  30.                   C. The PEBF   Option ( -e ) 
  31.                   D. The RELOAD Option ( -r ) 
  32.                   E. The QUIET  Option ( -q ) 
  33.                   F. Constant 
  34.                   G. AutoExtrusion 
  35.                   H. The X-Axis and Y-Axis 
  36.                   I. The Z-Axis 
  37.                   J. Advice 
  38.            IV.   Operation 
  39.                   A. Running Peri 
  40.                   B. Setting the Origin 
  41.                   C. Entering Points 
  42.                   D. Quitting Peri 
  43.                   E. The PEBF file 
  44.                   F. The VScape Geometry File and Polygons 
  45.           V.    Updates and Brendallson 
  46.                   A. What's in store for v1.+++ 
  47.                   B. Disclaimer 
  48.                   C. Afterword 
  49.  
  50. /\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/ 
  51.  
  52.  
  53. I. Introduction:------------------------------------------------- 
  54.  
  55.                    A. About Peri and Tracer3d 
  56.  
  57.      Let me start off by welcoming you to the world of Peri. 
  58. This program is a VideoScape3D (  Aegis Development ) Geometry 
  59. File Utility.  While you wait for the next version of VScape3D, 
  60. here is a program that allows you to load an IFF image, trace the 
  61. outline of a pre-existing object, and create the POINTS section 
  62. of a VScape object geometry file.  This saves you from having to 
  63. type in a long series of numbers that describe the X, Y, and Z 
  64. coordinates of each point. 
  65.      Peri v1.000-BETA is based loosely on Tracer3D by Jim Wamsley 
  66. and Bob Castro.  It was written at the request of Bob Castro who 
  67. was a member of AUGA ( Athens Georgia Amiga Users Group ).  This 
  68. BETA version of Peri does the same job as the last version of 
  69. Tracer3D and a bit more.  I am sure you will agree that this is a 
  70. much better way to go about setting up VScape3d object files than 
  71. hand typing them.   
  72.      The BETA version does not contain the routines for 
  73. completing the geometry file by editing polygons.  The full 
  74. release version of this program will include those routines; 
  75. however, that version of Peri will not be ShareWare.  Please read 
  76. over the Updates section of this manual for more information on 
  77. the full release version of Peri. 
  78.      I strongly suggest reading this manual from cover to cover. 
  79. It contains much insight into the workings of Peri and the hows 
  80. and whys of its operation. 
  81.  
  82.                   B. ShareWare and Brendallson 
  83.  
  84.      This BETA version of Peri is the Great Experiment on the 
  85. part of myself and Brendallson Software.  I release this version 
  86. as SHAREWARE for the purpose of test-marketing this product.  If 
  87. response is too low, the project will be scrubbed and I will not 
  88. release the full-release version at all.  The ShareWare cost of 
  89. Peri is $15 dollars.  Please send all ShareWare contributions to 
  90. the following address: 
  91.  
  92.                        Gregory A. Kendall 
  93.                     ATN/ Brendallson Software 
  94.                          522 Neese Road 
  95.                       Woodstock, Ga. 30188 
  96.  
  97. All checks should be made payable to Gregory A. Kendall.  If you 
  98. happen to live in Athens (Georgia), you can reach me on the 
  99. LifeSupport BBS for AUGA (HANDLE: Percy).  As I said, if response 
  100. is not high enough, this program will be scrubbed by Brendallson 
  101. Software and myself. 
  102.  
  103.  
  104. II. Getting Started :-------------------------------------------- 
  105.  
  106.                      A. The Peri Environment 
  107.  
  108.      After De-Arcing this program, you should have the following 
  109. files: 
  110.  
  111.           Peri                : the program itself 
  112.           Peri.Doc            : this doc file 
  113.           environment         : batch file for Peri environment 
  114.           Peri.info           : icon for Peri 
  115.           Tardis              : a DPaint IFF file 
  116.  
  117. First, we must talk about the Peri Environment.  The first thing 
  118. you need to do is to format a blank disk.  You can also install 
  119. the disk and set it up with all of the files needed for a 
  120. workbench disk if you want this to be a boot disk.  Then move all 
  121. of the files listed above onto the RAM: disk.  From here it is 
  122. easy: Just EXECUTE the "environment" batch file.  This batch will 
  123. set up the disk in DF0: with the proper directories and such that 
  124. define the Peri Environment.  Make sure that the disk in DF0: is 
  125. the one that you want to set up!!!!  Also, note here that the 
  126. batch file will copy the various Peri files to the correct places 
  127. on that disk. 
  128.    When the "environment" batch file is done, you are ready to 
  129. start with you Peri project.  If you set Peri up on a workbench 
  130. disk, then you will want to reboot the system with that disk at 
  131. this time. 
  132.  
  133.                          B. BackUp Disks 
  134.  
  135.      At this time after you have set up the Peri Environment, it 
  136. would be a good idea to back up the Peri disk.  This is to 
  137. provide a good way to recover from a disk crash.  If you don't 
  138. want to tie up a disk just for a Peri backup, then I suggest at 
  139. least keeping the Peri.Arc file intact. 
  140.  
  141.  
  142. III. Peri Options :---------------------------------------------- 
  143.  
  144.                     A. The LOAD Option ( -l ) 
  145.  
  146.      The load option is where you enter the name of the IFF 
  147. picture file that you want to work from.  This parameter MUST 
  148. include the full path name of the file intended. 
  149.      You can also specify this option on the command line by 
  150. using the -l option flag.  The format is -lFILENAME on the 
  151. command line and Peri inserts FILENAME in the Load field. 
  152.  
  153.                     B. The SAVE Option ( -s ) 
  154.  
  155.      The save option is where you enter the name of the VScape 
  156. Geometry file you wish to create.  Again, this must be a full 
  157. path name of the file you wish to create. 
  158.      Also, you can specify this option on the command line by 
  159. using the -s option.  The format is -sFILENAME and Peri inserts 
  160. FILENAME in the Save field. 
  161.  
  162.                     C. The PEBF Option ( -e ) 
  163.  
  164.      The PEBF option gives you the chance to set the name of the 
  165. PEBF file that Peri will use for your project.  This option is 
  166. only available on the command line with the command -eFILENAME. 
  167. That format must be used.  If you don't specify the name of the 
  168. PEBF for that project, Peri uses the default "Data/Peri.EBF". 
  169. This option is only made available for completeness.  If is 
  170. recommended that you just use the default on this as the program 
  171. gives help if the default is used. 
  172.      For more information on the help Peri gives to the default 
  173. file name refer to the RELOAD section of this chapter.  Also, for 
  174. more information on what a PEBF file is, please refer to the PEBF 
  175. File section of the Operation chapter. 
  176.  
  177.                    D. The RELOAD Option ( -r ) 
  178.  
  179.      This option gives you the power to quit Peri ( for say, 
  180. lunch or bad weather ) and come back to where you left off.  The 
  181. format of this command is -rFILENAME where FILENAME is the name 
  182. of an existing PEBF file.  You need to use the full path name as 
  183. always. 
  184.      As an added feature, if you used the default PEBF name 
  185. (discussed in the last section), you can either give the full 
  186. path name or use -r. ( yes, that is dash "r" period ).  By 
  187. specifying -r. Peri knows that you want to reload the PEBF file 
  188. with the default PEBF name.   
  189.      Please refer to the PEBF Option section and the PEBF File 
  190. section for more information.  This option is only available on 
  191. the command line, not in the Peri Options Menu. 
  192.  
  193.                    E. The QUIET Option ( -q ) 
  194.  
  195.      By specifying QUIET option, you tell Peri that you don't 
  196. want to look at the two title screens that fade in and out at the 
  197. beginning of the program.  When this option is specified, Peri 
  198. begins by displaying the Options Menu. 
  199.  
  200.                            F. Constant 
  201.  
  202.      This option lets you re-define the scale of the picture.  If 
  203. you want your VScape picture to be say twice as big as the 
  204. picture actually is on the screen, then specify a 2 in the 
  205. Constant slot.  I regret that Peri does not yet support a 
  206. Constant scaling which would allow you to make the picture 
  207. smaller.  That feature will be made available in the full release 
  208. version. 
  209.  
  210.                         G. AutoExtrusion 
  211.  
  212.      Peri will automatically extrude a traced object into the 
  213. third dimension.  An example of this type of work is a flat paper 
  214. logo.  The logo can either be scanned into the Amiga with 
  215. Digi-View, or it can be traced "live" by pointing a video camera 
  216. at the artwork and using the Genlock to superimpose the picture 
  217. of the Peri loaded picture.  For every point selected on the logo 
  218. with the left mouse button, a second point will be created behind 
  219. the first in the third dimension.  When you are done, you 
  220. automatically have depth for half the work.   
  221.      The default is +5.  This is good for an object that rests on 
  222. the Z-Axis at 0.  If you don't wish Peri to automatically extrude 
  223. the points, just select "x" for the AutoExtrusion value. 
  224.  
  225.                         H. The X & Y Axis 
  226.  
  227.      These two options allow you to pre-set the origin that Peri 
  228. will work around.  If you happen to know this value off-hand, 
  229. then you can enter these values in before the program starts to 
  230. enter points.  If both of these values are left at the default 0 
  231. then you will be able to set the origin using the mouse.   
  232.  
  233.                           I. The Z-Axis 
  234.  
  235.      This option allows you to change the Z-Axis coordinate of 
  236. the points you are entering.  If you change this, be sure to set 
  237. the AutoExtrusion coordinate are affected by your new resting 
  238. position. 
  239.  
  240.                             J. Advice 
  241.  
  242.      I would like to point out now that for 90% ( as stated by 
  243. Bob Castro ) of the projects you will do with Peri, the default 
  244. settings in the Options menu will suffice.  The most changed 
  245. options will be the LOAD and SAVE options.  Other than this I 
  246. recommend using the defaults.  They are there for you change when 
  247. you need to, but are set so as to provide the best service for 
  248. now. 
  249.  
  250.  
  251. IV. Operation :-------------------------------------------------- 
  252.  
  253.                          A. Running Peri 
  254.  
  255.      To run Peri just type in Peri from CLI or click on the Peri 
  256. icon from WorkBench.  I know that this type of advice is pretty 
  257. silly since you are probably using the Amiga for professional 
  258. purposes.  However, this is included for those who might just 
  259. have purchased an Amiga and might not know all about it yet. 
  260. Please bear with me. 
  261.  
  262.                       B. Setting the Origin 
  263.  
  264.      After you have entered your options and Peri has displayed 
  265. the picture, you are asked to enter the origin.  Move the mouse 
  266. to the origin that you wish to use and click the Left Mouse 
  267. Button.  All of the other points entered using Peri will be 
  268. determined by this point.  The origin is the place on the screen 
  269. that you wish X=0 and Y=0 to be. 
  270.  
  271.                        C. Entering Points 
  272.  
  273.      After entering the origin, Peri saves the origin in a PEBF 
  274. file and then starts displaying mouse location information and 
  275. the current point count.  Notice that the point count is the 
  276. actual number of points entered unlike Tracer3D which did not 
  277. include the origin in the point count.  Just move the mouse along 
  278. and enter the points you wish to have using the left mouse 
  279. button. 
  280.      Let me point out now some difference between Peri and 
  281. Tracer3D. 
  282.      When entering points in Tracer3D, you must be careful not 
  283. to move the mouse when entering a point or the drift could mess 
  284. up where you entered the point.  In Peri this is not a problem. 
  285. Recall that Peri is written in C as opposed to Tracer3D's 
  286. AmigaBasic.  C allows for more control in the processing of 
  287. Messages from the mouse so I have been able to avoid the problem 
  288. from Tracer3D. 
  289.      Also, when the autosave feature of Tracer3D was working at 
  290. saving data to the disk, you could not enter points.  This 
  291. resulted in points being selected wrong and sometimes it confused 
  292. Tracer3D.  The author was aware of this limitation of AmigaBasic 
  293. and warned the user; however, that warning is NOT necessary for 
  294. Peri.  If you get to going to fast and try to enter a point when 
  295. Peri is in the AutoSave routine, nothing happens.  The messages 
  296. from those clicks during a write to a disk are ignored. 
  297.      To avoid confusion later on when entering your polygon list, 
  298. you should try to choose the points on the picture in a clockwise 
  299. direction.  This is not required since Peri lets you enter points 
  300. wherever you wish; however, Bob Castro, who works with VScape a 
  301. lot, says that less confusion results from a clockwise direction. 
  302. He reports fewer problems with using the Tracer3D generated files 
  303. with VScape when he used the clockwise method.  The same applies 
  304. to Peri. 
  305.      Also, let me note here that the shape of the mouse you use 
  306. is important.  I suggest using a cross-hairs design mouse image. 
  307. This allows you to get an intuitive feel for where the mouse is 
  308. actually pointing.  Make sure that the hot-spot for the mouse is 
  309. in the center of the cross-hairs!!!!!!! 
  310.  
  311.                         D. Quitting Peri 
  312.  
  313.      To quit Peri and/or finish your project, just click the left 
  314. mouse button on the window close gadget.  You are then asked if 
  315. you really meant to select this option.  If you choose CANCEL, 
  316. Peri pretends you never hit the close gadget so don't worry. 
  317.      If you choose OK, then Peri finishes up the PEBF file and 
  318. then asks you if you wish it to create a VScape geometry file at 
  319. that time.  If you are just quitting to go to lunch or something, 
  320. just choose CANCEL and you can pick up where you left off later 
  321. using the -r option.  If you choose OK, Peri creates the file. 
  322.      In either case, Peri exits and displays the settings of the 
  323. options you chose.  This information is just for you to look at. 
  324. The discussion on the PEBF File in the next chapter will confirm 
  325. that all of this information is stored in that file.  There is no 
  326. reason to remember this information.  It is only displayed so you 
  327. can further guard against messups. 
  328.      To save that information in a file, just use the UNIX 
  329. redirection provided on the Amiga.  By using "Peri >ram:stuff" to 
  330. run Peri from CLI, that Amiga automatically saves the output 
  331. information at the end of the program to the file "ram:stuff". 
  332. Remember that in order to use this feature, the redirection 
  333. command MUST come before any other arguments you specify for 
  334. Peri. 
  335.  
  336.                         E. The PEBF File 
  337.  
  338.      The PEBF file is a type of IFF file that I have come up with 
  339. for this specific purpose.  It is a file in which the information 
  340. of points and options is stored for future reference.  This 
  341. allows you to quit and restart later at the same place and guard 
  342. against power-failures that would destroy all of your work.   
  343.      While you are entering points, Peri saves them to the PEBF 
  344. file ever 15 points.  Please refer to the RELOAD and PEBF options 
  345. sections for more information. 
  346.      As for reloading, the PEBF file contains ALL of your option 
  347. settings from before with the exception of the PEBF option set 
  348. with the -e command line flag.  There is no perfectly standard 
  349. form to this file yet so I will refrain from explaining the 
  350. sections of this file.  It is enough to know that this file is 
  351. created by Peri for your own good. 
  352.  
  353.          F. The VScape Geometry File and Polygon Listing 
  354.  
  355.      After you are finished with your Peri project, you are now 
  356. ready to put in the Polygon listing section of the VScape 
  357. Geometry file.  Just get out your favorite text editor and edit 
  358. the saved file.  You will see information in the following form 
  359. without the comments provided by me here: 
  360.  
  361. 3DG1 
  362. 5                   <-- number of points in file 
  363. 0 0 0 
  364. 2.5 1 0 
  365. 2.5 1 5 
  366.  
  367.    This file was created with the default options in Peri. 
  368. Notice the autoextruded points after the points that I entered. 
  369. I only entered the origin and 2 other points. 
  370.    The first section of the file says that this is a VScape 
  371. Geometry file ( 3DG1 ).  The next entry is the number of points 
  372. in the file.  Immediately following this is the point listing 
  373. that Peri generates. 
  374.    Immediately after these points is where you will enter your 
  375. polygon list.  Once you are done with this, you have a usable 
  376. VScape geometry file. 
  377.  
  378.  
  379. V. Updates and Brendallson :------------------------------------- 
  380.  
  381.                  A. What's in store for 1.+++ ? 
  382.  
  383.      What is in store for the full-release version?  Well, for 
  384. one thing: PolyGon Editing.  You can also look forward to 
  385. point-deleting, file requesters, and possibly support for 
  386. overscan video. 
  387.      The only problem with the full-release version of Peri is 
  388. that it is slated to be a Commercial Release and will NOT be 
  389. available through the ShareWare program.  What does this mean? 
  390. Well, it means that most people will have to buy that program 
  391. from their Amiga Dealer.  The good news is that those who respond  
  392. to the ShareWare add at the beginning of this doc will be able to 
  393. purchase the full-release for $15 as an update charge. 
  394.  
  395.                           B. Disclaimer 
  396.  
  397.      This program carries no warranty implied or written.  I have 
  398. tested it extensively and find no GURU bugs; however, they may 
  399. exist.  Please write and tell me about the circumstances that 
  400. lead to a GURU error from Peri.  I have taken great care to 
  401. provide a SOFTWARE ERROR free program, but I am not perfect.  The 
  402. only support that I do offer is for BUG FIX UPDATES, and the 
  403. special purchase price of the full-release version to ShareWare 
  404. contributors to Peri. 
  405.  
  406.                           C. Afterword 
  407.  
  408.      I would like to take this chance to thank you for trying out 
  409. Peri.  I hope that the program will perform to your expectations 
  410. and I think you'll agree that this is a much better way to go 
  411. about setting up VScape Geometry files. 
  412.      This program is from Brendallson Software and Gregory A. 
  413. Kendall.  It has no affiliation with Aegis Development in any 
  414. way.  Remember that Video Scape 3D is a copywrited program of 
  415. Aegis Development. 
  416.      Thanks again for using Peri and feel free to drop me a line 
  417. concerning bugs, suggestions, and your ShareWare contribution. 
  418. You can find my address in the first chapter of this manual. 
  419.      Special thanks go to Jim Wamsley, Bob Castro. and John 
  420. Lotshaw for development ideas and concept theory interfaces. 
  421. This program was written at the request of Bob Castro of Atlanta 
  422. Georgia. 
  423.  
  424. Gregory A. Kendall,  
  425.           Brendallson Software 
  426.  
  427.  
  428.                              The End 
  429.  
  430. P.S.  Please Note : As an added feature, I have added a way to find out just 
  431.     what that last point you entered was.  I figured that this would be
  432.     helpful for when you quit and come back later.  The ESC key on the
  433.     keyboard toggles a circle that indicates the last point you entered
  434.     using Peri.
  435.  
  436. P.S.S  I neglected to note in this doc that you can use any IFF picture file
  437.     for use in Peri with the exception of HAM pictures.  As long as the
  438.     IFF file is an ILBM file, it could have come from DPaint, Digitizer, 
  439.     or your grandmother.  One of the nice features that I would like
  440.     to point out is that you can make a picture in DPaint, save it as
  441.     a brush for memory saving, and Peri will load it quite fine.  I 
  442.     included routines to handle the loading of Dpaint brushes to provide
  443.     a way to keep disk space as free as possible.
  444.