home *** CD-ROM | disk | FTP | other *** search
/ The Best of Select: Games 4 / CD_1.iso / kids / spiro / spiro.doc < prev    next >
Text File  |  2010-01-17  |  21KB  |  463 lines
  1.  
  2.                                Spiroplot
  3.                               Version 2.0
  4.                              January 1990
  5.                           Copyright (C) 1990
  6.                            Donald MacFarlane
  7.  
  8.  ------------------------------------------------------------------------
  9.  
  10.  
  11.                              INTRODUCTION
  12.  
  13.   Spiroplot is a computerized version of Spirograph( a trademark of
  14. Kenner products). The designs are plotted with three wheels. A fixed
  15. wheel and two movable wheels, one inside and one outside of the fixed
  16. wheel. Each of the movable wheels have a "pencil" which is used the
  17. draw, or plot, the design on the computer screen. One or both of the
  18. movable wheels can be used for the plot. Because the wheels are only
  19. mathematical models, with Spiroplot you can create designs which are
  20. impossible in the real world. For example you can have the inside
  21. moveable wheel larger than the fixed wheel which it is inside of. You
  22. can also have the pencil radius of a movable wheel lager than the
  23. wheel itself. Spiroplot also will allow you to save the wheel settings
  24. to a file an play back all the spiroplots in a demonstration fashion.
  25. With version 2.0 the spiroplots can be drawn in color on EGA/VGA
  26. monitors.
  27.  
  28.                              INSTALLATION
  29.  
  30.   A graphics card is required for this program. If you have a EGA or a
  31. VGA card you will be able to plot the spiroplots in color. Because of
  32. the low resolution of CGA the text will be in color but the spiroplots
  33. will only be monochrome in order to obtain a higher resolution. The
  34. program SPIRO.EXE and a graphic driver are required for operation. The
  35. graphics information specific to your graphics card is contained in
  36. one of the *.BGI files. The BGI file appropriate for you graphics card
  37. must be in the default directory or included in the APPEND path( DOS
  38. 3.2 or greater). Only the one BGI file for your peculiar graphics card
  39. need be present. The included BGI files are,
  40.  
  41.     ATT      BGI  - Graphics device driver for AT&T 6300
  42.     CGA      BGI  - Graphics device driver for CGA and MCGA
  43.     EGAVGA   BGI  - Graphics device driver for EGA and VGA
  44.     HERC     BGI  - Graphics device driver for Hercules mono
  45.     PC3270   BGI  - Graphics device driver for 3270 PC
  46.     IBM8514  BGI  - Graphics device driver for IBM 8514
  47.  
  48.   If you wish to use the included demonstration file, SPIRO.DEM also
  49. include this file in the default directory.
  50.  
  51.    To start this program start up your computer as you normally do. At
  52. the DOS prompt type
  53.  
  54. SPIRO and <ENTER>
  55.  
  56. Note on some keyboards the <ENTER> key is marked <RETURN>. You can
  57. force the use of monochrome colors with the "/MONO" option. Type
  58.  
  59.                                    Page 1 
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. SPIRO /MONO <ENTER>
  69.  
  70. and the monochrome colors will be used even on color displays. This
  71. may be useful for monochrome EGA/VGA displays which show colors as
  72. shades of gray. This program detects which kind of graphics card you
  73. have. Normally the program will correctly detect the graphics card
  74. being used. However, not all graphics can be properly detected. The
  75. IBM-8514 will detect as a VGA card. The auto-detection can be
  76. overridden with one of the driver options typed after the program
  77. name. The following driver options are available.
  78.  
  79. /DriverCGA
  80. /DriverMCGA
  81. /DriverEGA
  82. /DriverEGA64
  83. /DriverEGAMono
  84. /DriverIBM8514
  85. /DriverHercMono
  86. /DriverVGA
  87. /DriverATT400
  88. /DriverPC3270
  89.  
  90. For example to use the IBM-8514 card you would type
  91.  
  92. SPIRO /DriverIBM8514 <ENTER>
  93.  
  94.  
  95. The driver option can also be combined with the mono option. It does
  96. not matter what order you list the options. For example, to use a VGA
  97. card with monochrome colors you would type,
  98.  
  99. SPIRO  /DriverVGA /Mono  <ENTER>
  100.  
  101. When the program first starts the copyright message will first be
  102. displayed. The type of graphic display and resolution being used is
  103. also displayed. Pressing any key will move you on to the main menu
  104. screen. If you press any key while the file is being loaded the
  105. copyright message will be skipped over.
  106.  
  107.  
  108.                                OPERATION
  109.  
  110.   The opening screen( shown below ) displays the menu and all the
  111. current settings. The selection of the menu items is accomplished by
  112. using the arrow key to highlight the desired item and then pressing
  113. the <ENTER> key.  The menu items may also be selected by pressing the
  114. first letter of the desired item. The line above the menu is the help
  115. line and will give a brief description of the currently highlighted
  116. item.
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.                                    Page 2 
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                              ╔═════════════════════╗
  136. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║      Spiroplot      ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  137. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║  by Don MacFarlane  ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  138. ▒                            ╚═════════════════════╝                           ▒
  139. ▒                                                                              ▒
  140. ▒        Set the radius of the fixed wheel and the background color            ▒
  141. ▒     ╔═════════════════════════════════════════════════════════════════╗      ▒
  142. ▒     ║  Fixed   Inside  Outside Show    Plot    Demo    Add     Quit   ║      ▒
  143. ▒     ╚═════════════════════════════════════════════════════════════════╝      ▒
  144. ▒                                                                              ▒
  145. ▒   ┌──────────────  FIXED WHEEL  ─────────────┐                               ▒
  146. ▒   │ Radius   60.00  Background Black         │                               ▒
  147. ▒   └──────────────────────────────────────────┘                               ▒
  148. ▒                                                                              ▒
  149. ▒   ┌─── MOVING WHEELS ────Inside────Outside───┐     ┌───  SHOW WHEELS  ───┐   ▒
  150. ▒   │           Active       Yes       Yes     │     │                     │   ▒
  151. ▒   │     Wheel Radius     14.00     23.00     │     │ Show Wheels     No  │   ▒
  152. ▒   │ Radius of pencil     14.00     17.00     │     │                     │   ▒
  153. ▒   │   Reverse radius       Yes       No      │     │ Wait between    No  │   ▒
  154. ▒   │   Time increment     0.050     0.100     │     │                     │   ▒
  155. ▒   │     Maximum Time     43.90    144.51     │     │                     │   ▒
  156. ▒   │            Color     White     White     │     │                     │   ▒
  157. ▒   └──────────────────────────────────────────┘     └─────────────────────┘   ▒
  158. ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  159.  
  160.    The basic operation is to set the parameters for the wheels and
  161. then select the plot option. After the spiroplot is completed,
  162. pressing any key will return you to the menu. Pressing the escape key
  163. <ESC> during any plot will return you to the main menu. Pressing the
  164. space bar <SPACE> will stop what ever spiroplot is currently doing and
  165. go on to the next. If you press <SPACE> during a plot, the current
  166. wheel will stop and the next wheel, if any, will continue. If the
  167. wheels are being displayed, pressing <SPACE> will stop the wheel
  168. display for that wheel and go on plotting with out the wheel display.
  169. If you are anxious to see what Spiroplot can do, skip down to the
  170. description for the Demo and run the included demonstration file,
  171. Spiro.Dem.
  172.  
  173.    When you select a menu item which requires input a window will pop
  174. up and ask for the necessary information. The default values will be
  175. displayed in parentheses. To select the default value simple press
  176. <ENTER>. To change the value type in the new value and then press the
  177. <ENTER>. If a improper value has been entered the computer will beep
  178. and the value will not be changed. For prompts requiring a Yes or No
  179. answers, "Yes" or "Y" may be entered for a yes answer and "No" or "N"
  180. for a no answer. Only the fist letter is required.
  181.  
  182.    If you have a EGA or VGA card you will be able to set the
  183. background an drawing colors. On CGA and monochrome you are still able
  184. to set the colors but when plotted the background will always be black
  185. and the drawing color will be white. When entering color names you may
  186. type out the whole name but only the part which makes the name unique
  187. is looked at. The table on the next page is a list of colors
  188. available. Only the letters which are capitalized are required.
  189.  
  190.  
  191.                                    Page 3 
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.                      Apiroplot Color Names
  201.     ╔═══════════════════════════════════════════════════════════╗
  202.     ║   BLAck                        GRAy                       ║
  203.     ║   BLUe                         LTBlue    or LIGHTBule     ║
  204.     ║   GREen                        LTGREen   or LIGHTGREen    ║
  205.     ║   Cyan                         LTCyan    or LIGHTCyan     ║
  206.     ║   Red                          LTRed     or LIGHTRed      ║
  207.     ║   Magenta                      LTMagenta or LIGHTMagenta  ║
  208.     ║   BRown                        Yellow                     ║
  209.     ║   LTGRAy or LIGHTGRAy          White                      ║
  210.     ║   F1 or Func1  ( multi-color )                            ║
  211.     ╚═══════════════════════════════════════════════════════════╝
  212.  
  213.  
  214.    To get some idea about setting the parameters look in the demo file
  215. Spiro.Dem. It is a ASCII file and you can print it out if you want.
  216. Compare the parameters with the spiroplots when the Demo menu item is
  217. selected and the demo is run. You will notice when the ratio of the
  218. moving wheel to the fixed is not a integer spiroplot will be more
  219. complex because it will take a longer time before the spiroplot starts
  220. to repeat. You may also find it helpful selecting the show wheels
  221. option which will display the position of the wheels.
  222.  
  223.   When changing the parameters for one of the movable wheels, inside
  224. or outside, you will be asked the following questions(Inside wheel
  225. shown). Each question is explained below.
  226. ╒═════════════════════════════════════════════════════════════════════╕
  227. │Inside Wheel                                                         │
  228. │  Use The Wheel?       (Yes) -->                                     │
  229. │           Radius   (  14.00)-->                                     │
  230. │  Radius of pencil  (  14.00)-->                                     │
  231. │    Reverse radius?    (Yes) -->                                     │
  232. │    Time increment  (  0.050)-->                                     │
  233. │         Max Time   (  43.90)-->                                     │
  234. │       Color (White         )-->                                     │
  235. │                                                                     │
  236. │                                                                     │
  237. ╘═════════════════════════════════════════════════════════════════════╛
  238.  
  239. Use Inside/Outside Wheel ? - Answer "Yes" if you want to use the
  240.         inside/outside wheel. Make sure to select at least one.
  241.         Otherwise you wont see anything. One or both wheels may be
  242.         used. If both are selected the inside will be used first and
  243.         then the outside.
  244.  
  245.  
  246. Radius  -  Radius of the wheel. The fixed wheel is always centered in
  247.         the middle of the screen. The units are setup such that it is
  248.         100 units to the top of the screen and 100 units to the
  249.         bottom. Note that the radius of the inside wheel may be larger
  250.         than the radius of the fixed wheel even though it is not
  251.         possible in the real world. Whenever the radius is changed a
  252.         new default max time is computed using the current fixed wheel
  253.         radius. You should set the fixed wheel first before setting
  254.         any of the movable wheels. Otherwise the default max time will
  255.         be wrong.
  256.  
  257.                                    Page 4 
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266. Radius of pencil -  The distance from the center of the moving wheel
  267.         to the "position of the pencil". This is the position the
  268.         imaginary pencil, used for plotting, is placed. This distance
  269.         may be lager than the radius itself.
  270.  
  271.  
  272. Reverse radius ? - Answer "No" to use a normal radius. By using the
  273.         normal radius Spiroplot will behave like the real Spirograph.
  274.         The radius and the pencil will move in the correct direction
  275.         as a real wheel would. If you answer "Yes" then the radius and
  276.         pencil will move in the opposite direction. This will
  277.         completely change the design.
  278.  
  279.  
  280.  
  281. Time increment - The steps of time when the pencil position is
  282.         evaluated. The way Spiroplot works is at these time steps the
  283.         position of the pencil is mathematically evaluated and a line
  284.         is drawn form the last position to the current position. By
  285.         using small time increments the lines will produce smother
  286.         curves but will take much longer to plot. You will probable
  287.         want to start out with a large(0.1-1) time increment so the
  288.         spiroplot will be quick until you have the basic shape you
  289.         want. Then decrease the increment until the curves are smooth
  290.         enough. By using a large increment you can also get some
  291.         interesting effects. Some of the spiroplots in the demo file
  292.         use large time increments. Take a look at the spiroplots
  293.         Demo#16 - Demo#27. They all use the same wheel parameters but
  294.         the time increment is varied from 0.1 to 11.
  295.  
  296.  
  297.  Max time - The maximum time the spiroplot is allowed to run. This is
  298.         not real time but the mathematical time used in evaluating the
  299.         pencil position. The time units are not really important but
  300.         they are set up such that it takes 2π(6.283) units of time for
  301.         the movable will to rotate once about the fixed wheel.
  302.  
  303.            A spiroplot will eventually start to repeat itself. The
  304.         default maximum time is set to the time when the spiroplot
  305.         starts to repeat. If you use a longer time the spiroplot will
  306.         start tracing over itself but because of roundoff errors it
  307.         will be slightly off and make the line a little thicker than
  308.         the rest. The default max time is computed ONLY when you
  309.         change the moving wheel radius. The computation is based on
  310.         the current radius of the fixed wheel. It is important to set
  311.         the fixed wheel first before you set the moving wheels.
  312.         Otherwise the default max time will be off. The max time is
  313.         not updated for each of the moving wheels when you change the
  314.         fixed wheel radius. This is prevent from wiping out a
  315.         different maxtime you may have set.
  316.  
  317.          If you use large time increments, the curves become
  318.         discontinues line segments. The max time will not work because
  319.         spiroplot may never start to repeat. Start with the default
  320.         value and keep increasing max time till it looks the way you
  321.         want.
  322.  
  323.                                    Page 5 
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  Color - The color to draw with for this wheel. Use one of the colors
  333.         listed above. Note it is possible to set the drawing color to
  334.         the same color of the background and if you do this of corse
  335.         you will not see anything. On CGA and monochrome displays you
  336.         enter a color here but the spiroplots will always be drawn in
  337.         white.
  338.  
  339. ===============================================================================
  340. Each of the main menu items is explained below
  341.  
  342. Fixed   -  Set the radius of the fixed wheel. The fixed wheel is
  343.         always positioned in the center of the screen. You can also
  344.         set the background color here. Use one of the solid colors
  345.         listed above. The background color can not be set to a color
  346.         function.
  347.  
  348. Inside  - Set parameters for the inside wheel  (see above).
  349.  
  350.  
  351. Outside - Set parameters for the outside wheel  (see above).
  352.  
  353.  
  354. Show    - Select the show wheel option. This option will help you in
  355.         determining the wheel parameters and can be just fun to watch.
  356.         The fixed wheel, moving wheel and pencil position will be
  357.         displayed along with the spiroplot. You are also asked if you
  358.         want the plot to pause after each wheel display. If you answer
  359.         "Yes", then after each wheel movement the plot will stop and
  360.         wait for you to press any key(except <ESC> or <SPACE>).
  361.         Displaying the wheels will greatly slow down the plot. You can
  362.         cancel the wheel display at any time by pressing <SPACE>.
  363.         Pressing <SPACE> will only quit the show wheels option for
  364.         that wheel. After pressing the key the plot for that wheel
  365.         will continue with out the  wheel display. If you press
  366.         <SPACE> again while the plot is being drawn with out the wheel
  367.         display, you will quit out of the plot itself. Pressing <ESC>
  368.         will bring you back to the main menu.
  369.  
  370. Plot    - Plot the current spirograph using the current settings.
  371.         Pressing <ESC> will stop the plot and return you to the main
  372.         menu. Pressing the <SPACE> will only stop the current wheel.
  373.  
  374. Demo    - Run a demo file. Each line in a demo file contains all the
  375.         parameters for a spiroplot along with a optional title. You
  376.         will be asked for the file you want to run and how many
  377.         seconds to pause between plots. The default file is the one
  378.         included with this program Spiro.Dem. The spiroplots will be
  379.         displayed one after another. When the end of the file is
  380.         reached the demo will go back to the top. The  demo may be
  381.         stopped by pressing <ESC>. You will quit the demo and return
  382.         to the main menu. Note if the wheel display is set to yes the
  383.         wheels will be displayed for all of the demo. Pressing <SPACE>
  384.         during the demo will do the same as in the Plot option. The
  385.         plot will stop with the current wheel and go on to the next,
  386.         if any. This can be used to skip parts of the demo you are not
  387.         concerned with.
  388.  
  389.                                    Page 6 
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.            New spiroplots can be added by selection the main menu item
  399.         Add. The file itself is a ASCII file and can be edited with
  400.         any ASCII text processor (use Non-document for Word Star).
  401.         Comments lines may be used by placing a "*" in the first
  402.         column. Take a look at the included demo file. It will give
  403.         some good examples.
  404.  
  405.  
  406. ADD     - Add the current parameters to a demo file(see Demo). You
  407.         will be asked for the file to add to. If the file is not found
  408.         you will be asked if you want create a new one. If answered
  409.         yes a new file will be created and the current parameters
  410.         added to it. A optional title may be used. If a title is
  411.         entered the title will be displayed  at the bottom left of the
  412.         screen when the demo is run.
  413.  
  414.  
  415. Quit     - Quit Spiroplot and return to the system.
  416.  
  417.  
  418. ----------------------------------------------------------------------
  419.  
  420.    I hope you will enjoy this program. This program is free. Anyone is
  421. welcome to use it and pass it along as they like,  as long as no fee
  422. is charged for the program and this program and the documentation are
  423. distributed only in there original, unmodified state. The graphic
  424. driver files(*.BGI) are proprietary to Borland International and must
  425. not be given or used apart from this program. I would like to hear of
  426. any suggestions or problems. The number of possible spiroplot is
  427. unlimited. If find some you particularly like and would like to share,
  428. send me a copy of the parameters. I will try to put them all in to the
  429. demo file supplied with this program and give appropriate credit to
  430. the authors in the spiroplot titles.
  431.  
  432.    If you would like to support this type of programming or are
  433. interested in the inner workings of this program for $12(5¼), $13(3½)
  434. you will receive a disk containing the heavily commented Turbo Pascal
  435. 5.0 source code. A version which uses the math coprocessor is also
  436. included. If you have a math coprocessor, the coprocessor version is
  437. about three times faster. If you recompile the source code Turbo
  438. Professional is required for the exploding windows. The source code is
  439. fully functional with out Turbo Professional but just no fancy
  440. windows.
  441.  
  442. Please direct all replies to the address below,
  443.  
  444.  
  445.                            Donald MacFarlane
  446.                                Spiroplot
  447.                            80 Browning Ave.
  448.                            Nashua, NH 03062
  449.  
  450.                        CompuServe ID: 72411,2146
  451.  
  452.  
  453.  
  454.  
  455.                                    Page 7 
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.