home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / graphics / utilities / pictureeditor / pictureeditor.doc < prev    next >
Text File  |  1991-03-09  |  15KB  |  444 lines
  1. #####################################################################
  2. #                                                                   #
  3. #    P I C T U R E   E D I T O R   Documentation for version 1.12   #
  4. #                                                                   #
  5. #    © Hans-Werner Stremlau        9. February 1991     Glinde      #
  6. #                                                                   #
  7. #####################################################################
  8.  
  9. Contents:
  10.  
  11.      1. Summary
  12.      2. ProgramPacket
  13.      3. Starting
  14.      4. TitelLine
  15.      5. OperatingModes
  16.      6. FunctionKeys
  17.      7. MenuFunctions
  18.      8. Tips and remarks
  19.      9. Known errors
  20.  
  21.  
  22. 1. Summary:
  23.  
  24.  
  25.  This Modula2 program consists of the idea to assemble basic geometrical
  26.  objects (circle,triangle,line,...) to picture-objects.
  27.  
  28.  This picture-objects can be used to create other more complex
  29.  picture-objects.
  30.  
  31.  Each picture-object is the top of a hierarcycal structured object-
  32.  pyramid. The base of this pyramid consits of geometrical base-
  33.  objects.
  34.  
  35.  Simple sample picture-oject-hierarchie:
  36.  
  37.                         house
  38.                         /  \
  39.                     roof   rectangle(ground-floor)
  40.                     /  \
  41.             triangle1  triangle2
  42.  
  43.  
  44.  
  45.  Picture-objects you can:
  46.  
  47.     - create(bigger,smaller,rotate)
  48.     - delete
  49.     - duplicate
  50.     - move
  51.     - rotate (90 degree steps)
  52.     - change color
  53.     - move in fore/background of other objects
  54.     - merge with other picture-objects
  55.     - split (in sub-objects)
  56.     - load
  57.     - save
  58.     - convert to IFF(ILBM) pictures
  59.  
  60.  
  61.  Internal there are three different picture-object classes:
  62.  
  63.  - atomic:    Geometric base-objects(Circle,triangle...)
  64.               It's color is free selectable.
  65.  
  66.  - molecular: Merged objects of same color.
  67.               It's color is also free selectable.
  68.  
  69.  - colored:   Merged objects of different colors.
  70.               It's color cannot be changed.
  71.  
  72.  
  73. =====================================================================
  74.  
  75. 2. ProgramPacket:
  76.  
  77.  This programpacket consists of following files:
  78.  
  79.  - PictureEditor.doc ....... this file
  80.  - Bildeditor.dok .. ....... documentation in german
  81.  - ReadMe .................. shareware-information
  82.  - PED ..................... the program (PED=PictureED)
  83.  - Pictures (dir)
  84.    - PED-Startup ........... scriptFile (assign PED: ...)
  85.    - House&Trees.info ...... icon to start PED with this picture
  86.    - House&Trees.typ ....... sample-pictureFile
  87.    - HOUSE.typ ............. sample-pictureFile
  88.    - ROOF.typ  ............. sample-pictureFile
  89.    - TREE.typ  ............. sample-pictureFile
  90.    - MOON.typ  ............. sample-pictureFile
  91.    - PIPELINE.info ......... icon to start PED with this picture
  92.    - PIPELINE.typ .......... sample-pictureFile
  93.    - valve.typ ............. sample-pictureFile
  94.    - FULLCONTAINER.typ ..... sample-pictureFile
  95.    - CONTAINER.typ ......... sample-pictureFile
  96.    - line.typ .............. sample-pictureFile
  97.    - LINE2.typ ............. sample-pictureFile
  98.    - S.typ ................. sample-pictureFile
  99.    - S1.typ ................ sample-pictureFile
  100.    - l1.typ ................ sample-pictureFile
  101.    - l2.typ ................ sample-pictureFile
  102.    - l3.typ ................ sample-pictureFile
  103.    - Text (dir)
  104.      - HELLO_WORLD.typ ..... sample-pictureFile
  105.      - HW_TXT.typ .......... sample-pictureFile
  106.  
  107.  
  108.    remark: If e.g. HOUSE.typ or TREE.typ is deleted, then
  109.            also HOUSE&TREES.typ is useless.
  110.  
  111.  
  112.  
  113. =====================================================================
  114.  
  115. 3. Starting:
  116.  
  117.  The PictureEditor needs the "arp.library" in directory libs:
  118.  If necessary it can be copied from PictureEditor/libs to libs:
  119.  
  120.  The PictureEditor is searching for all files in the PED: directory.
  121.  If this assignment is not executed before start of PED,
  122.  (e.g. "assign PED: df0:pictureED/Pictures"), then RAM: is the used
  123.  default directory.
  124.  
  125.  
  126.  starting from CLI:
  127.  ==================
  128.  When you start the PictureEditor from CLI you can supply as argument
  129.  the name of an picture-object.
  130.  The picture-object name may have max. 16 character and may not have
  131.  the extension ".typ" (e.g. "PED Picture1" ).
  132.  
  133.  
  134.  starting from Workbench:
  135.  ========================
  136.  If you want to edit a "picture" via the workbench (like in the
  137.  example "House&Trees") then you have to create a project-icon with
  138.  the PictureEditor as default tool.
  139.  
  140.  
  141.  use with 512 KB and one diskdrive:
  142.  ===============================================
  143.  This program also works with only one diskdrive and 512 KByte memory.
  144.  With this configuration and the WB 1.3 plus ARP.library I was able
  145.  to load the sample-picture "Haus&Trees" (...playing diskjockey).
  146.  
  147.     To click the icon "Click Me first" the commands "assign" and
  148.     "echo" should be resident.
  149.  
  150.     After diskchanges (read fonts from WB-disk) you have to
  151.     click the WB to "background".
  152.  
  153.  
  154.  
  155. ====================================================================
  156.  
  157. 4. TitelLine:
  158.  
  159.  If the PictureEditor is started with a picture-object as argument,
  160.  then the name of this picture-object is displayed at the left side
  161.  of the titelline.
  162.  (Save-functions use this name as picture-name)
  163.  
  164.  At the right side of the titelline the name of the selected-object
  165.  is displayed.
  166.  
  167.  If you are creating an atomic object, then the atom-parameters:
  168.  (atomType(@ ), wide, height and rotation-angle) are displayed
  169.  at the right side of the titelline.
  170.  
  171.  If you are selecting a font, then instead of the selected-object,
  172.  the name of the selected font is displayed at the right side.
  173.  
  174.  
  175. ====================================================================
  176.  
  177. 5. OperatingModes:
  178.  
  179.  On working with this program, there are following different
  180.  operatingmodes (contexts):
  181.  
  182.  
  183.    Basic-mode:  Loading, manipulating and saving.
  184.  
  185.    Create-mode: Creating of atomic picture-objects
  186.                 (point,line,circle,triangle,square,rectangle)
  187.  
  188.    Text-mode:   Writing of text (one line) using the active font.
  189.  
  190.    Select-font: In this operating-mode you can select an active font.
  191.  
  192.  
  193.  
  194.  
  195. ====================================================================
  196.  
  197. 6. FunctionKeys:
  198.  
  199.  All functions usually refer to the "selected" picture-object.
  200.  "sh" stands for shift (only the left shift-key works).
  201.  
  202.  
  203.   Functionkeys in "Basic" operating-mode:
  204.  
  205.       F1 = change top with bottom
  206.    sh F1 = change left with right
  207.  
  208.       F2 = 90 degree rotate right
  209.    sh F2 = 90 degree rotate left
  210.  
  211.       F8 = Object to foreground (stepwidth: one logical plane)
  212.    sh F8 = Object to background (stepwidth: one logical plane)
  213.  
  214.       F9 = select next object     (foreground-direction)
  215.    sh F9 = select previous object (background-direction)
  216.  
  217.      F10 = next color     (only mono-colored objects)
  218.   sh F10 = previous color (only mono-colored objects)
  219.  
  220.      Del = delete selected-object
  221.  
  222.   CursorKeys and numericPad-cursorKeys
  223.          = move object (one pixel) in selected direction
  224.            (also diagonal)
  225.  
  226.   sh CursorKeys and sh numericPad-cursorKeys
  227.          = move object (object-measurement) in selected direction
  228.            (also diagonal)
  229.  
  230.        D = Duplicate object over original-object.
  231.  
  232.        M = Merge all selected objects (clicked objects)
  233.            to one picture-object.
  234.  
  235.        S = Split object to sub-objects.
  236.  
  237.        P = "Punch" Convert selected object to a punch.
  238.            All resulting objects merged with this "punch-object",
  239.            have a hole at the position and form of the punch-object.
  240.            (e.g. you can create rings with this method)
  241.            (Look for the picture-object MOON in sample-file, split it)
  242.            This function toggles (that means: after a new punch-call
  243.            the object again is "normal")
  244.            Objects in "punch-state" are displayed in grey color.
  245.  
  246.        B = Blink object. (the selected object is flashing up)
  247.            (the "5" of the numericPad has the same effect)
  248.  
  249.        F = First (select the newest/foreground object)
  250.        L = Last  (select the oldest/background object)
  251.  
  252.  
  253. ---------------------------------------------------------------------
  254.  
  255.   Functionkeys in "Create" operating-mode:
  256.  
  257.         RETURN = accept the created object
  258.       ESC or Q = cancel the created object
  259.  
  260.    Cursor Left = the object becomes thin (decrease x-dimension)
  261.    Cursor Right= the object becomes wide (increase x-dimension)
  262.  
  263.    Cursor Up   = the object becomes lower (dec. y-dim.)only rectangles
  264.    Cursor Down = the object becomes higher(inc. y-dim.)and triangles
  265.  
  266.            F10 = rotate object right (1 degree ) (not circles)
  267.         sh F10 = rotate object left  (1 degree ) (not circles)
  268.  
  269.     NumericPad = move object in corresponding direction
  270.  
  271.    When you press the left mouse button, you can move the object
  272.    with the mouse.
  273.  
  274. ---------------------------------------------------------------------
  275.  
  276.   In the "Text" operating-mode there is only "menu-control" possible.
  277.   After pressing a key, the corresponding character (setmap) is
  278.   displayed (using the active font) on the screen.
  279.  
  280. ---------------------------------------------------------------------
  281.  
  282.   Functionkeys in "SetFont" operating-mode:
  283.  
  284.  
  285.    Cursor Up   = load previous font
  286.    Cursor Down = load next font
  287.              F = load first font
  288.              L = load last font
  289.         RETURN = use font,    back to "Text" operating-mode
  290.       ESC or Q = cancel font, back to "Text" operating-mode
  291.  
  292.  
  293. =====================================================================
  294.  
  295. 7. MenuFunctions:
  296.  
  297.  PROJECT:
  298.  
  299.  - Load Type: From the PED: directory or from PED: subdirectories
  300.               you can select and load picture-objects (name.typ)
  301.  
  302.  - Clear All: delete all objects on screen (clear screen)
  303.  
  304.  - Make ILBM: Save the selected object as IFF(ILBM) File under the
  305.               name "<name>.iff" in the PED: directory.
  306.               This IFF-Files can be manipulated with paint-programs
  307.               or e.g. with the PD-program "IconLab".
  308.  
  309.  - Save:      If the PictureEditor is started with a picture-object
  310.               name as argument, then all picture-objects on the screen
  311.               are saved under this name in the PED: directory.
  312.  
  313.  - Save As:   All picture-objects on the screen are saved in the PED:
  314.               directory under the name you have supplied.
  315.               The name must be a new one (not an already existing).
  316.  
  317.  - Save Exit: Like "Save". Additionaly the program is terminated after
  318.               saving.
  319.  
  320.  - Quit:      Terminates the program without saving changes.
  321.  
  322.  
  323.  
  324.  EDIT:
  325.  
  326.  - Text:      Goto the "Text" operating-mode.
  327.               In this operating-mode you can write characters
  328.               (one line only) in the active font.
  329.  
  330.    - Return:    Via this menu-item you get back to the "basic"
  331.                 operating-mode.
  332.  
  333.    - SetFont:   Goto the "SetFont" operating-mode.
  334.                 In this operating-mode you can select the active font.
  335.  
  336.      - FirstFont: Select first font of font-list.
  337.      - LastFont:  Select last font of font-list.
  338.      - NextFont:  Select next font in font-list.
  339.      - PrevFont:  Select previous font in font-list.
  340.      - Use Font:  Set selected font to active font and return to
  341.                   the "Text" operating-mode.
  342.      - Cancel  :  Return to "Text" operating-mode
  343.                   (active font is unchanged).
  344.  
  345.  
  346.  - Create:
  347.  
  348.    - Point:    Create a point.
  349.    - Circle:   Create a circle.
  350.    - Line:     Create a line.
  351.    - Triangle: Create a (rectangular) triangle.
  352.    - Square:   Create a square.
  353.    - Rectangle:Create a rectangle.
  354.  
  355.      With cursorKeys you can change the object size.
  356.      With F10 you can rotate the object.
  357.      With mouse and numericPad you can move the object.
  358.      With RETURN you accept the object.
  359.      With Q or ESC you cancel the object.
  360.  
  361.  - Punch:  "Punch" converts selected object to a punch.
  362.            All resulting objects merged with this punch-object
  363.            have a hole at the position and form of the punch-object
  364.            (e.g. you can create rings with this method).
  365.            This function is toggling (that means: after a new punch-
  366.            call the object again is "normal")
  367.            Objects in "punch-state" are displayed in grey color.
  368.  
  369.  
  370.  - SelectAll:Set the "merge-select" flag of all picture-objects.
  371.              During merging all objects with this flag set are
  372.              merged together to one picture-object.
  373.  
  374.  - DeSelect: Clear the "merge-select" flag of all picture-objects.
  375.              After this command merging has no effect.
  376.  
  377.  - Merge:    All picture-objects with the "merge-select" flag set
  378.              are merged together to ONE picture-object.
  379.  
  380.              To set the "merge-select" flag of individual picture-
  381.              objects, you can click that objects with the left
  382.              mousebutton.
  383.  
  384.  - Split:    Split selected picture-object to sub-objects.
  385.  
  386.  
  387.  WINDOW:
  388.  
  389.  - CYCLING:
  390.  
  391.    - CycleOn:  Switch on  colorCycling
  392.    - CycleOff: Switch off colorCycling
  393.  
  394.  - RESOLUTION:
  395.  
  396.    - LO-Res    low resolution    (320 x 200)
  397.    - HI-Res    high resolution   (640 x 200)
  398.    - Interlace interlace         (640 x 400)
  399.  
  400.  
  401. =====================================================================
  402.  
  403. 8. Tips and remarks:
  404.  
  405.  - In high-resolution displaymode each picture-object has a ratio
  406.    of 640:200. This has the effect that circles seems to be elipsoid
  407.    and squares seems to bee rectangles. This effect is good to see,
  408.    when you rotate an object.
  409.      In interlace-resolution there is this effect not. But in this
  410.    resolution you should have at least 1MB Chip-RAM.
  411.  
  412.  - To speed up computing of picture-objects it is recommended to
  413.    use less but complex sub-objects, instead of using many but
  414.    simple sub-objects.
  415.  
  416.  - To merge an object-group to one picture-object follow these steps:
  417.    1. Call De-Select from "EditMenu"
  418.       (after execution no object is merge-selected).
  419.    2. Click all group-objects with the left mouse button.
  420.    3. Call merge from "Edit-Menu" or via function-key "M".
  421.       Supply a proper name for the new picture-object.
  422.  
  423.  - If you are going to build big object-libraries, it is a good
  424.    idea to create subdirectories in the PED: directory
  425.    (because this is easy to survey).
  426.  
  427.  
  428.  
  429. =====================================================================
  430.  
  431. 9. Known errors:
  432.  
  433.  - If you select the ARP-Filerequester, and quick press the
  434.    right mousebutton, then the system hangs in deadlock.
  435.  
  436.  
  437.  
  438.                    Hans-Werner Stremlau
  439.                    Stormarnring 20
  440.                    D-2056 Glinde
  441.                    Germany (West) 
  442.  
  443.  
  444.