CADKEY 6.0 
README File
February 1993

This CADKEY README file contains up-to-the-minute information 
on CADKEY 6. 

CADKEY Reference Manual:

In the Tutorial and in regular Drawing Layout Mode use,
CADKEY does NOT ask you if you want to return to
Model Mode from Drawing Layout Mode; you return 
automatically.


KNOWN ERRORS AT TIME OF RELEASE:

When projecting and joining a full circle into a full ellipse the
join line between the two entities will not always be the end of 
each entity.

When a DWG file is translated into CADKEY dimension arrows may be altered.
The change in arrow direction can be corrected. To change the direction 
use the Arrows out or Arrows in check box in the Detail Set dialog box.


MAJOR  FIXES FOR CADKEY 5.02 INCLUDED IN CADKEY 6:

BOX:MOVE has been fixed to correct the relocation of arcs 
selected within the window.  Currently arcs within the window of
selection (on SGI only) do not move.

Metaware 3.03+/Pharlap 4.1+: the system-related page
fault errors encountered with previous version of compiler and
linker have been corrected.

Drawing Layout and level change: the min/max window for instance
placement when the instance is created from an assembly now
accounts for only the geometry selected and not the assembly's
entire min/max area.

Filing speed improvements: part and pattern save and retrieval
have been improved to reflect CADKEY 4.06's performance.

Selection speed: window and polygon selection have been
improved to reflect the CADKEY 4.06's performance.

FONT file improvements:  font files are now memory-based
in order to improve the speed performance for display.  This
improvement will be seen with multiple font drawings only.

The speed of copious data access has been increased by
enhancing memory usage.


CADL AND CDE CORRECTIONS INCLUDE:

Correction to the CADL compiler freeze when using SLIST

Corrected the ANGDIM command which produced garbage
when the str variable was left out for autocalculation

CLEARHST now clears the history line

sys_ptn_save and MAKECOLL accept a -1 for the numid argument.

dg_get_table_changed function now works correctly.

You can now create a filled polyline.

ADDCOLL and MAKECOLL have been corrected to work if IDs
passed to them are already a collective.

ORDDIM now has a text box width and height.             

All ANSI C functions have now been exported.

ck_etype function now works.

ck_addcoll and ck_makecoll functions work correctly if the IDs
passed to them are already a collective.

ck_clearhst function correctly the History Line.


OTHER CORRECTED ERRORS:

Part file default for path/name.

Sorting of  the level list descriptors during output.

A distance (verify) error encountered when measuring between an
arc and a short line segment crossing an arc centerline.

Address a units error for IN/MM.

Running Dimension error when retrieving a pattern where the
dimension disappears.

Error with QTRIM and VERSEL both turned on which resulted
in lock-ups.

System hang occurring when editing ordinate dimension base
position and using <Enter> for 0.

System lock-up when users tried to save a plot file under
FILES, PLOT, SAVE.  If a user hits <Enter> twice from the mouse
without a filename on prompt line, system hangs.

Error with ghost labels that are created by hitting Esc after
leader side is selected.

Error with witness/leader lines when using VERIFY, EDIT and the
definition view field being set to 0 or an extremely large number.

Error with radial dimensions created on partial arcs with only
one leader segment where autoscale displays a dot (the part file)
in the corner of the screen.

Error with flashing markers which are drawn and not flashed which
requires the user to redraw.

GP fault error during creation of a label and using a zoom to
place arrow.

Error with solid arrows disappearing in View 7.  Pressing Ctrl-N
and Alt-H several times displays them out in space.

Bad or missing argument when executing CADL file with output of
polyline data.

Error with diameter dimensions on edge; must back up to create
more than one or select other arcs.

Look at part file w/ level list problem - can't delete extra levels
or edit duplicate levels.

Corrected two missing files from run-time version of Folio.

Error with changing attributes; e.g., pen # or color using WINDOW or
ALL DSP.  

Error with XFORM, SCALE, UNIDIB, MOVE, COPY where DXV is displayed
and user can't F10 or Esc and must use valid data.

Error where radial dimensions displayed without leaders sometimes affected
autoscaling. 

Entities which are selected for deletion and the user backs out using Esc,
entities which are grouped are degrouped.

Scratch file performance improvements added.

EDIT:TRIM position, correct the crash caused by hitting <Enter>.

XFORM, PROJECT, MOVE, NORMAL, single select entity, using
Ctrl-L where hitting <Enter> crashed the system.

CADUTIL problem that generates unique IDs in the trillions (UX).

CADUTILing of dimension circles from 4.06 when text has been moved.

Pattern retrieval problems for horizontal and vertical dimensions
constructed with autocentering set to ON.

DSUTIL_5 errors when going into Drawing Layout Mode.

DLM instance creation with angles other than 360 through -360
degrees.

Edited ordinate dimension text problems where the text 
overwrites the leader.

Various page faults with ordinate dimensions.

Path bug in config.dat.

Updating angular dimensions from IN to OUT.

Verifying the area of a single segment hyperbola.



SPEED ENHANCEMENTS

To increase the speed at which CADKEY loads part, pattern, 
plot, or CADL files type (at the system prompt):

set CADKEY_BUFFER=n

where n equals the amount of Kbytes to use. The CADKEY default
value is 50.


CONFIGURATION

The following configuration option has been added under
Option 5:

Will you be running other DOS Extender programs (Analysis) 
from CADKEY or from the DOS shell (Y/N)?

If you choose Y, the following prompt appears:

Memory will have to be released by CADKEY to allow the other DOS
Extender program to execute properly. It is recommended that at least
2048K be released for running Analysis.

Enter the number of Kbytes to release (2048) =>


PROPER CONFIGURATION TO AVOID
POTENTIAL PROBLEMS

1. Make sure that you have enough free disk space and memory
   to run CADKEY; see "System Requirements" in "Getting Started"
   for more information.

If you should have a problem, you can exit CADKEY and perform the following:

1. Go to the operating system prompt for the drive on which you 
   installed CADKEY and delete the swap files. Swap files are eight 
   character files consisting of mixed characters and contain no file
   extensions. 

2. Go to the directory to which the database writes and delete the
   database files. Database files usually have .dba file extensions.

3. Go to the scratch file subdirectory and delete the copious data files.
   You can identify copious data files because they begin with either the 
   characters "NA" or "CA" and contain no file extensions.


DRAWING LAYOUT MODE COMMENTS
AND TIPS

With Drawing Layout Mode, you may experience
a slight performance decrease when creating the initial
instance if the instance contains splines or conics.
Once you create the instance, performance returns to normal levels.

When you initially load a CADKEY part file with layouts in 6, 
CADKEY will take awhile to load the file. After you load the file in 6, 
the speed at which CADKEY loads the part file increases.

When loading, copying, or modifying a layout after naming
and describing the layout, define the paper size
BEFORE defining the actual scale. When you set the paper size
CADKEY assigns the suggested actual scale according to the
model size and paper size. This might change the actual scale
that you have selected. To get the actual scale you want,
set it AFTER setting the paper size.

If you extend instance geometry using TRM/EXT and then 
select the newly extended portion of the entity to trim, 
you might have some unexpected results. If you have problems 
trimming an instance-specific entity in Drawing Layout Mode 
after extending it, go back and check the original model in
Model Mode.

When cross-hatching an instance with hidden geometry,
(for example, transformed geometry, such as joined lines,
not in the viewing plane), make that instance active, and
then use instances in other views to make entity selection
easier.

If you place any geometry, text, etc., outside the paper limits,
it will not plot or print.

When selecting an instance, if all the entities in the instance 
do not appear highlighted, don't panic. They are selected. 
To make CADKEY highlight all the entities in the instance,
change the "maximum number of entities to display while
rotating a part" to higher than the default of 40. For more
information on this setting, see "Set graphics options" in the
"Configuration" chapter of the Getting Started guide.

When you relocate an instance with entities that you modelized, 
the modelized entities disappear during relocation and 
appear only when you redraw or autoscale the drawing.

If you modelize a single entity, use the UNBLANK option
to unblank a masked copy of the entity. Then relocate that
instance and delete the modelized entities that you left behind.
Note this doesn't work if you modelized by INSTANCE or
LAYOUT.

CADKEY includes several predesigned border
pattern files. Place the borders before placing instances. 
This is especially true before modelizing instances.
There are two categories of border files. The first is named 
BORDA.PTN through BORDA4.PTN; the second is named
LAYA.PTN through LAYA4.PTN. 

In Drawing Layout Mode, the border patterns you need to use
are those in the second category (LAYA.PTN through
LAYA4.PTN). This category has been scaled to fit within
the paper limits. The first category (BORDA.PTN through
BORDA4.PTN) is on top of the paper limits, and might
print or plot off the paper.

Examples:

Model Mode     Drawing Layout Mode
(United States standard)

BORDA        LAYA
BORDB        LAYB
BORDC        LAYC
BORDD        LAYD
BORDE        LAYE

Model Mode     Drawing Layout Mode
(International)

BORDA0        LAYA0
BORDA1        LAYA1
BORDA2        LAYA2
BORDA3        LAYA3
BORDA4        LAYA4


CADKEY DRAWING LAYOUT MODE SAMPLE CDEs

The following Drawing Layout Mode sample CDEs are available in
your CDE subdirectory:

CHNG_ACTV_INSTANCE

When executed from Drawing Layout Mode, Chng_actv_instance
lets you cycle through the drawing instances to change the active 
instance using Tab and Spacebar. Once you select the 
instance you want to make active, press Esc. The 
CDE stops and makes the last instance active.

CREATE_4VIEW_LAYOUT

Create_4view_layout lets you create a four-view layout containing the
standard views, 1, 7, 2, and 5. The instances you create are assigned 
the scale that you indicate and CADKEY centers them according to the
paper size that you choose.

HORIZON_LINES

Horizon_lines lets you easily create horizon lines and/or center lines
in either Drawing Layout or Model Mode. If you are in Drawing
Layout Mode when you execute this CDE, CADKEY prompts you to
select the instance in which you want to create horizon lines and/or
center lines in. Next, CADKEY prompts you to select two arcs or
circles and then generates the horizon lines and/or center lines.
To exit the program, press Esc or F10.


TRANSFORMING ENTITIES

If you choose XFORM, MIRROR for circles, arcs, conics, splines,
or any view-dependent entity, and then choose to group or subgroup
them, CADKEY does not group the listed entities.


DIALOG BOXES

TABLES

dg_set_table_ints, dg_set_table_strings,dg_set_table_double, 
 
The [vals} array must have a size of 10, regardless of the actual
number of values used.

Tables cannot have titles.

ICONS

The .cdi file containing the icon geometry must be in the support
directory.

dg_add_icon fname should not include the cdi extension.


CADL

sys_get_name

The name parameter needs to be set to an array size of 30.
Before using the command, set $name [30]


PICTURE IT

PLEASE NOTE:  Picture It is a shape recognition faceted modeler. 
              The mass property information may be incorrect.

KNOWN ERRORS AT TIME OF RELEASE

The prompt after smooth processing states "Press RETURN to continue or
'P' to print ...", but journal file command 013 (RETURN) is not
recognized at this point.  You should be able to use any letter that is
not 'P' or 'p' to get the same effect as the RETURN. 

ESC is only observed where it is safe to stop processing.
This means that ESC may not take effect immediately.
When it is recognised it may only cause the current step
in the processing to be skipped.  Repeated ESCapes may be needed.

The object mask description will be truncated in the dialog box if the
description exceeds 48 characters.  The description in the Mass
Properties output file will not be truncated. 

Picture It does not understand the solids primitives generated
by the SP.CDX utility.

If the cursor is moved while smooth rendering is displayed, the image 
will be corrupted.

White is the default highlight color for CADKEY.  It is possible to
change the CADKEY highlight color but it will not change the behavior of
Picture It.  White is always used by Picture It to highlight
unrecognized geometry. 

Mass properties totals for only mass and volume are sent to the file.

If to objects share a common boundry, the mass proprty calculation may be
wrong.

Lines must connect to endpoints and endpoints must be connected by lines
This is important when using polylines and splines.

TIPS FOR USING THE PICTURE IT UTILITY

Use of gray lines in a model will make the hidden line representation
dificult to understand since hidden lines are displayed in gray. 

The palette used during rendering of Filled Polygons is different from
that used by CADKEY.  A close match will result if RED, GREEN, BLUE,
CYAN, MAGENTA, and WHITE are selected for the filled colors.  

The Mass Properties calculation requires 3 or 4 sided polygons.  If Poly
Vert is set to some value greater than 3 then existing boundaries will
be split until the constraint is met.  This automatic split also happens
before polygons are written to a CADL or SLA file. 

Cylinder idiom can only be constructed using close circles, conics, and
splines.  The down-connect in the cylinder will be treated as a straight
line. 

If you have bound ENTER to a mouse button or tablet use the keyboard 
to select.

To print rendered image save to a level first save the image to a level.

To change the brightness in the smooth shaded results, use the SHADE CONTROL
Light positioning option after filled processing. The speculatity value in
the PICTURE.DAT can be increased to brighten the model.

  PLEASE NOTE:
  If you increase the specularity value in the PICTURE.DAT file, the results
  of a printed smooth shaded image may be light or washed-out.


PICTURE IT MACROS

Two sets of macros have been included with this release. The macros are 
installed in your \mac directory when you install the sample files.
 
Macros included with this release:

Set One: COLS2, COLS3, COLS4, COLS5, COLS6, COLS7 
WARNING: These macros may alter your geometry.

These macros are used to coalesce corner points that do not quite meet 
due to imprecise creation. When a part has been created using another 
less precise cad product and translated into CADKEY, gaps may occur. 
These macros will save all displayed information to a CADL file with
the number of decimal places designated by tracking the number in the name.

The macro deletes all displayed and loads the CADL file back into CADKEY.
This will round the digits up and down.

Set Two:  ARCCUT

This macro will break an arc into an entity that is lying on the arc to 
form a valid Picture It junction.


To use the macros 

1.  Use FILES, MACROS, TXTIN to read the files into CADKEY.

2.  See the Chapter 6 of the Cadkey 6 Reference Guide for details 
    on using macros.




WARNING!

Do not attempt to render flat geometry. If you should start Picture It
on flat geometry you can escape

Polygons on level 255 will be deleted if filled rendering is used.

Geometry that has non-volumetric features may be rendered in surprising ways.


TRANSLATING DIALOG BOX TEXT FIELDS

To translate the text contained in dialog boxes, follow these steps:

1) Enter CADKEY and write down the function key sequence that you press 
   to reach the dialog box that you want to translate. For example, to reach 
   the DETAIL, SET dialog box you press F3 (DETAIL) and then F9 (SET).

2) Exit CADKEY and when you return to the system prompt, set the following 
   environment variable by typing:

set DGREADFL=1<Enter>

3) Start CADKEY from the system prompt, but redirect the program's 
   output to a temporary file by typing:

cadkey > temp.dlg<Enter>

CADKEY stores the temp.dlg file in CADKEY's root directory.

4) Press the function key sequence you recorded in step 1. CADKEY displays 
   the appropiate dialog box.

5) Exit CADKEY.

7) Use your text editor to make the desired changes to the temp.dlg file.

8) Make sure the file always ends with the following three lines:

===========================================================
=============     ENDING   DLG FILE OUTPUT   ==============
===========================================================



8) Save the file and rename it according to the filename associated 
with the related dialog box. You must use the names shown in the 
following list: 

FILENAME        FUNCTION

setmask.dlg     Masking dialog box.
mcrlstex.dlg    Macro LST/EXE dialog box. 
setplot.dlg     PLOT set-up dialog box.
setprint.dlg    PRINT set-up dialog box.
chngattr.dlg    ATTRIB change dialog box.
setattr.dlg     ATTRIB set dialog box.
applic.dlg      APPLIC dialog box.
viewlist.dlg    VIEW list dialog box.
lvllist.dlg     LEVEL name list dialog box.
setdims.dlg     DETAIL set dialog box.
xhatch.dlg      X-HATCH dialog box.
layout1.dlg     NEW layout dialog box.
layout1.dlg     MODIFY layout dialog box.
layout2.dlg     LOAD layout dialog box.
layout2.dlg     DELETE layout dialog box.
layout2.dlg     COPY layout dialog box.
layout3.dlg     LAYOUT confirmation dialog box.
filelist.dlg    Standard file list dialog box.
dirslist.dlg    DIRECTORY dialog box.
message.dlg     Standard file list error dialog box.
hypertext.dlg   HELP dialog box.


8) Before running CADKEY clear the environment variable you set in step 
2 by typing:

set DGREADFL=<Enter>

9) Start CADKEY. To verify that CADKEY is now using your modified .dlg file, 
press the function key sequence to display the appropriate dialog box.
  


MULTIPLE VIEWPORTS

When loading a CADKEY 5 part file depicting multiple viewports in CADKEY 6:

-CADKEY retains all the viewports if you were in Model Mode the last 
 time you saved the part file.

-CADKEY displays only one viewport if you were in DLM the last time 
 you save the part file.


 When loading a CADKEY 6 part file depicting multiple viewports in CADKEY 5:

-CADKEY displays only one viewport regardless of whether you last saved 
 in DLM or Model Mode.

