home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 026.lha / CAD / mCAD.doc < prev    next >
Text File  |  1987-04-02  |  16KB  |  366 lines
  1.    mCAD Version 1.2
  2.  
  3.    mCAD is an object-oriented drawing program.  It has a small set of
  4. graphics primitives (like "line", "box", and "text") and a small set of
  5. editing functions (like "move", "size", and "rotate").  While drawing and
  6. editing, the user can call on other functions to modify the display -- to
  7. zoom in, slide around, superimpose a grid, etc. 
  8.  
  9.    The one powerful feature of mCAD is that primitives can be grouped and
  10. ungrouped; the editing functions operate on groups of (one or more)
  11. primitives.  In these instructions, "group" and "object" will mean either a
  12. single primitive or a group of primitives.
  13.  
  14.    Most (surely all!) Amiga users know how to use the mouse to draw pictures. 
  15. In mCAD, the mouse does mostly what you're accustomed to from programs like
  16. GraphiCraft.  There are three differences:
  17.  
  18.    1) In mCAD, you are called on to SELECT objects for treatment with one of
  19. the editing tools.  Since mCAD can't know for which of two or more
  20. overlapping objects your SELECT click was intended, it runs through a list of
  21. all the possibilities, highlighting each in turn.  In this context, the MENU
  22. button means "No, not that one", the SELECT button means "Yes, the
  23. highlighted object is the one I want". 
  24.  
  25.    2) While drawing a primitive (exception: text) or editing a group
  26. (exception: coloring), mCAD gives you a chance to abort the whole operation. 
  27. In this context, the MENU button means "Abort", the SELECT button means "The
  28. highlighted object is drawn as I want it, make it permanent."
  29.  
  30.    3) Certain editing functions, "Size" for example, require additional
  31. information and indicate this by drawing a highlighted object.  You are asked
  32. to click on (SELECT button) e. g., one corner of a box. 
  33.  
  34.    So, generally, when the mouse buttons don't have their Intuition meanings,
  35. the SELECT button means "Yes/ok/do it...", and the MENU button means
  36. "No/abort/get me out of this".  This follows the accepted Amiga convention
  37. that "left" breaks new ground while "right" is conservative and safe.  If you
  38. get lost in -- or called away in the middle of -- a sequence of mouse clicks,
  39. a couple of MENU button clicks will get you out of it. 
  40.  
  41. *********************************************************************
  42. THE COMMAND LINE:  to call up the program
  43. *****************
  44.  
  45. mCAD ?         Help
  46. mCAD filename  Create/Edit a drawing named "filename".  You need not type
  47.                the filename if you intend to load the file from within mCAD.
  48.  
  49.  
  50. *********************************************************************
  51. THE MENU:   menu items that don't work or aren't yet implemented are
  52. described by "*"
  53. *********
  54.  
  55. *************
  56. PROJECT
  57.  
  58. New         Erases the current drawing.
  59.  
  60. Open        Opens a drawing which exists on disk for viewing and/or editing.
  61.             MicroSmith's file requester is used to specify the file name.
  62.  
  63. Save        Saves the drawing to disk using the current drawing name.  The
  64.             current drawing name is either the name that occurred on the
  65.             command line, or the name of the file most recently "Open"ed.
  66.             The default drawing name is "mCAD.out".
  67.  
  68. SaveAS      Saves the drawing to disk.  MicroSmith's file requester is used
  69.             to specify the file name.
  70.  
  71. Plot        Saves the (entire) drawing as a plot file in the Hewlett Packard
  72.             Graphics Language.  Instructions are included in the file to
  73.             enable XON/XOFF handshaking with the plotter.  To actually make
  74.             the plot, copy the plot file to SER: The plot file name has the
  75.             same root as the current drawing name, and the extension ".plt"
  76.  
  77. Quit        Quits mCAD.  If you have made any changes to the current drawing,
  78.             you will be asked if you want to save it.
  79.  
  80.  
  81. *************
  82. PART
  83. mCAD expects the current directory to contain a sub-directory called "part".
  84. MicroSmith's file requester will let you change directories, however.
  85.  
  86. Open        Includes an mCAD drawing, which was previously saved to disk, in
  87.             the current drawing.  You will use MicroSmith's file requester to
  88.             specify the part name.
  89.  
  90. Save        Saves a group to disk using the current part name.  Select the
  91.             group you want to save with the mouse as described above.
  92.  
  93. SaveAs      Saves a group to disk by name.  Select the group with the mouse.
  94.  
  95. Group       Draw a box completely enclosing the objects you want treated as
  96.             a group.  An object can only be in one group at a time.  If an
  97.             enclosed object is already part of a group, it will be extracted
  98.             from that group.  If an entire group is enclosed, that group
  99.             will merge into the new group. 
  100.  
  101. UnGroup     Select a group by clicking on any of its members.  On the
  102.             confirming SELECT click, the group will be dismembered.
  103.  
  104.  
  105. *************
  106. OPTIONS
  107.  
  108. Replot      Redraws the screen.  The options "Axes" and "Grid" do not cause a
  109.             replot automatically because redrawing can take a long time, and
  110.             because you may want to make another display selection before
  111.             redrawing. 
  112.  
  113. Zoom        Draw a box around the region you want.  mCAD will zoom in to the
  114.             biggest region consistent with both the box you drew and the
  115.             aspect ratio of the drawing.  Note: in this version the aspect
  116.             ratio cannot be changed by any command. 
  117.  
  118. Slide       Draw a line.  On your second SELECT click mCAD redraws the
  119.             picture as if your first click had grabbed a hold of the page. 
  120.             (mCAD is too slow to move the whole picture along with the mouse
  121.             and memory is too precious to spend on a scrollable screen.)
  122.  
  123. FullPlot    Zooms out to show the whole drawing.
  124.  
  125. Axes        This is a toggle switch that puts axes on the display.
  126.             See Replot.
  127.  
  128. Grid        This is a toggle switch that puts a grid over the display.
  129.             See Replot.
  130.  
  131. X-Hair      This is a toggle switch.  The mouse pointer is replaced by a
  132.             crosshair.  Notice what happens when you press the MENU button
  133.             and move the mouse. 
  134.  
  135. GridSnap    This is a toggle switch.  Primitives (exceptions: text, circle,
  136.             arc) drawn with GridSnap enabled will snap to the grid on your
  137.             *final* SELECT click.  When enabled, menu item reads "GridSNAP". 
  138.  
  139. DataSnap    This is a toggle switch.  Primitives (exceptions: text, circle,
  140.             arc) drawn with DataSnap enabled will snap to previously drawn
  141.             objects (if they are close enough) on your final SELECT click.
  142.             Points are more "attractive" than lines connecting those points.
  143.             When enabled, menu item reads "DataSNAP"
  144.  
  145. nTics*2     Increases the density of tics / grid lines.  A maximum is
  146.             enforced.  This item causes a replot. 
  147.  
  148. nTics/2     Decreases the density of tics / grid lines.  A minimum is
  149.             enforced.  This item causes a replot. 
  150.  
  151. ShowXY      Calls up a numeric readout in the current plot color of the
  152.             pointer position.  The readout is in USER coordinates (the
  153.             numbers which are drawn when you select "Axes" are in USER
  154.             coordinates.) The readout consists of the absolute X
  155.             (horizontal) and Y coordinates and the distances from the
  156.             location of the most recent SELECT click. 
  157.  
  158.  
  159. *************
  160. DRAW
  161.  
  162. Line        Draw a sequence of (one or more) connected lines.  Click twice
  163.             on your final point. 
  164.  
  165. Box         Draw a box by clicking on two corners.
  166.  
  167. Circle      Draw a circle by clicking on the center position, moving the
  168.             mouse to change the size, and clicking again when the size is
  169.             right. 
  170.  
  171. Arc         Draw an arc with three mouse clicks: the first click sets the
  172.             center;  the second click sets the radius and starting angle;
  173.             the third click sets the ending angle. 
  174.  
  175. Measure     *
  176.  
  177. Clone       Select a group by clicking on any of its members.  A duplicate
  178.             will follow the mouse pointer until you press either the MENU
  179.             button ("abort") or the SELECT button. 
  180.  
  181. TextSize    Draw a box indicating the size/aspect of the letters you plan
  182.             to type onto the screen.
  183.  
  184. Cursor      SELECT the location of the text cursor.
  185.  
  186.  
  187. *************
  188. EDIT
  189. In every case, you first select a group for treatment.
  190.  
  191. Erase       SELECT a highlighted group to erase it.
  192.  
  193. Size        SELECT a highlighted group.  mCAD draws the smallest enclosing
  194.             rectangle (possibly a line).  You SELECT a corner of the
  195.             rectangle to begin sizing.  The group is scaled as the mouse
  196.             moves.  Press the SELECT button, when you like what you see, or
  197.             the MENU button to abort. 
  198.  
  199. Move        Select a group by clicking on any of its members.  The group
  200.             will follow the mouse pointer until you press either the MENU
  201.             button ("abort") or the SELECT button. 
  202.  
  203. Rotate      The selected object is rotated about its "center".  Vary the
  204.             angle by moving the mouse and click SELECT to finish or MENU to
  205.             abort. 
  206.  
  207. Rot +90     Select a plot.  The selected plot will be rotated counter-
  208.             clockwise by 90 degrees.
  209.  
  210. Rot -90     Select a plot.  The selected plot will be rotated clockwise by
  211.             90 degrees.
  212.  
  213. Point       Select a group.  When the group you want to modify is
  214.             highlighted, click on the point you would like to move.  The
  215.             point and lines connecting it to adjacent points will follow
  216.             the mouse.  Click SELECT to finish or MENU to abort.
  217.  
  218. Color       Select a group.  The selected group immediately turns to the
  219.             current plot color.  (No chance for abort here.)
  220.  
  221.  
  222. *************
  223. COLORS
  224.  
  225. color boxes    Your menu selection becomes the current plot color.
  226.                Initially, the current color is #4 (first box in second row
  227.                of the palette). 
  228.  
  229. Modify Colors  Call up Microsmith's Palette tool (a very nice tool written
  230.                by Charlie Heath).
  231.  
  232. Save Colors    Save current colors to the file "mCAD.rgb" which is read by
  233.                mCAD on startup. 
  234.  
  235.  
  236. ************************************************************************
  237.  
  238. NEW FEATURES
  239.  
  240. Version 1.2
  241.  
  242.    File input and output from within mCAD has been added.  Thanks to Charlie
  243. Heath and MicroSmith's for the file requester and, while I'm at it, for their
  244. palette tool.  This is the hard stuff, folks.  If I had had to write these
  245. tools myself, you can be sure that they wouldn't be such a pleasure to use,
  246. and that I would be asking for more of a donation than $20.
  247.  
  248.    Point editing has been added.  This feature allows you to move a single
  249. point of a group without affecting other points.
  250.  
  251.    A shortcut for rotating by 90 degrees has been added.  (The original
  252. motive for this was to rotate entire drawings before plotting.)
  253.  
  254.    Several bugs that once caused mCAD to crash have been fixed.  mCAD now
  255. realizes that mouse clicks are being queued up "behind its back" and that
  256. disabling them doesn't erase queued messages.
  257.  
  258.    Groups work right.  In previous versions, the result of grouping objects
  259. that were already in different groups depended on the order in which those
  260. groups had been formed. 
  261.  
  262.    mCAD can now read a file and add the objects in that file to its linked
  263. list of objects.  In other words, the "Parts" menu is fully implemented.  It
  264. may be useful to know that there is no difference, to mCAD, between a "part"
  265. file and a "cad" file.  You can treat a whole drawing as a part and
  266. vice-versa.  You can also use the outputs of the programs "mp" and "tdp" as
  267. parts or as drawings. 
  268.  
  269.    Tab, backspace, and carriage return now do what they say they do.
  270. Backspace does not erase, however.  Also, see "BUGS/WARNINGS...".
  271. ************************************************************************
  272.  
  273. HINTS, SUGGESTIONS ...
  274.  
  275.    mCAD's input file format is very simple.  You can make an mCAD file by
  276. hand or with a simple program in "c", Basic, etc.  In fact, this file can
  277. be used as input to mCAD.  The only lines mCAD will pay attention to are
  278. the following: --------------------------
  279.  
  280. 100 100     This is a box..
  281. 100 200     Note: if you use this file as input to mCAD, DO NOT SAVE!
  282. 200 200     mCAD will cheerfully erase this file, leaving in its place
  283. 200 100     a file consisting only of the numbers to the left.
  284. 100 100
  285. *>          The object above this mark is in a group with the object below it.
  286. *C 4        This object is in color 4
  287.  
  288. 125 150     This is a line..
  289. 175 150
  290. *C 5  
  291.  
  292.       --------------------------
  293.  
  294.    I prefer a "fast" mouse for most programs, but would like a slower one
  295. for doing fine work with mCAD.  I haven't found a way to change the mouse
  296. speed while in the program (any ideas, Amiga gurus?), but an acceptable
  297. substitute is using the Amiga-arrow keys.  You may have forgotten about this
  298. keyboard alternative since it is so rarely useful.  Also, don't forget about
  299. Amiga-alt for mouse buttons.  (Sometimes, I inadvertently move the mouse
  300. while clicking a mouse button.)
  301.  
  302.    Grouping objects (making "parts"):
  303.    Since, in mCAD, the only way to indicate which objects you want in your
  304. group is to draw an enclosing rectangle, you may be having trouble excluding
  305. objects you don't want.  But, because of the way groups are implemented in
  306. mCAD, this is not as bad as you might think.  You don't have to enclose the
  307. whole group at once; two or more rectangles can be used.  If you have two
  308. groups and you make a group containing one member of each, the result will be
  309. a single group containing all the members of both groups.
  310.  
  311.    When X-Hair is not selected, the Intuition pointer is supplemented with a
  312. dot at the current location of the graphics cursor.  (You may know that the
  313. Intuition pointer is implemented in low resolution and therefore cannot, with
  314. precision, select a point on a high resolution screen.  The dot is a remedy
  315. for this.)  To make effective use of it -- indeed, too SEE the dot -- your
  316. pointer should have its "hot spot" on one of the "transparent" pixels.  In
  317. Preferences, use the "Set Point" option while you "Edit Pointer". 
  318.  
  319. ************************************************************************
  320.  
  321. BUGS, WARNINGS, ADDITIONAL NOTES ...
  322.  
  323.    You MUST select a text size and cursor location before typing text into
  324. your drawing.  The defaults aren't done right in this version.  This means
  325. that, if you don't specify the size and location at least once, text will be
  326. put any old where in some arbitrary size -- which, in turn, means that you
  327. can expect a short, one-sided chat with the Guru the next time you select
  328. "FullPlot". 
  329.  
  330.    Letters, in this version, are REALLY primitives; all points are connected
  331. together as though drawn with a single "Line" command.  This means characters
  332. like [ ! = ? : ; " Q ] don't look so good.  (Ok, they look awful!).  Text is
  333. likely to improve in some future version. 
  334.  
  335.    Occasionally, with both the X-Hair and the dot, trash may be left on the
  336. screen after editing a group.  Use "Replot" for now.  (I don't consistently
  337. "pick up" the dot/crosshair before drawing over it.) 
  338.  
  339.    mCAD doesn't do ANY memory checking.  It will crash the system or exit
  340. without returning allocated memory if it finds that there isn't enough memory
  341. to do whatever it wants to do.  In a multi-tasking system with a ram disk,
  342. this is bound to happen to you sooner or later.  This IS going to be fixed!
  343. Until it is fixed, I suggest you save your drawing often and keep an eye on
  344. the amount of ram available.
  345.  
  346.    Tim Mooney
  347.    120 Purefoy Rd.
  348.    Chapel Hill, NC 27514
  349.  
  350.    If you have a modem, you can leave me mail at the following bulletin
  351.    board which I monitor regularly.
  352.  
  353.       "Deep Thought"   (919) 471-6436
  354.  
  355. ------------------------------------------------------------------------
  356.  
  357.    Registered users:
  358.  
  359.    I plan to move sometime in the fall of '87.  When I do, I'll leave a
  360. forwarding address on the bulletin board mentioned above and with:
  361.  
  362.    Department of Physics and Astronomy
  363.    Phillips Hall
  364.    University of North Carolina
  365.    Chapel Hill, NC  27514
  366.