home *** CD-ROM | disk | FTP | other *** search
/ MACD 9 / MACD9.iso / PPC-Soft / Benoit / Benoit.readme < prev    next >
Encoding:
Text File  |  1997-06-19  |  6.2 KB  |  229 lines
  1. Introduction
  2. ============
  3.  
  4. Benoit is a fractal image renderer. It is able to calculate several types of
  5. fractal images, including the well-known Mandelbrot set and Julia sets.
  6. Furthermore, using Benoit's formula editor, one can easily explore other types
  7. of fractal images.
  8.  
  9. Benoit renders in true color only, therefore it needs a 15/16/24bit CyberGraphX
  10. display screen.
  11.  
  12. Furthermore, Benoit fully supports phase5's PowerUP cards. It auto-detects the
  13. PowerPC processor and lets the user decide whether to use it or not. If a PPC
  14. is not present, Benoit switches back to M68k mode.
  15.  
  16.  
  17.  
  18. Features
  19. ========
  20.  
  21. - True color rendering, all calculations are done in 24bit
  22. - Can be opened on any 15/16/24bit PubScreen
  23. - Sizable window
  24. - Auto-sensing of PowerUP cards
  25. - CPU switchable (M68k / PPC)
  26. - Six different fractal types provided
  27. - Unlimited number of fractal types using the flexible formula editor
  28. - Dual color system (even color / odd color)
  29. - Three button mouse supprt
  30. - Cursor key support
  31. - Coordinates can be loaded from and saved to disk
  32. - Many coord files provided
  33.  
  34.  
  35.  
  36. Requirements
  37. ============
  38.  
  39. To run Benoit you need:
  40. - an Amiga
  41. - a 68020/030/040/060 processor
  42. - some kind of FPU (68881/2 or 68040/060)
  43. - CyberGraphX V2.0 or greater
  44. - Kick 3.0 or greater (might run on Kick 2.0 - not tested)
  45.  
  46.  
  47.  
  48. Installation
  49. ============
  50.  
  51. Just copy the file Benoit anywhere you like. If you want to use the PowerUP
  52. features, copy the file Benoit.elf into the same directory as Benoit (Benoit
  53. tries to load PROGDIR:Benoit.elf).
  54. Copy the coordinate files directory into the same directory as Benoit (Benoit
  55. loads from PROGDIR:Coords as default).
  56.  
  57. Make sure that you have the following libraries in your LIBS: path:
  58. - asl.library v38+
  59. - cybergraphics.library v40+ (or cgxsystem.library, as that one creates
  60.   cybergraphics.library)
  61. - gadtools.library v38+ (should be in the ROM)
  62. - gtlayout.library v38+
  63. - ppc.library v44+ (only if you have a PowerUP card installed)
  64.  
  65.  
  66.  
  67. The User Interface
  68. ==================
  69.  
  70. When started from a 15/16/24bit Workbench, Benoit opens its windows on the
  71. Workbench screen. Otherwise, it lets the user select a screen mode and opens a
  72. 15/16/24bit screen.
  73. Two windows should be opened then, a display window and a user interface window.
  74. In the user interface window, the following elements should pop up:
  75.  
  76. CPU
  77. ---
  78. The CPU to be used. Currently supported are M68k and PPC :^)
  79.  
  80. Fractal type
  81. ------------
  82. The fractal type to be calculated. This directly corresponds to the Formula and
  83. Style settings. Currently supported:
  84. - Mandelbrot    the well-known Mandelbrot set
  85. - Julia         the well known Julia sets
  86. - Dragon        \
  87. - Salamander     \ some less knwon fractals, each
  88. - Meteors        / having different characterisms
  89. - Pearls        /
  90. - Formula       a user-defined formula
  91.  
  92. Formula
  93. -------
  94. The rendering formula. It shows the formula when using one of the predefined
  95. fractal types. If you edit the formula, fractal type is changed automatically to
  96. Formula. See below for details on how an expression has to look like.
  97.  
  98. Style
  99. -----
  100. This sets one of the two possible styles: Mandelbrot or Julia.
  101. - Mandelbrot means that c is set according to the current position in the
  102.   window. x seed and y seed are ignored.
  103. - Julia means that c is set to the value specified in x seed and y seed. Set
  104.   these variables to a value other than 0.0 if you want to see more than a
  105.   filled black circle.
  106.  
  107. Exponent
  108. --------
  109. This corresponds to the "n" value in some of the formulas. It is currently
  110. restricted to the range from 2 to 16. Though normally used as the exponent in
  111. the formulas, it might be used as a multiplier as well.
  112.  
  113. Max iter
  114. --------
  115. The maximal number of iterations, which is proportional to the calculation time.
  116. So don't exaggerate :o)
  117.  
  118. Even color
  119. ----------
  120. Color offset for the even iterations (0, 2, 4, 6, ...).
  121. 0 = red         1 = yellow      2 = green
  122. 3 = cyan        4 = blue        5 = purple
  123.  
  124. Odd color
  125. ---------
  126. Color offset for the odd iterations (1, 3, 5, 7, ...).
  127.  
  128. Color repeat
  129. ------------
  130. This value defines the number of colors. Normally, this should be the same as
  131. Max iter. But as Max iter increases, the color difference between two iteration
  132. levels decreases. When it gets too smooth, the user might want to adjust it by
  133. setting this value to somewhat lower than Max iter.
  134.  
  135. Coordinates (right side of the GUI)
  136. -----------
  137. The point given by (xmin, ymin) specifies the top left point of the image, the
  138. point given by (xmax, ymax) specifies the bottom right one. If values are
  139. exchanged (for example, if xmax < xmin), they are corrected automatically.
  140. Note that x always corresponds to the real part of the complex number while y
  141. always corresponds to the imaginary part.
  142.  
  143. Calculate
  144. ---------
  145. Start the fun!
  146.  
  147. Load coords
  148. -----------
  149. Load a coordinate file from disk. The default path is PROGDIR:Coords. Note that
  150. coordinate file names should always end with .coords.
  151.  
  152. Save coords
  153. -----------
  154. Save the current coordinates to disk. All values except for CPU type and window
  155. size are stored.
  156.  
  157. Reset
  158. -----
  159. Resets x min, y min, x max and y max to their default values. Note that x seed
  160. and y seed don't get touched.
  161.  
  162. Quit
  163. ----
  164. Just quit, no requesters.
  165.  
  166.  
  167.  
  168. Window control
  169. ==============
  170.  
  171. Mouse control:
  172. - Use the left mouse button to zoom in
  173. - Use the right mouse button to zoom out
  174. - Use the middle mouse button to pick x seed and y seed
  175.  
  176. Key control:
  177. - Use the cursor keys to move
  178.   (Note: not optimized, the image is completely recalculated)
  179. - Use '.' to zoom in
  180. - Use ',' to zoom out
  181. - Use 'q' to quit
  182.  
  183.  
  184. The Formula Editor
  185. ==================
  186.  
  187. Each expression has to look like this:
  188.  
  189. (a#b)
  190.  
  191. where a and b are expressions or variables and # is an arithmetic operator.
  192.  
  193. Operators provided:
  194. -------------------
  195. +, -, *, /, ^
  196.  
  197. Variables provided:
  198. -------------------
  199. z       the complex number z (iterator)
  200. c       the complex number c (constant)
  201. i       the imaginary constant i
  202. n       the natural number n (taken from Exponent)
  203. x       the real part of z
  204. y       the imaginary part of z
  205. a       the real part of c
  206. b       the imaginary part of c
  207.         any positive number, real or natural
  208.  
  209. negative numbers have to be created by subtracting from 0.0:
  210. (0.0-1.0)
  211.  
  212. Examples
  213. --------
  214. Ok:
  215. (a+b)
  216. (a+(b+c))
  217. ((a+b)+c)
  218. ((z^2)+c)
  219. (5*(z+2))
  220.  
  221. Wrong:
  222. a+b             no parenthesis
  223. (a)             variables must not be in parenthesis
  224. (((a+b))        missing parenthesis
  225.  
  226.  
  227.  
  228.  
  229.