home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / graphics / polydraw_1 / ReadMe < prev   
Text File  |  1997-08-31  |  12KB  |  294 lines
  1.                      !PolyDraw (Demo Version)
  2.   'Fortran Friends', P.O.Box 64, Didcot, Oxon, OX11  0SE
  3.               telephone:  +44  (0)  1235  834357
  4.  
  5. Introduction
  6.     !PolyDraw is an interactive program which displays a polyhedron in 2
  7. forms, a 3D solid and a planar net from prestored datafiles.   The full
  8. version allows you to save Draw files of the 3D solids and planar nets; you
  9. cannot save any files with this demo version and can only use the supplied
  10. datafiles.
  11.  
  12. Machine and operating system requirements: Any Acorn computers using RISC-OS
  13. operating systems: 3.XX, including networks and StrongARM.
  14.  
  15. Copyright and copying: 
  16. This program remains the copyright of 'Fortran Friends'; this demo version
  17. is given to you on the understanding that if you give a copy to anyone else
  18. you will copy all the files, unchanged, including this one.
  19.  
  20. To get the Full Version:
  21.  
  22.  Send a cheque for £20 payable to 'Fortran Friends' at the address above. 
  23.  
  24.   With the full version you can:
  25.  
  26.   1. Save diagrams as 'Drawfiles' or to !Draw for printing and combining
  27.      with others.
  28.   2. Use more datafiles: 140 are included in the distribution.
  29.   3. Use your own new datafiles.
  30.   4. Read more documentaion (see contents of full version directory Docs
  31.      below)
  32.   5. Send us suggestions for improvements and report problems which we will
  33.       try to correct.
  34.  
  35. --------------------------------------------------------------------
  36.                       Contents of the !PolyDraw Demo Disc
  37.                        
  38. Top level directory
  39.  
  40.   !PolyDraw demonstration application
  41.   Products - software available from Fortran Friends
  42.   Calend98 - a dodecahedron for you to make into a 3D model calendar for 1998
  43.   ReadMe (This file)
  44.  
  45.   Within the !PolyDraw application, in addition to the usual files, 
  46.    there are the following sub-directories:
  47.    'DatX' containing the 20 example data files acceptable to this
  48.           demonstraion version
  49.    'Docs' with two examples and a 'Glossary' of terms
  50.    'PolyLists' with the only acceptable index of polyhedra
  51.    'Resources' with files used by the program
  52.        
  53. The rest of this file is the 'ReadMe' from the full version.
  54.  
  55. **************************************************************************
  56.           ReadMe for  !PolyDraw 
  57.            updated 25 Aug 1997
  58.  
  59. Introduction
  60.  !PolyDraw is an interactive program which displays a polyhedron
  61. in two forms, as a 3D solid and as a planar net, from prestored data files.
  62. It is written the Fortran programming language by:
  63.  
  64.  'Fortran Friends', P.O.Box 64, Didcot, Oxon OX11 0TH
  65.  
  66.    tel: (01235) 834357
  67.  
  68. Machine and operating system requirements: 
  69.  
  70. Any Acorn computers using RISC-OS operating systems 3.XX, including networks
  71. and StrongARM.
  72.  
  73. Copyright and copying:
  74.  
  75. Further details can be found in the file Docs.CopyRight.
  76. This program remains the copyright of 'Fortran Friends': it is licensed to
  77. you for single use only; you may copy it to a backup floppy disc or to your
  78. own hard disk but giving copies to others is illegal.   Your registration
  79. number is unique; any illegal copies found will be reported to the
  80. 'Federation Against Software Theft' and you will be liable for prosecution. 
  81.  
  82. Getting Started:
  83.  
  84. These instructions assume some knowledge of how to use an Acorn computer. 
  85. If you are a new user, more detailed instructions on how to copy files, use
  86. the windows and the mouse can be found in the 'User Guide' manual for your
  87. computer system. !PolyDraw is a RISC-OS compliant program which runs in the
  88. Acorn Desktop and tries to conform to the operating conventions in the Acorn
  89. Style guide; it supports Acorn interactive help.
  90.  
  91. Fortran Friends welcome comments and requests for new features for future
  92. versions of this program. 
  93.  
  94. --------------------------------------------------------------------
  95.                       Contents of the !PolyDraw Disc
  96.  
  97. This section is for reference only, you may never need to use it if you just
  98. want to use the supplied data files, plot them in various ways and save the
  99. diagrams as Draw files. All Draw files on the distribution disc have been
  100. compressed using the standard 'Squash' program.
  101.  
  102. Top level directory
  103.  
  104.   !PolyDraw application
  105.   Calend98 - a Draw file of a dodecahedron with a calendar for 1998
  106.   Products - software available from Fortran Friends
  107.   ReadMe (This file)
  108.  
  109. Skip to the section headed 'Installation' if this is the first time you have 
  110. looked at this file, and you are not interested in technicalities.
  111.  
  112.    Within the !PolyDraw application, in addition to the usual files, 
  113.    there are several directories, (listed below in alphabetical order of
  114.    directory name):
  115.  
  116.   Directories Dat*
  117.    These contain files of polyhedron data  (see Docs.DataDirs for details)
  118.  
  119.   Directory 'Docs' contains:
  120.  
  121.    Text files
  122.      BooKits    - suggested reading, and suppliers of model kits
  123.      CopyRight  - a statement of 'Fortran Friends' copyright
  124.      DataDirs   - a description of the contents of the Data directories
  125.      FaultRep   - a form for you to return if you find any problems
  126.      FormData   - a definition of the format of the data files
  127.      FormOpts   - a definition of format of the Choices file in Resources
  128.      FormPlist  - a definition of format of the Polylist file in PolyLists
  129.      FormTitle  - a definition of format of the Titles file in PolyLists
  130.      Glossary   - a text file defining terms associated with polyhedra
  131.      NewOnes    - advice on how to add a new polyhedron of your own.
  132.      Versions   - record of the differences between versions of !PolyDraw
  133.      WishList   - current planned enhancements for !PolyDraw
  134.  
  135.     Draw files
  136.      Defn      - a Draw file with an explanatory diagram showing some
  137.                     of the terms used in 'Glossary'
  138.      DrawEx1   - shows the range of display forms which can be saved into
  139.                     a Draw file from !PolyDraw
  140.      Stereo    - an example of a side by side stereo pair, 
  141.                    which can be seen as 3D if you can defocus your eyes
  142.      ToolsExpl - an explanation of the icons in the tools pane
  143.  
  144.   Directory 'PolyLists' contains the files which make your list of
  145.     possible polyhedra to plot. Each file has the reference number
  146.     of the 'Dat' directory, the file name, the polyhedron name and
  147.     information used by the 'select' window if you want to restrict
  148.     the number of possible polyhedra to plot.
  149.  
  150.     'PolyList' lists polyhedra separated into types separated by headings
  151.     'PolyListA' same polyhedra but listed in alphabetical order of name
  152.  
  153.   Directory 'Resources'
  154.     In addition to the usual Acorn files, Messages and Templates,
  155.     there are several other files, which the program may change for you,
  156.     but which most users need not bother with.
  157.  
  158.     'Choices' defines the initial settings and filenames to be read,
  159.               for example as the initial 'Polylist'.
  160.     'Colours' defines all the colours used initially. The program can
  161.               change this file if the user changes the colours and then
  162.               asks to save the 'Colours' file before quitting the program.
  163.     'DefCols' this is the default 'Colours' file, initially it is the same
  164.               as 'Colours'. To reset an updated 'Colours' file to the
  165.               original colours, manually copy 'DefCols' to 'Colours'.
  166.     'Register'this file contains your name and registration information.
  167.               It must not be changed by the user.
  168.     'ToolSp3D'sprites used in the tools pane of the 3D display window.
  169.  
  170.   Directory 'TryThese' contains
  171.  
  172.      Activities - some suggested activities for you to try when you
  173.                   get bored with just looking at the polyhedra, 
  174.                   rotating them, and saving them as Draw files and 
  175.                   want to know a bit more about how they are related
  176.                   to one another.
  177.      Answers  - the answers to the questions in 'Activities'
  178.                 (Try not to look at these until after you have
  179.                  tried them for some time yourself!)
  180.      Squashed Draw files - 'Sheetn' and 'Answern' which are part of
  181.      the 'Activities' and answers 
  182.  
  183.       We should be most grateful for suggestions for further activities,
  184.       or copies of new ones to pass on to other users. 
  185.  
  186.       Please send yours to 'Fortran Friends' at the address above.
  187.     
  188.  --------------------------------------------------------------------
  189.  
  190. Installation:
  191.  
  192. 1. Make a working copy on floppy disc. Store the original safely, in case
  193. your working copy becomes damaged. Your license allows you to make a
  194. single copy for your own use. If the disc supplied has been damaged and
  195. will not copy, return it to us for a free replacement within 3 months of
  196. purchase.
  197.  
  198. Use the 'working' copy for the rest of the instructions. You can run from
  199. the floppy if you want to.
  200.  
  201. 2. Installation on hard disc: 
  202. Make yourself a directory for storing your programs, with
  203. a name such as 'Polyhedra' and copy the contents of the floppy disc to it.
  204.  
  205. 3. Read the Documentation. 
  206. Before trying to run the application, look at the file !Help file for
  207. operating instructions, in the sub-directory 'TryThese' for some
  208. suggested activities, and in the sub-directory 'Docs' for a glossary of 
  209. terms and some example Draw files.  You may want to print these out for 
  210. future reference.
  211.  
  212. 4. Operating instructions:
  213. Running instructions are in the file !Help of the application; 
  214. Acorn interactive help is supported.
  215.  
  216. 5. Starting the program:
  217.  
  218. Double-click on the application !PolyDraw to start the program; this loads
  219. an icon on to the icon bar and shows the default list of polyhedra you can
  220. plot. Click MENU when the pointer is over this icon to see the options. 
  221. Choose 'info' to see the program name, version number and your registration
  222. number, which should be quoted in any correspondence with 'Fortran Friends'.
  223. Click SELECT to see the default list of polyhedra you can plot.
  224.  
  225. 6. Stopping the program:
  226.  
  227. Click MENU over the icon on the icon bar and choose the last option, 'quit'.
  228. If windows are hiding the icon bar, press key f12 while holding down the
  229. SHIFT key, to bring the icon bar to the front of the windows.
  230.  
  231. 7. Colour Changing:
  232. You can change the colour used for particular faces of a polyhedron in some
  233. of the display forms. If you try to do this and get an error message saying
  234. 'Colour Picker module is not loaded', then if you have a copy of the Acorn
  235. Colour Picker Module load it using commands as described in the !Run file.
  236. If you have not got this module you can get it off the Acorn User Cover Disc
  237. for September 97 or send a blank disc plus return envelope and postage to
  238. 'Fortran Friends' at the address above.
  239.  
  240. 8. Displaying your own data files:
  241.  
  242. The format of the data files is defined in the file Docs.FormData which
  243. lists all the possible lines of the file. You need not make all the lines,
  244. but the first line must have the string ':name ' as the 1st 6 characters,
  245. and the last line must begin ':end '.  The vertices must be described in
  246. clockwise direction for each face as they are seen from inside the
  247. polyhedron. If they are not, the results are unpredictable, usually, the
  248. face is missing from the 3D plot. 
  249.  
  250. For example:
  251.  
  252. :name my new cube
  253. :comment designed by me on 22 June 97
  254. :solidf 6 4
  255. 4 1 2 3 4 1
  256. 4 4 5 6 1 2
  257. 4 2 1 6 7 7
  258. 4 8 3 2 7 5
  259. 4 8 5 4 3 3
  260. 4 6 5 8 7 4
  261. :solidv 8
  262. 0  0.8 0.58
  263. -0.8 0 0.58
  264. 0 -0.8 0.58
  265. 0.8 0 0.58
  266. 0.8 0 -0.58
  267. 0 0.8 -0.58
  268. -0.8 0  -0.58
  269. 0 -0.8 -0.58
  270. :end
  271.  
  272.  
  273. 9. Possible Faults:
  274.  
  275. Error conditions we have thought about have 'traffic sign' windows which
  276. should allow you to choose whether to stop the program or try to carry on.
  277.  
  278. If your working disc is damaged, you may find when you try to start the
  279. program you merely get an 'error window' saying your user registration file
  280. has been corrupted. Delete all the files from your working disc, and make a
  281. new copy from your original disc. 
  282.  
  283. If you find the program stops in an uncontrolled way, please try to write
  284. down details of what you were doing just before the error, and send them to
  285. us, preferably using the fault report form in file !PolyDraw.Docs.FaultRep. 
  286.  
  287. If you have changed any of the !PolyDraw files, or the fault is in reading a
  288. new polyhedron of your own, please check carefully that you have listed the
  289. face vertices in the correct order before contacting us. The usual symptom
  290. of this is that the face with incorrect vertices is not plotted in the 3D
  291. window.  Please supply copies of the files on floppy disc which you were
  292. using when the error occurred.
  293.  
  294.