home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d545 / drawmap.lha / DrawMap / DrawMap3.1.doc < prev    next >
Text File  |  1991-09-18  |  10KB  |  240 lines
  1.                                  Drawmap
  2.  
  3.                                Version 3.1
  4.  
  5.        A program for drawing representations of the Earth's surface.
  6.  
  7.                                     by
  8.  
  9.                          Bryan Brown & Ulrich Denker
  10.  
  11.                                  09/08/91
  12.  
  13.  
  14. I. Abstract
  15.  
  16. This program gives the user the ability to generate representations of the
  17. Earth's surface, including national boundaries.  Representations such as a
  18. Mercator projection, hemispherical views, and orbital views can be generated.
  19. The user has full control of the 16-color palette, with user specified colors
  20. for flood fills, line drawing and text.  Screens can be printed or saved to
  21. disk as standard IFF files.  A fully user-configurable online help facility
  22. is also provided.
  23.  
  24.  
  25. II. Disclaimer
  26.  
  27. No guarantee is made as to the accuracy of the national boundaries
  28. represented by this product.  Recent political events have already made the
  29. map file out of date.
  30.  
  31.  
  32. III. Distribution
  33.  
  34. As with version 1.0 (on Fish disk 229), Version 2.0 (on Fish disk 315), and
  35. Version 2.24d (on Fish disk 485), this program is released into the public
  36. domain (FREEWARE), and is freely distributable as long as this document file,
  37. source code, header files, binary files, IFF file and text files are included
  38. in their entirety.  The source may be modified for personal use, but is NOT
  39. for commercial use.  The program was originally developed with Aztec C
  40. version 3.6a.  The enhancements that lead to Version 2.24 were compiled with
  41. the SAS (Lattice) C compiler V5.10.  The modifications resulting in version
  42. 3.1 were again compiled with Aztec C version 3.6a.
  43.  
  44.  
  45. Files included:
  46.  
  47.      drawmap3.1                  - executable code
  48.      drawmap3.1.info             - icon file for workbench users
  49.      drawmap3.1.020              - executable code requiring at least a 68020
  50.                                    CPU and 68881 FPU
  51.      drawmap3.1.020.info         - icon file for workbench users
  52.      drawmap3.1.info             - icon file for workbench users
  53.      drawmap3.1.doc              - documentation file
  54.      drawmap3.1.doc.info         - icon file for workbench users
  55.      drawmap.c                   - source code
  56.      drawmap.h                   - header file
  57.      drawmap-help.h              - header file for help option
  58.      drawmap-menu.h              - header file for menu selections
  59.      drawmap-req.h               - header file for string requester
  60.      reqglue.asm                 - glue file for accessing req.library
  61.                                    (from Fish disk 419, where the object
  62.                                    file is named areqglue.o)
  63.      reqbase.h                   - header file for accessing req.library
  64.                                    (from Fish disk 419)
  65.      ILBM_lib.h                  - header file for accessing ilbm.library
  66.                                    (from Fish disk 463)
  67.      IlbmInterface.asm           - interface file for accessing ilbm.library
  68.                                    (from Fish disk 463)
  69.      map.bin                     - map file containing 84,800 points
  70.      map-trig.bin                - auxiliary file containing packed values
  71.                                    for trig functions of the latitude of
  72.                                    each point in map.bin
  73.      map.config                  - configuration file containing user
  74.                                    palette
  75.      map.limits.bin              - auxiliary file containing max and min
  76.                                    values of latitude and longitude for
  77.                                    each arc in map.bin
  78.      map.flat.pic                - IFF file containing a flat map for
  79.                                    initial display
  80.      drawmap.help                - simple text file containing help
  81.                                    information for each menu item
  82.      req.library                 - library for general requesters
  83.                                    (from Fish disk 419)
  84.      ilbm.library                - library for saving IFF pictures
  85.                                    (from Fish disk 463)
  86.      make3.1                     - simple batch file for building the
  87.                                    executable code
  88.      Reqlibrary.lzh              - compressed version of Reqlibrary
  89.                                    materials from Fish disk 419
  90.      ilbm.lzh                    - compressed version of ILBMLibrary
  91.                                    materials from Fish disk 463
  92.      InstallLibs                 - simple batch file for installing
  93.                                    req.library and ilbm.library into
  94.                                    the user's LIBS: directory
  95.      InstallLibs.info            - icon file for workbench users
  96.  
  97.  
  98. IV. Differences from version 2.24
  99.  
  100.     o Now requires 1.2 megabytes of memory
  101.  
  102.     o Requires req.library (from Fish disk 419) and ilbm.library (from 
  103.       Fish disk 463)
  104.  
  105.     o 16 colors available instead of 4, with full palette control
  106.       via req.library
  107.  
  108.     o User option to save palette in configuration file
  109.  
  110.     o Auto-load of user palette from configuration file at program
  111.       startup
  112.  
  113.     o User option to load default palette
  114.  
  115.     o User selection of colors for flood fills, lines, and user-selected
  116.       text via menu options
  117.  
  118.     o Auto-load of a flat map IFF at program startup
  119.  
  120.     o File requester from req.library, thereby eliminating the need for the
  121.       ARP library and the associated inline code
  122.  
  123.     o Redesigned Help option, with a separate Help entry for each menu
  124.       item using features from req.library.  Text for Help entries is stored
  125.       in a separate text file, which can be fully modified by the user.
  126.  
  127.     o Maps saved to disk using ilbm.library rather than inline code
  128.  
  129.     o MUCH larger map file containing more detail as well as national
  130.       boundaries
  131.  
  132.     o No automatic flood fills
  133.  
  134.     o Close screen gadget removed, replaced by menu selection
  135.  
  136.     o Redesigned, less obtrusive "busy" mouse pointer
  137.  
  138.     o Title bar may be toggled on and off
  139.  
  140.     o Faster user selection of an area for a Box view and the center point
  141.       for a Globe and Orbital view, using the blitter to move a previously-
  142.       generated flat map into view
  143.  
  144.     o New Box Zoom In and Box Zoom Out options for exploring small regions
  145.       more efficiently
  146.  
  147.     o User-selectable view height for Orbital view
  148.  
  149.     o General tightening and cleaning up of the source code
  150.  
  151.     o Compiled with Aztec C v. 3.6a, since I do not own SAS (Lattice) C.
  152.       
  153.       
  154.       
  155. V. Notes
  156.  
  157.     o To build the program from source, the user will first have to assemble
  158.       the files reqglue.asm and ILBMInterface.asm to generate areqglue.o and
  159.       ilbminterface.o, respectively.  The batch file "make3.1" may then be
  160.       executed to build the actual executable program.  (The reqglue object
  161.       file is named "areqglue.o" instead of "reqglue.o" to signify that the
  162.       file is for Aztec C, and not SAS (Lattice) C.  On Fish disk 463 the SAS
  163.       (Lattice) object file is named "lreqglue.o".)
  164.  
  165.     o For those users (including myself) who prefer pop-up menus to the
  166.       standard Amiga menus, try the pop-up menu system on Fish disk 422. 
  167.       This background program (apparently) works with any normal program that
  168.       uses standard Amiga menus.
  169.  
  170.     o The sheer size of the new map file unavoidably results in slower
  171.       drawing of the maps.  The auxiliary files were developed to speed up
  172.       the drawing, but drawing is still slower than would be ideally
  173.       desirable.  Unfortunately, the size of these files also means that the
  174.       program will no longer run in 500k.  Note that the national boundaries
  175.       in the map file do NOT reflect the currently changing political
  176.       situation.
  177.  
  178.     o The map file contains 1409 different arcs defining region boundaries,
  179.       but region boundaries are not defined by contiguous arcs in the map
  180.       file.  This means that a closed region may not be completely outlined
  181.       all at once, thus eliminating the ability to automatically flood fill
  182.       at the end of an arc.  In any case, the user would probably want
  183.       different colors for adjacent regions anyway.
  184.  
  185.     o The map file as originally obtained contained gaps in the boundaries,
  186.       e.g., not all islands were closed figures, continental outlines
  187.       consisted of disconnected arcs, etc.  Considerable effort was spent
  188.       trying to ensure closure of all areas, but a few may have been missed. 
  189.       In addition, some of the boundaries extend beyond where they should
  190.       end, resulting in unterminated lines extending into blank areas when
  191.       viewed in detail.  An inordinate amount of effort would be required to
  192.       correct these outliers, considering the nature and intended use of this
  193.       program.  
  194.  
  195.     o The text for each help entry may be modified by the user using any
  196.       normal text editor.  Note that the Help entries MUST remain in the
  197.       original order, or else the help text will not match the Help gadget
  198.       name.
  199.  
  200.     o Each entry in the help file MUST remain delimited by a form feed
  201.       character (12 hexadecimal).  At program startup the program reads the
  202.       help file and looks for the formfeed character, replacing it with 0
  203.       hexadecimal (the normal end-of-string character in C).  The help
  204.       display option needs this end-of-string character to function properly.
  205.  
  206.     o The file "map.limits.bin" contains upper and lower bounds on the
  207.       information in each of the 1409 arcs.  If this file cannot be found at
  208.       program startup, it is built from scratch, and an attempt is made to
  209.       save the file to disk.  Whether or not the save is successful, the
  210.       program continues.
  211.  
  212.  
  213.  
  214. VI. Limitations
  215.  
  216.     o The mouse pointers in the file requester, palette and Help item display
  217.       windows revert to the user's own mouse pointer image rather than the
  218.       arrowhead used in drawmap.  It would be beneficial if the programmer
  219.       were able to specify to req.library and ilbm.library the imagery to use
  220.       for the mouse pointer.
  221.  
  222.  
  223. VII. Correspondence
  224.  
  225. This program was originally developed by:
  226.  
  227. Bryan Brown
  228. 13129 Collingwood Terrace
  229. Silver Spring, MD 20904, USA
  230.  
  231.  
  232. Enhancements for version 2.4 were written by:
  233.  
  234. Ulrich Denker
  235. Nienort 46
  236. 4500 Osnabrück, GERMANY
  237.  
  238.  
  239. Modifications for version 3.1 were written by Bryan Brown.
  240.