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