home *** CD-ROM | disk | FTP | other *** search
/ Piper's Pit BBS/FTP: ibm 0010 - 0019 / ibm0010-0019 / ibm0010.tar / ibm0010 / CADKEY_A.ZIP / CADKEY1.ZIP / README.DOC < prev    next >
Encoding:
Text File  |  1989-07-07  |  16.0 KB  |  503 lines
  1.  
  2. ------------------------------------------------------------
  3. ------------------------------------------------------------
  4.                   CADKEY/DOS (version 3.5)
  5.                           README.DOC
  6. ------------------------------------------------------------
  7. ------------------------------------------------------------
  8. In addition to this file, please read the "Before You Begin"
  9. letter, included with this release. It contains information
  10. about the enhancements for this release, installing, and
  11. operating CADKEY/DOS.
  12.  
  13.  
  14. ---------------------
  15. MINIMUM REQUIREMENTS
  16. ---------------------
  17.  
  18. The following are the minimum requirements to run CADKEY/DOS
  19. (version 3.5):
  20.  
  21. * An IBM XT, AT, or Compaq 386 computer, or compatible.
  22.  
  23. * DOS, version 2.1 or later.
  24.  
  25. * 640K (We strongly recommend a minimum of 1 meg VDISK
  26.   expanded memory for RAM disk usage.)
  27.  
  28. * One floppy disk drive. (Our system disks are 1.2mb or 
  29.   3 1/2".  However, upon request we will supply 360K disks.)
  30.  
  31. * One hard disk drive with a minimum of 4mb of free
  32.   space.
  33.  
  34. * A graphics display card. (The CONFIG program contains a
  35.   list of the graphics devices supported by CADKEY).
  36.  
  37. * If you want hard copy output, a printing or plotting
  38.   device. (The CONFIG program contains a list of the
  39.   printer/plotter devices supported by CADKEY).
  40.  
  41.  
  42. Recommended Hardware Options
  43. ----------------------------
  44. We highly recommend the following hardware options:
  45.  
  46. * A math coprocessor.
  47.  
  48. * A tablet or mouse input device. (The CONFIG program
  49.   contains a list of the input devices supported by CADKEY).
  50.  
  51.  
  52. -------------------------
  53. DOCUMENTATION CORRECTIONS
  54. -------------------------
  55.  
  56. Selecting CONFIG Options
  57. ------------------------
  58. Page 2-5, 2-6
  59. To select a CONFIG option you must press the corresponding
  60. number key on the keyboard and then press the Enter key. You
  61. cannot use the function keys as described.
  62.  
  63.  
  64. Exiting CADKEY
  65. --------------
  66. Page 2-28
  67. Look in the Break Function Window for the key(s) to press to
  68. exit CADKEY. F10 is no longer used to exit CADKEY.
  69.  
  70.  
  71. Masking
  72. -------
  73. Page 11-20
  74. You are allowed to mask on only one level at a time. Ignore
  75. references to entering more than one level.
  76.  
  77.  
  78. VIEW, ENTITY, LINE
  79. --------------------
  80. Page 11-25
  81. The VIEW, ENTITY function incorrectly describes LINE as a
  82. planar entity.
  83.  
  84.  
  85. DRIVERS.DOC
  86. -----------
  87. Use the graphics card and driver information in the DRIVERS.DOC
  88. file instead of the graphics card information in the HARDWARE
  89. SETUP section of the CADKEY Utilities and Customization Guide. 
  90. The DRIVERS.DOC file can be found on the CADKEY Program Disk 1.
  91.  
  92.  
  93. ----------------------------------------
  94. CADL (Version 3.5) DOCUMENTATION CHANGES
  95. ----------------------------------------
  96.  
  97. The following information is in addition to the CADL Enhancement
  98. Addendum and the information found in your CADL Reference
  99. Section.
  100.  
  101.  
  102. Corrections to Existing Commands
  103. --------------------------------
  104.  
  105. FTEXT - There is no mirror text flag "mir".
  106.  
  107. GENDIM - The range for number of lines "nlines" is 0 - 9.
  108.  
  109. SET DEVOUT  - Missing optional open mode parameter after
  110. filename. If set to 0 or not supplied, the file is opened in
  111. overwrite mode, destroying the previous contents of the file (if
  112. it exists). If set to 1, the file is opened in append mode
  113. whereby new data is added to the end of the file (if it exists).
  114. For both modes, if the file doesn't exist, a new one is created.
  115.  
  116. TEXT - There is no mirror text flag "mir".
  117.  
  118. VLINE - Missing the 14th optional argument, line width "lwdt".
  119. The line width can be any odd value ranging from 1 - 15. If it is
  120. 0 or not supplied (the default) the current system line width is
  121. used.
  122.  
  123.  
  124. Enhancements to Existing Commands
  125. ---------------------------------
  126.  
  127. FTEXT - The "font" parameter, if between 1 and 6, emulates old
  128. style fonts (version 3.12 and earlier). A negative font number
  129. (between -15 and -1) selects a new style font that uses the
  130. "slnt" and "fill" parameters described next.
  131.  
  132. Added two optional parameters "slnt" and "fill" at the end of the
  133. list. "Slnt" specifies the slant of the text within the range of
  134. -31 to 31, where 0 means no slant. "Fill" specifies whether or
  135. not the text should be filled (0=not filled, 1=filled), if it's a
  136. fillable font.
  137.  
  138. GENDIM - Same as for FTEXT.
  139.  
  140. GETMENU - 12th parameter "dflt" (default menu selection). This
  141. parameter can be set to any value from 1 - n, where 'n' is the
  142. number of menu items displayed. If the user presses the <Enter>
  143. key instead of a function key, this value is returned as the menu
  144. item selected.  (e.g., if dflt is passed as 3 and <Enter> is
  145. pressed, @key will contain the value 3--the same as if F3 is
  146. pressed.) In addition, if the prompt string contains a "%s"
  147. specifier, the menu text of the default item is put in its place.
  148. If "dflt" is set to zero or not supplied (the default), the value
  149. returned in @key for the <Enter> key is -1 and no processing of
  150. the "%s" specifier takes place.
  151.  
  152. LABEL - Same as for FTEXT.
  153.  
  154. SET COLOR - The color number can now be specified as 0, which
  155. indicates the background color.
  156.  
  157. SETTEXT - Same as for FTEXT.
  158.  
  159. TEXT - Same as for FTEXT.
  160.  
  161.  
  162. Also, if the color parameter for any primitive is set to 0, the
  163. primitive is assigned the background color. In previous versions
  164. the current system color was assigned. To assign the current
  165. system color, either the parameter must be left off entirely
  166. (including any additional parameters following it) or the
  167. parameter must be specified as a null field, i.e., " ,,". The
  168. following examples illustrate both methods:
  169.  
  170.     LINE  0.8, 3.1, 0.0, 3.3, 3.8, 0.0
  171.  
  172.     CIRCLE  2.5, 1.5, 0.0, 0.7, 1, , 1, 1, 0, 0, 1, 1
  173.  
  174.  
  175. New Commands
  176. ------------
  177.  
  178. GETCOLOR puts  up the color menu allowing you to choose a
  179. color.
  180.  
  181.             Format: GETCOLOR prompt, retcol
  182.  
  183.             Input parameters:
  184.  
  185.                 prompt (string) - text string to be displayed on
  186.                                   the CADKEY Prompt Line. The
  187.                                   total length of the text string
  188.                                   must not exceed 68 characters
  189.                                   or truncation will occur.
  190.  
  191.             Output parameters:
  192.  
  193.                 retcol (ivar)  - variable to store return color 
  194.                                  index.
  195.  
  196.             System variables set:
  197.  
  198.                 @ERROR (ivar)     error code
  199.                                   0 = no error
  200.                                   1 = exception exit (F10 or ESC)
  201.  
  202.                 @KEY (ivar)       code for last key hit
  203.                                   -3 = ESCAPE
  204.                                   -2 = F10
  205.                                   -1 = CR (ENTER)
  206.                                    0 = value returned in "retcol"
  207.  
  208. GETENV - returns the text string assigned to a system environment
  209. variable.
  210.  
  211.             Format: GETENV evar, retstr
  212.  
  213.             Input parameters:
  214.                 evar (word) - system environment variable name
  215.             Output parameters:
  216.                 retstr (svar) - variable to store return string.
  217.                                 Variable must begin with a '$'
  218.                                 character.  The returned string
  219.                                 will be a null terminated array
  220.                                 of character.
  221.  
  222.             System variables set:
  223.  
  224.                 @ERROR (ivar)   error code
  225.                                 0 = no error
  226.                                 1 = environment variable
  227.                                     undefined
  228.  
  229. SET cdlpath, path
  230.  
  231.         path (word) directory pathname
  232.  
  233.         Sets the CADL directory pathname to the specified path.
  234.         If the path is invalid, @error is set to 1.
  235.  
  236. SET coord, mode
  237.  
  238.         mode (ival) coordinate mode
  239.  
  240.         Sets the coordinate mode to either VIEW (mode=0) or WORLD
  241.         (mode=1).
  242.  
  243. SET cview, vnum
  244.  
  245.         vnum (ival) system view number
  246.  
  247.         Sets the construction view to the specified number. If
  248.         zero, the construction view is disabled.  If an invalid
  249.         view number is given @error is set to 1.
  250.  
  251. SET textfill, mode
  252.  
  253.         mode (ival) text fill mode
  254.  
  255.         Indicates whether text should be filled or not (0=not
  256.         filled, 1=filled).
  257.  
  258. SET textslant, ang
  259.  
  260.         ang (ival) text slant angle
  261.  
  262.         Sets the current text slant angle. Values in the range of
  263.         -31 to 31 are permitted, with 0 meaning no slant.
  264.  
  265.  
  266. New CADL Call Functions
  267. -----------------------
  268.  
  269.      Function: cdlv2sysv, cv, sv
  270.      Action:   Convert CADL reference view number into its
  271.                corresponding system view number.
  272.      Input:    cv (ival)  CADL reference view number
  273.      Output:   sv (ival)  system view number
  274.      Error:    1 - invalid CADL reference view number
  275.  
  276.  
  277.      Function: inq_vp_ndc, vpnum, xmin, ymin, xmax, ymax
  278.      Action:   Return NDC bounds of specified viewport.
  279.      Input:    vpnum (ival)  viewport number
  280.      Output:   xmin (fval)   X minimum of viewport bounding box
  281.                ymin (fval)   Y minimum of viewport bounding box
  282.                xmax (fval)   X maximum of viewport bounding box
  283.                ymax (fval)   Y maximum of viewport bounding box
  284.      Error:    1 - invalid viewport number
  285.  
  286.  
  287.      Function: memcpy, dst, didx, src, sidx, cnt
  288.      Action:   Copy 1 or more elements from source 1-D array (at
  289.                source index) to destination 1-D array (at
  290.                destination index)
  291.      Input:    didx (ival)  destination array index
  292.                src (val)    source array
  293.                sidx (ival)  source array index
  294.                cnt (ival)   count of elements to copy
  295.      Output:   dst (val)    destination array
  296.      Error:    1 - source or destination not 1-D array
  297.                2 - index or count out of range
  298.  
  299.  
  300. New System Variables
  301. --------------------
  302.  
  303.      @curvp       Currently active viewport
  304.      @cview       Current construction view
  305.      @cviewmat[]  Current construction view matrix
  306.      @pltpath     Plot directory path
  307.      @prtpath     Part directory path
  308.      @ptnpath     Pattern directory path
  309.      @sfpath      Scratch file directory path
  310.      @suppath     Support directory path
  311.      @viewmat[]   Current view matrix
  312.  
  313.  
  314. -----------
  315. MACRO FILES
  316. -----------
  317.  
  318. Note
  319. ----
  320. Please be methodical when creating macros. You need to
  321. carefully edit macro text files because they are very system
  322. and function dependent. An unexpected step within a macro
  323. will yield unexpected results.
  324.  
  325.  
  326. On-line Calculator
  327. ------------------
  328. The following are new register variables reserved by the
  329. system:
  330.  
  331.     @curvp          Currently active viewport
  332.     @cview          Current construction view
  333.     @cviewmat[]     Current construction view matrix
  334.     @viewmat[]      Current view matrix
  335.  
  336.  
  337. MACRO_COORD
  338. -----------
  339. The MACRO_COORD statement accommodates cursor picks using a
  340. multiple viewport system. Its syntax is as follows:
  341.  
  342.     MACRO_COORD (vp_num, x, y, z)
  343.  
  344. Where:
  345.  
  346.     vp_num   -  The graphics viewport number
  347.     x, y, z  -  A 3-D world coordinate or a 2-D normalized
  348.                 device coordinate.
  349.  
  350. NOTE: 
  351. ------
  352. If vp_num is less than zero, then (x, y) contain a 2-D
  353. normalized device coordinate. Otherwise, (x, y, z) contain a
  354. 3-D world coordinate that was picked in the viewport
  355. corresponding to vp_num.
  356.  
  357.  
  358. Chaining macros
  359. ---------------
  360. Chaining macros has been enhanced to chain to one of two
  361. different macros. To chain one macro to another, simply
  362. press CTRL-E before ending the recording of the current
  363. macro. When this is done you are prompted to enter the
  364. following information:
  365.  
  366. 1) a loop condition,
  367.  
  368. 2) the macro to chain to if this loop condition is non-zero
  369.    (true) and
  370.  
  371. 3) the macro to chain to if the loop condition is zero
  372.    (false).
  373.  
  374. This must be the last thing you do when recording a macro
  375. because it automatically ends recording of the macro. The
  376. following is an example of the text when dumped out using
  377. the TXT OUT command:
  378.  
  379. Example:
  380.  
  381.     IF (i < 10)
  382.     JUMP LINE
  383.     ELSE
  384.     JUMP CIRCLE
  385.  
  386. Where:
  387.  
  388. (i < 10)  - Loop condition evaluated to be either one (true)
  389.             or zero (false).
  390.  
  391.     LINE  - Macro to execute if this loop condition is one
  392.             (true).
  393.  
  394.   CIRCLE  - Macro to execute if this loop condition is zero
  395.             (false).
  396.  
  397.  
  398. -------------
  399. GENERAL NOTES
  400. -------------
  401.  
  402. A New Font Generation File
  403. --------------------------
  404. Font files now carry more information which allow greater
  405. functionality. Because earlier versions of CADKEY font files
  406. are now incompatible with CADKEY version 3.5, you need to
  407. create version 3.5 font files using the new font generation
  408. utility program included with this release.
  409.  
  410.  
  411. Increase in % of Usage
  412. ----------------------------
  413. Because of changes in the CADKEY part file structure,
  414. changes in the data base for DOS-UNIX compatibility, and
  415. changes for greater precision (ALL entities, including
  416. dimensions, are now stored in 64-bit double precision),
  417. CADKEY version 3.5 part file size, on-line scratch memory,
  418. and disk space usage may increase by up to 50%.
  419.  
  420.  
  421. Graphics Driver Support
  422. -----------------------
  423. CADKEY (version 3.5) supports drivers written to the
  424. CADKEY's own DOS resident driver standard and to HALO
  425. graphics drivers. The list of supported graphics cards, the
  426. respective driver name, and instructions are included with
  427. this release. For information on how to obtain a developer's
  428. toolkit for writing CADKEY (version 3.5) graphics drivers to
  429. this standard, contact Chris Penna,Third-party Program
  430. Manager (CADKEY, INC.  440 Oakland Street, 
  431. Manchester, CT 06040  (203) 647-0220)
  432.  
  433.  
  434. ------------------------------------------------
  435. ENHANCEMENT REQUESTS and CADKEY/DOS version 3.5
  436. ------------------------------------------------
  437.  
  438. Our dedicated users have submitted a large number of
  439. enhancement requests--the majority of which relate to
  440. graphics interface, hardware support, and improved precision
  441. in high-level geometry creation operations. We incorporated
  442. as many of these enhancements as possible in CADKEY 
  443. version 3.5 and will continue to incorporate requested
  444. enhancements as fast as we can, so please be patient. To
  445. check on the status of a requested enhancement or error
  446. correction, contact the Quality Control department 
  447. (CADKEY, INC.  440 Oakland Street, Manchester, CT 06040
  448. (203) 647-0220)
  449.  
  450.  
  451. ---------------------------------------------------
  452. CORRECTIONS FOR VERSIONS UP TO, AND INCLUDING, 3.12
  453. ---------------------------------------------------
  454.  
  455. The following is a list of bugs fixes. Although most of the
  456. bugs were reported as isolated cases, they were viewed as
  457. important corrections:
  458.  
  459. * Ordinate dimensions are no longer being corrupted in
  460.   isolated cases with large parts or when using the MODIFY
  461.   function.
  462.  
  463. * There is now increased accuracy when trimming curves
  464.   (especially tangency intersections) at very small or large
  465.   scales.
  466.  
  467. * Filled fonts and toleranced dimensions now plot correctly.
  468.  
  469. * Zooming in or out to extremes no longer produces graphics
  470.   display errors.
  471.  
  472. * CADL bugs involving grouped entities or groups were
  473.   resolved.
  474.  
  475. * We solved the problem of a data base write error being
  476.   encountered when using large splines, ordinate dimensions,
  477.   or polylines. This was a problem in only a few isolated
  478.   cases.
  479.  
  480. * The functions that did not allow pauses for variable input
  481.   have been fixed so you will no longer experience MACRO
  482.   errors.
  483.  
  484. * We have fixed the bug that, in isolated cases, produced
  485.   errors when attempting to edit MACRO libraries.
  486.  
  487. * There is no longer a problem with the SIM test failing on
  488.   Compaq 386S machines.
  489.  
  490. * You can now accurately trim conics and splines.
  491.  
  492. * The isolated errors in the SPLINE 3D AUTO function were
  493.   fixed.
  494.  
  495. * File note entities now recognize the entire file path
  496.   name.
  497.  
  498. ------------------------------------------------------------
  499. ------------------------------------------------------------
  500.             END OF README.DOC
  501. ------------------------------------------------------------
  502. ------------------------------------------------------------
  503.