home *** CD-ROM | disk | FTP | other *** search
/ Computer Buyer 1996 June / BUYER_696.iso / features / fractal / fran / fran.doc < prev    next >
Text File  |  1994-03-04  |  8KB  |  192 lines
  1. FRactal ANimator 1.02 Copyright (C) 1993,94 by Ray Waldin. All rights reserved.
  2. -------------------------------------------------------------------------------
  3. Internet: rayw@netcom.com                                Compuserve: 73632,3121
  4.  
  5.  
  6.  
  7. Section 1 - Overview
  8. ====================
  9.   FRAN.EXE is a DOS based Fractal Animator capable of creating FLC animations
  10.   of the Mandelbrot and Julia set fractals. It requires an 80386 or higher and
  11.   an 80387 or higher numerical coprocessor. If your system does not have the
  12.   required equipment, FRAN will immediatley exit with an appropriate error
  13.   message. See Section 7 below for a complete list of error messages.
  14.  
  15.  
  16. Section 2 - Usage
  17. =================
  18.   FRAN <FracType> <ParFile> <FLCFile> [<XRes> [<YRes>]]
  19.  
  20.     <FracType> indicates which type of fractal you wish to generate. Only
  21.       the first letter of the fractal type is required. The four choices are
  22.       "m" for Mandelbrot set fractals, "j" for Julia set fractals, "z" for
  23.       ZC plane fractals, or "c" for CZ plane fractals.
  24.  
  25.     <ParFile> specifies the parameter file to read. Parameter files contain
  26.       two or more entries with keyframe values for the animation. See
  27.       Section 3 below for a detailed description of parameter files.
  28.  
  29.     <FLCFile> is the filename of the FLC animation to create. Also, FRAN
  30.       creates temporary image files using all but the extension; it
  31.       substitutes a hexidecimal extension for temporary image files. If FRAN
  32.       is interrupted, the user must delete these temporary image files.
  33.  
  34.     <XRes> is the optional animation width, in pixels. If ommited, a default
  35.       of 320 is assumed.
  36.  
  37.     <YRes> is the optional animation height, in pixels. If ommited, a
  38.       default of 200 is assumed.
  39.  
  40.  
  41. Section 3 - Parameter Files
  42. ===========================
  43.   Each parameter file entry is formatted as follows:
  44.  
  45.     FrameNumber { KeyFrameField KeyFrameField ... }
  46.     FrameNumber { KeyFrameField KeyFrameField ... }
  47.     ...
  48.  
  49.   FrameNumber must be between 1 and 4096, and all entries in the file must be
  50.   sorted in ascending order. A FrameNumber with a lower value than the
  51.   preceeding one will cause an error.
  52.  
  53.   KeyFrameValues are a series of Identifier=Value entries within the curly
  54.   braces "{}". Excessive whitespace (<SPACE>, <TAB>, <CR>, etc) is ignored;
  55.   each entry may span several lines. A backslash "\" followed immediately be a
  56.   <CR> and more whitespace is ignored, allowing a single floating point value
  57.   to span several lines itself. See section 5 for some sample parameter file
  58.   entries. The Identifiers and their possible values are:
  59.  
  60.     corners=#/#/#/#  The area of the fractal to generate. This is read as
  61.                      four floating point numbers, each one separated by a
  62.                      slash "/" character. The first two values indicate the
  63.                      left and right side of the fractal, and the last two
  64.                      indicate the top and bottom. If this entry is not
  65.                      found, a default of -2.5/1.5/-1.5/1.5 is assumed.
  66.  
  67.     params=#/#       Fractal type specific parameters. For standard
  68.                      Mandelbrot set animations, this entry should be set to
  69.                      0/0. For other fractal types, params should be set to
  70.                      the desired parameters. These values are read as
  71.                      floating point numbers separated by a slash "/"
  72.                      character (the first value as the real component of a
  73.                      complex number and the second as the imaginary
  74.                      component). If this entry is not found, a default of
  75.                      0/0 is assumed.
  76.  
  77.     maxiter=#        Maximum iterations. This value is read as an unsigned
  78.                      integer specifying the maximum number of iterations to
  79.                      perform for each pixel value. The higher this value is,
  80.                      the longer it takes to draw those portions of the image
  81.                      which do not bailout. If this entry is not found, a
  82.                      default of 255 is assumed.
  83.  
  84.  
  85. Section 4 - FRACTINT
  86. ====================
  87.   FRAN's parameter file format is based on FRACTINT's .PAR file. FRAN,
  88.   however, has special requirements for .PAR files used as keyframe
  89.   parameters. First, FRACTINT's .PAR file entry name is used by FRAN as the
  90.   keyframe's frame number. Furthermore, if a .PAR file entry is found with a
  91.   non-numeric name, or a numeric name is found out of order, an error message
  92.   is returned.  Also, most .PAR file fields are ignored. Only CORNERS, PARAMS,
  93.   and MAXITER are actually used by FRAN. The TYPE field is ignored because it
  94.   doesn't make any sense to indicate the fractal type for each frame. FRAN
  95.   uses the <FracType> command line parameter to determine the type of fractal
  96.   to generate.
  97.  
  98.   To create a FRAN parameter file using FRACTINT, just generate the starting
  99.   image, then press 'b' to save the image parameters to a FRACTINT .PAR file.
  100.   Enter the .PAR filename you wish to create. For entry name, type 1. Zoom,
  101.   pan, or change the fractal image's parameters and repeat the above steps,
  102.   using a higher number for .PAR entry name than used previously. In this way,
  103.   you can use FRACTINT as FRAN's graphical user interface. Remember,
  104.   FRACTINT's .PAR entry name is used as FRAN's keyframe frame number. If
  105.   needed, edit the .PAR file to modify the parameters, using FRACTINT's '@'
  106.   command to check the modified entries. Also, the entries MUST be sorted in
  107.   ascending order.
  108.  
  109.  
  110. Section 5 - Examples
  111. ====================
  112.  
  113.   a) Command line examples:
  114.  
  115.        FRAN m mandel.par mandel.flc 640 480
  116.  
  117.          This example will generate a Mandelbrot set animation using the
  118.          parameters found in MANDEL.PAR, writing the output to a 640x480
  119.          resolution flic called MANDEL.FLC.
  120.  
  121.        FRAN j julia.par julia.flc
  122.  
  123.          This example will generate a Julia set animation using the
  124.          parameters found in JULIA.PAR, writing the output to a 320x200
  125.          resolution flic called JULIA.FLC.
  126.  
  127.  
  128.  
  129.   b) Parameter file examples:
  130.  
  131.        DEEPC.PAR
  132.        ---------
  133.  
  134.          1   { corners=-2.5/1.5/-1.5/1.5 maxiter=256 }
  135.  
  136.          120 { corners=0.370253095788884/0.370253120359369/0.67149258574\
  137.                4286/0.671492604654078 maxiter=2048 }
  138.  
  139.        XMASTREE.PAR
  140.        ------------
  141.  
  142.          1   {
  143.                corners=-2/2/-1.5/1.5
  144.                params=0.5/0 maxiter=255
  145.              }
  146.  
  147.          30  {
  148.                corners=-2/2/-1.5/1.5
  149.                params=-2.0/0.0 maxiter=255
  150.              }
  151.  
  152.  
  153. Section 6 - Registration
  154. ========================
  155.   If you wish to receive a registered copy of FRAN, sample parameter files,
  156.   technical support, and information on upgrades as they become available,
  157.   send your name, address, and a check or money order for US$35.00 to:
  158.  
  159.           Ray Waldin              Telephone: 310.826.4163
  160.           1316 Carmelina #7       Internet: rayw@netcom.com
  161.           LA, CA 90025-1975       Compuserve: 73632,3121
  162.  
  163.  
  164. Section 7 - Error Messages
  165. ==========================
  166.   "80386 or higher microprocessor required!"
  167.   "80387 or higher numerical coprocessor required!"
  168.   "Unknown animation type: <FracType>!"
  169.   "FLC filename over 80 characters: <FLCName>!"
  170.   "Cannot find specified .PAR file: <ParFile>!"
  171.   "Cannot allocate memory for .PAR entry!"
  172.   "End-of-file within .PAR file entry!"
  173.   "Frame number missing in .PAR file!"
  174.   ".PAR file empty!"
  175.   "An ANIMATION requires more than one frame!"
  176.   "Frame out of order: <FrameNumber>!"
  177.   "Frame Number over 4000!"
  178.   "Cannot allocate memory for Frame Row data!"
  179.   "Cannot open temporary Frame data file: <TempFile>!"
  180.   "Cannot allocate memory for temporary filename!"
  181.   "Cannot write to temporary file: <TempFile>!"
  182.   "Cannot read temporary file: <TempFile>!"
  183.   "Cannot open .FLC file: <FLCFile>!"
  184.   "Cannot write .FLC Header: <FLCName>!"
  185.   "Cannot update .FLC Header: <FLCName>!"
  186.   "Cannot write .FLC Frame Header: <FLCName>!"
  187.   "Cannot write .FLC Chunk Header: <FLCName>!"
  188.   "Cannot write .FLC Palette: <FLCName>!"
  189.   "Cannot write to .FLC file: <FLCName>!"
  190.   "Cannot allocate memory for Flic Row data!"
  191.   "Undefined status code ##!"
  192.