home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 1 / AU_CD1.iso / demos / s_to_z / topograph / demohelp1 next >
Text File  |  1993-05-18  |  22KB  |  562 lines

  1.  
  2.  
  3.  
  4.  
  5.                        Topographer Demo
  6.                        ================
  7.  
  8.  
  9. *** Note ***
  10.  
  11. Certain features present on the production version of Topographer are missing
  12. from this demonstration, such as Create Map, Save, and Print.
  13.  
  14.  
  15. Overview
  16. ========
  17.  
  18. Topographer is supplied as two independent applications which may be run 
  19. separately, or concurrently. Facilities exist to ease the transfer of maps 
  20. between the two applications.
  21.  
  22. Most operations with Topogapher are intuitive to anyone familiar with 
  23. the RISC OS range of computers. However, there are some notable exceptions 
  24. and so for those people who generally do not read manuals, these 
  25. exceptions have been tagged with an exclamation mark (!).
  26.  
  27.  
  28. The first of the applications is the 2D Editor. This program is used to 
  29. create new maps and edit existing ones. 
  30.  
  31.  
  32. Using the 2D Editor
  33. ===================
  34.  
  35.  
  36.   Menu overview
  37.   -------------
  38.  
  39.   Icon bar menu                                                           
  40.   -------------
  41.  
  42.         Info            - info about program
  43.         Create map...   - create a new map *NOT IMPLEMENTED
  44.         New view...     - open a new view on a map
  45.         Close all views 
  46.         Remove map...   - remove a map from memory
  47.         Remove all maps
  48.         Preferences     - alter the application preferences
  49.         
  50.  
  51.   Document menu
  52.   -------------
  53.  
  54.         Info            - info about program
  55.  
  56.         Map             - the Map submenu
  57.  
  58.                 Info            - info about map
  59.                 Save            - save a map  *NOT IMPLEMENTED
  60.                 Save Drawfile   - save a map in Draw format *NOT IMPLEMENTED
  61.                 Print...        - print a map
  62.                 Size...         - adjust the size of a map
  63.                 Scale...                - adjust the scale of a map
  64.                 Grid...         - adjust a map's grid
  65.                 Preferences...  - adjust a map's preferences
  66.  
  67.         Edit            - the edit submenu, but choose this option
  68.                           to leave Select Mode
  69.  
  70.         Select          - the select submenu, choose this option to
  71.                           enter Select Mode
  72.  
  73.                 Select all      - select all features in
  74.                                   focus
  75.                 Clear           - deselect all features
  76.                 Show focus...   - show the focus window
  77.                 Adjust          - alter a feature's parameters
  78.                 Copy            - copy selected features to
  79.                                   clipboard
  80.                 Cut             - move selected features to
  81.                                   clipboard
  82.                 Delete          - delete selected features
  83.                 Paste           - copy features to map from
  84.                                   clipboard             
  85.                 Replicate               - replicate contours
  86.                 Front           - move lines and areas to front
  87.                 Back            - move lines and areas to back
  88.  
  89.         Zoom    - the zoom control dialogue box
  90.  
  91.         Show coords...
  92.  
  93.         Show features...
  94.  
  95.         Export to 3D
  96.  
  97.  
  98.  
  99. Types of feature (!)
  100. --------------------
  101.  
  102.   For the purposes of the editor, there are four different types of 
  103.   feature:-
  104.  
  105.         *       Symbols.  (telephone, public house, text, etc)
  106.         *       Lines.    (road, river, track, etc)
  107.         *       Areas.    (sand, woodland, water, etc)
  108.         *       Contours. (contour and open-contour)
  109.  
  110.  
  111. Creating a new map *NOT IMPLEMENTED
  112. ------------------
  113.  
  114.   To create a new map, simply click on the 2D editor icon. The scale 
  115.   dialogue box will appear. You may select a different scale if required and 
  116.   then click on 'OK'. The map document will appear.
  117.  
  118.   You may load an existing map from disk in the normal way:-
  119.  
  120.         * by dragging the file icon to the icon bar
  121.   
  122.         * by double-clicking on the file icon
  123.  
  124.  
  125. Changing the size of a map
  126. --------------------------
  127.  
  128.   The size of a map may be adjusted by choosing the 'size' option in the 
  129.   'map' submenu. You may enter the new dimensions directly, or click on the 
  130.   arrow icons to increase or decrease the size by small steps. You should 
  131.   click on 'OK' when you have chosen the new size.
  132.  
  133. Changing the scale of a map
  134. ---------------------------
  135.  
  136.   The scale of a map is adjustable by choosing the 'scale' option in the 
  137.   'map' submenu. There are a number of preset scales already present on the 
  138.   dialogue box, clicking on any of these will set the scale accordingly. You 
  139.   may enter the new scale directly, or adjust it using the arrow icons. As 
  140.   with all dialogue boxes, click on 'OK' to confirm your changes.
  141.  
  142. Changing the size and origination of the grid
  143. ---------------------------------------------
  144.  
  145.   The grid for a map is adjustable by choosing the 'grid' option in the 
  146.   'map' submenu. The size of each square is adjusted by entering the new  
  147.   value directly, or by using the arrows. The origin of the grid is also 
  148.   adjustable. This feature is used to originate the bottom left hand corner 
  149.   of a map document to a particular position on the National Grid.
  150.   
  151. Placing new features
  152. --------------------
  153.  
  154.   Placing features on a map document is very simple, but first you must 
  155.   select the feature that you wish to place. This can be done by choosing 
  156.   from the 'features' window, or from the 'features' submenu. The features 
  157.   window is summoned by choosing the 'Show Features' option on the document 
  158.   menu. The features may be scrolled using the vertical scroll bar in the 
  159.   normal RISC OS way. To select a feature, simply click upon the appropriate 
  160.   icon. A description will be displayed at the bottom of the window, along 
  161.   with any 'Parameters' pertaining to that particular feature. To adjust 
  162.   these parameters, position the caret in the white icon and enter the new 
  163.   data. Don't forget to press <Return> or click on 'OK' to confirm the 
  164.   changes. Any new feature placed after such an adjustment will be affected 
  165.   accordingly.
  166.  
  167.   The features submenu is attached to the 'Edit' option of the document 
  168.   menu. Simply summon the menu, and choose the feature that you require. 
  169.   Note that most features are grouped up into categories.
  170.  
  171.   Once you have selected your feature, you can place it on the map. The 
  172.   exact method of placement depends on the type of feature that you are 
  173.   entering. 
  174.  
  175.         * Features which are represented by a single
  176.           picture, such as the telephone symbol,
  177.           are placed simply by clicking SELECT in the desired
  178.           position on the map.
  179.          
  180.  
  181.         * Other features like roads, rivers, areas of water and
  182.           contours (to name but a few) require that you enter
  183.           a line into the map. Begin by clicking SELECT at the
  184.           starting position. Move the pointer to the next place
  185.           and click SELECT again. Each point is entered in this
  186.           way until the whole feature is completed. To finish
  187.           entry of a line, DOUBLE CLICK on SELECT. You may hold
  188.           SELECT down while moving the pointer to draw lines
  189.           'freehand'. If you click ADJUST, you will remove sections
  190.           of the line. Likewise, you may hold down ADJUST to rapidly
  191.           backtrack. Press <ESCAPE> or click MENU to abandon
  192.           a line entry.
  193.           
  194.           Once entered, the grey 'control' line is replaced by the
  195.           chosen feature.
  196.  
  197. Editing existing features (!)
  198. -----------------------------
  199.  
  200.   Line based features may be edited by clicking ADJUST near the desired 
  201.   feature. For contours, roads and rivers, etc., it is best to click 
  202.   immediately over the feature itself. For areas such as water, sand, woods, 
  203.   etc., click ADJUST at the edge of the feature. The feature will disappear 
  204.   and be replaced by the control line. At this point you have two choices:-
  205.  
  206.         * Click SELECT at either end of the control line to 
  207.           extend it in either direction. If you do this, the
  208.           editor will behave as though you were entering a
  209.           new line.
  210.  
  211.         * Click SELECT on a control point (denoted by small squares)
  212.           to re-enter a portion of the line. Now you can re-enter
  213.           a portion of the control line, so long as you 'return' to
  214.           a control point. When you click SELECT over a control point
  215.           the feature will re-appear having taken into account the
  216.           new shape. XXNote that you are not adjusting the existing portion
  217.           of the line but replacing it with a new section.
  218.  
  219.  
  220. Selecting features
  221. ------------------
  222.  
  223.   Once entered, features may be 'Selected'. To do this, you will first need 
  224.   to switch to Select Mode. The easiest way to do this is to choose 'Select' 
  225.   from the document menu a tick appears next to the menu item to 
  226.   indicate that it is selected. Features may now be selected:-
  227.  
  228.         * By clicking SELECT on or near a feature. This will
  229.           de-select any other selected features.
  230.  
  231.         * By clicking ADJUST on or near a feature. This will not
  232.           de-select affect any other features.
  233.  
  234.         * By dragging a Selection Box. If you click and
  235.           hold down SELECT well away from any features while
  236.           moving the pointer, you will create a Selection Box.
  237.           Any features within this box will become selected, and
  238.           all other features will be de-selected.
  239.  
  240.         * By dragging a Selection Box with ADJUST. This works
  241.           in exactly the same way as above, except that 
  242.           features not contained within the selection box
  243.           are unaffected. 
  244.         
  245.         * By choosing 'Select All' or 'Clear' from the Selection
  246.           submenu. When these options are chosen, all features
  247.           on a map are either selected or de-selected.
  248.  
  249.  
  250. Operations on selected features
  251. -------------------------------
  252.  
  253.   Once selected, features may then be processed in a variety of ways. They 
  254.   can be:-
  255.  
  256.         * Moved. By dragging a selected feature with SELECT, all
  257.           selected features are moved to a new position.
  258.         
  259.         * Copied. By choosing 'Copy' from the Selection submenu, or ^C
  260.           selected features are copied into the 'Clipboard'.
  261.  
  262.         * Cut. By choosing 'Cut' from the Selection submenu, or ^X
  263.           selected features are copied into the clipboard, and
  264.           are removed from the map.
  265.         
  266.         * Deleted. By choosing 'Delete' from the Selection submenu or ^K
  267.           all selected features are removed from the map, but are
  268.           not copied to the clipboard.
  269.         
  270.         * Moved to front or back. Features like rivers, sand, etc., ^F or ^B
  271.           can be moved to the 'back' or 'front' of the pile of 
  272.           features by choosing 'Front' or 'Back' from the selection
  273.           submenu.
  274.  
  275.         * Adjusted. Selected features may have their additional
  276.           information (such as width, etc.,) adjusted by choosing
  277.           'ADJUST' from the selection submenu or ^D
  278.  
  279.   Features in the clipboard can be copied back onto the map by choosing 
  280.   'Paste' from the selection submenu or ^V. The features are represented by blue 
  281.   boxes, and these can be position prior to being placed with 'SELECT'.
  282.  
  283.  
  284. The focus window (!)
  285. --------------------
  286.  
  287.   You can limit the types of feature that can be selected by using the 
  288.   'Selection focus window'. To summon this window, choose 'Show focus' from 
  289.   the selection submenu. You will notice that the four categories of feature 
  290.   are on the window, each accompanied by a switch. If this switch is on, 
  291.   then features of that type may be selected. 
  292.  
  293.  
  294. Special points about certain features (!)
  295. -----------------------------------------
  296.  
  297.   There are a number of special features which require specific attention.
  298.  
  299.         * Contours. A contour may not intersect itself, or any
  300.           other contour. If you attempt to enter a contour which
  301.           does intersect, then the editor will warn you and request
  302.           that you put it right.
  303.  
  304.         * Open contours. Open contours are the same as contours,
  305.           except that they must start and end at the edge of a map.
  306.           They are provided to allow incomplete contours to be 
  307.           entered, where a smaller map is being build from a larger
  308.           one. Open contours cannot be moved, copied or pasted
  309.           after entry.
  310.  
  311.         * Bridges, Viaducts and Aqueducts. These features are
  312.           special because they are only allowed to have two
  313.           control points, ie. they must be a straight line. In
  314.           addition, when drawing roads, tracks, etc., which
  315.           run over bridges, viaducts and aqueducts, it is necessary
  316.           to position the control points exactly. This is achieved
  317.           by pressing SHIFT when using SELECT to enter control
  318.           points. This is known as 'Snapping'. The roads, tracks, etc.,
  319.           must be snapped at both ends of the bridge. For example,
  320.           imagine you have a bridge spanning a valley, and you want
  321.           a new road to run over it. You begin drawing the
  322.           road in the normal way until you come to the bridge. 
  323.           Position the pointer close to one end of the bridge and click 
  324.           SELECT whilst holding down <Shift>. Then move the pointer to 
  325.           the other end of the bridge and click SELECT again. You can 
  326.           now finish off the road in the normal way.
  327.  
  328.         * Roads. Roads are special because they can be joined
  329.           in a specific way to create junctions. For example,
  330.           imagine you have a motorway that you wish an A road
  331.           to join with. You enter the A road until you come
  332.           to the motorway. Then you hold down CTRL and click
  333.           SELECT once (Do not double click with SELECT). A neat 
  334.           junction will be formed.
  335.  
  336.  
  337. The Zoom window
  338. ---------------
  339.  
  340.   The view of a map can be zoomed in or out by choosing the Zoom option on 
  341.   the Document menu. There are a number of preset values, or you may enter 
  342.   your own. The zoom factor is displayed on the map title bar.
  343.  
  344.  
  345. The coordinate window
  346. ----------------------
  347.  
  348.   This window, when opened, displays the grid coordinate of the mouse 
  349.   pointer.
  350.  
  351.  
  352. The preferences window
  353. ----------------------
  354.  
  355.   Most of the preferences refer to the 3D generator, but the 'Freehand 
  356.   resolution' setting may be used to adjust the 'fineness' of freehand 
  357.   lines. When maps are created, the preferences are set up according to the 
  358.   defaults specified by the preferences window attached to the icon bar. 
  359.   These are called the Application preferences. However, once created a map 
  360.   document may deviate from the application preferences freely.
  361.  
  362.  
  363. Exporting map documents *NOT IMPLEMENTED*
  364. -----------------------
  365.  
  366.   Choose 'Export to 3D' to transfer an existing map document into the 3D 
  367.   generator. If you do not have room to run both applications 
  368.   simultaneously, you will need to first save and quit the editor, and then 
  369.   load the map into the 3D generator.
  370.         
  371.  
  372.  
  373.  
  374.  
  375. Using the 3D generator *NOT SUPPLIED* - See image sequence !3D by double clicking on it.
  376. ======================
  377.  
  378.  
  379.   The 3D generator cannot create map documents, instead it relies upon those 
  380.   produced by the 2D editor. Maps can be loaded into the 3D generator by 
  381.   dragging them to the icon bar, or by exporting them from the 2D editor. 
  382.  
  383.  
  384. Menu overview
  385. -------------
  386.  
  387.   Icon bar menu
  388.   -------------
  389.  
  390.         Info                    - info about program
  391.         New view                - open a new view on a map
  392.         Close all views 
  393.         Remove map              - remove an existing map from memory
  394.         Remove all maps
  395.  
  396.   Document menu
  397.   -------------
  398.  
  399.         Save map                - save the map and all stored views  *NOT IMPLEMENTED
  400.         Preferences...          - open the map preferences window
  401.         Zoom                    - adjust the zoom
  402.         Make view               - begin generation of the current view
  403.         Show view               - open the 3D view window
  404.         View library            - the view library submenu
  405.                 Save                      - store the current view
  406.                 Recall                    - recall the specified view
  407.                 Delete                    - delete the specified view 
  408.                                             from the view store
  409.         Export to 2D            - export the map to the 2D editor
  410.  
  411.  
  412.  
  413.  
  414. The view cone and view arrow
  415. ----------------------------
  416.  
  417.   When a map is loaded it is displayed in a similar window to that used by 
  418.   the 2D editor, except that a 'view cone' and 'view arrow' are present.
  419.  
  420.  
  421.   The view cone repesents a 'cone of vision', the area covered by the cone 
  422.   is the same as the area which will be visible in the final 3D image. The 
  423.   view cone can be moved around on the map to choose different view points 
  424.   and directions.
  425.  
  426.   The view arrow is allied to the view cone in that it represents the 
  427.   direction of the 'line of sight'. When you produce a 3D image, the picture 
  428.   shown will be the same as that which you would see if you were standing at 
  429.   the base of the arrow, and looking in that direction, towards the head of 
  430.   the arrow. In addition to providing an indication of the line of sight, 
  431.   the view arrow performs another important function. 
  432.  
  433.   The base of the arrow is assumed to be the point at which the viewer is 
  434.   standing. The height of the viewer above ground level (how tall you are) 
  435.   at this point is adjustable by double-clicking ADJUST at the base of the 
  436.   arrow. 
  437.  
  438.   The head of the arrow is taken to be the point at which the viewer is 
  439.   looking. The height of the ground over which the arrowhead lies is used to 
  440.   calculate the angle of elevation of the line of sight. For example, 
  441.   imagine you are standing at the foot of a hill, with the arrow head 
  442.   pointing at the top, while the view cone covers the whole of the hill. 
  443.   With this set up, the 3D image produced will be as though you are looking 
  444.   up the hill, ie., at a point at the summit. If you now move the view arrow 
  445.   to the foot of the hill, without affecting the view cone, the image would 
  446.   be different - as though you are looking straight ahead. The height of the 
  447.   line of sight, over and above the height of the view arrow head, can be 
  448.   adjusted by double-clicking ADJUST at the arrow head.
  449.  
  450.   The view arrow can be dragged around on the map. Use SELECT at either end 
  451.   of the arrow to perform this operation. If you drag the view arrow while 
  452.   holding down the SHIFT key, then the view cone is automatically adjusted 
  453.   as well.
  454.  
  455. NOTE: If the view cone is large then the 3D image will take longer to
  456. generate and depending upon the terrain the actual image may be no different
  457. to that with a smaller cone. 
  458.  
  459.  
  460. Storing views
  461. -------------
  462.  
  463.   Once you are satisfied with a particular view position, you may store it 
  464.   along with the map. Choose the 'View Library' submenu from the document 
  465.   menu, and then choose the 'Save' option. You will be required to name the 
  466.   view. Note that the view is stored with the map - and has not been saved 
  467.   to disk. To save the map along with all stored views, save the map in the 
  468.   normal way.
  469.  
  470.   Existing views can be recalled and deleted using the respective options on 
  471.   the View Library submenu.
  472.  
  473.  
  474. Making a 3D view
  475. ----------------
  476.  
  477.   Once you have positioned the view cone and arrow, you are now ready to 
  478.   make the view itself. Choose the 'Make view' option from the document 
  479.   menu. The view window will appear (initially it will be blue), and after a 
  480.   period of time the view will begin to draw. A further window will appear 
  481.   keeping you informed of the progress of the generation of the image. You 
  482.   may temporarily pause the processing, or abandon it altogether.
  483.  
  484.   The view window has a menu attached which can be used to save the 
  485.   resulting view, in the form of a sprite. XX Not implemented
  486.  
  487.  
  488. The preferences window
  489. ----------------------
  490.  
  491.   With the exception of 'Freehand resolution', all of the preferences on 
  492.   this window refer to the 3D generator.
  493.  
  494.   Screen Mode
  495.   -----------
  496.  
  497.     This field is used to adjust the mode in which subsequent images are 
  498.     created.
  499.  
  500.  
  501.   Resolution
  502.   ----------
  503.  
  504.     These 2 fields adjust the detail of the resulting 3D image. 
  505.  
  506.     The 'Primary' field affects the number of height samples taken for the 
  507.     whole view. The area described by the view cone is split up into a grid 
  508.     prior to generation of the 3D image. Each point on this grid is assigned a XX
  509.     height. The number of points on the grid is controlled by the 'Primary' 
  510.     resolution field. The higher this value, the better the relief of the 
  511.     final image. ! NOTE: Where sharp changes in height occur on a map, such as XX
  512.     an embankment, cliff face, severe valley, etc., it is possible that images 
  513.     generated on relatively low Primary resolution will be unsatisfactory. If 
  514.     this occurs, just increase the Primary resolution until a satisfactory 
  515.     image is produced.
  516.  
  517.     The 'Detail' resolution field determines how many sub-squares each primary 
  518.     square on the map is divided up into. A higher 'Detail' resolution is 
  519.     useful for resolving shapes such as complex lakes, woods, etc.
  520.  
  521.  
  522.   View Angle
  523.   ----------
  524.  
  525.     This control allows adjustment of the width of the resulting 
  526.     3D view. A wide angle gives a 'tele-photo' type picture.
  527.  
  528.   Multi-tasking
  529.   -------------
  530.  
  531.     This control allows the user to decide how much time is 'given back' to
  532.     the desktop (and therefore the other applications) during the generation 
  533.     of a 3D view.
  534.  
  535.   Landscape
  536.   ---------
  537.  
  538.     This group consists of two switches.
  539.         
  540.     Shading from light: When on, this causes the landscape to
  541.                         be drawn with consideration to the
  542.                         light-source (taken to be behind the
  543.                         view point). It can be switched off
  544.                         to increase the speed of processing.
  545.  
  546.     Draw outlines:      When on, the landscape appears as a
  547.                         grid - to emphasise the perspective depth.
  548.  
  549.   Default viewer height
  550.   ---------------------
  551.  
  552.     This allows the user to specify the default height of the viewer
  553.     - ie. how tall the person is.
  554.  
  555.  
  556. Exporting maps back into the 2D editor *NOT IMPLEMENTED*
  557. --------------------------------------
  558.  
  559.   Once 3D views have been specified and stored, the modified maps can be 
  560.   exported back into the 2D editor for further work, if required.
  561.  
  562.