                       TERRAIN & OBJECT EDITOR, TED DOCS

TED editor (DOS and WIN32 versions). Copyright 1991-1997 (c) 3000AD, Inc. 
All rights reserved.

--------------------------------------------------------------------------------
                              DESCRIPTION
--------------------------------------------------------------------------------

This editor is used to create and manipulate 3D objects and regions which can 
either be objects such as ships, missiles etc or 3D worlds. The DOS version is
more secure and stable.

It is complemented by two utilities. TED2ASC is used to convert 3DStudio .ASC 
files to .3D and CV3D used to convert the TED .3D binary file to a .3DT ascii 
file and vice versa.

--------------------------------------------------------------------------------
                                     NOTES
--------------------------------------------------------------------------------

- The BCTOOLS.INI file needs to be configured for TEDWIN to work properly. The
  DOS version does not use this file. See the TED.BAT file for usage on the
  DOS version.

- If no filename is specified on the command-line, an empty NONAME.3D is created.

- TED requires STFONT.3D and DEFAULT.PAL to reside in it's home directory. It
  uses them for fonts and palette. DO NOT edit the font file!

- When exiting, TED will prompt and ask you to save the current file. Discard
  changes if you don't wish to save the file

- The keyboard commands for TED are listed in the TEDKEYS.TXT file

- The CV3D.EXE utility is used to convert .3D files to .3DT ascii files. This
  text file can be modified, i.e to change the name explosion animation vectors.
  The utility can convert the .3DT file back to a binary .3D file. You MUST
  specify the /k parameter otherwise the original .3D file will be deleted when
  the .3DT file is created. Make backups because if you screw up the .3DT file,
  you won't be able to get the original .3D file back. MAKE BACKUPS. Type the
  utility without any parameters to see usage.

- The TED2ASC file is used convert 3DStudio files to TED format. See the section
  at the end of this file for a full description on how to use 3DStudio files.
  Type the utility without any parameters to see usage.

--------------------------------------------------------------------------------
                      FAST START OBJECTS VIEWING TUTORIAL
--------------------------------------------------------------------------------

This section is for artists & modelers who just want to view their converted
3DStudio objects. It is NOT meant to be a tutorial on using TED for complex
operations.

NOTE: If you ever lose the cursor, press the [tab] key to snap it back to the
center of the display.

[CONVERSION]

- First using the TED2ASC utility, convert the .ASC+.BMP files to .3D+.PCX files
  Copy the .3D file to your TED 'OBJECTS' directory and the .PCX file to your
  TED 'OBJTEX' directory.

[STARTING A SESSION]

- Start TED

- Then [right-click] to activate the menu. [left-click] on FILE->OPEN. You can
  either type in the full path+filename i.e c:\ted\objects\ic.3d on the status
  line and hit [enter] or hit [enter] at the *.3D prompt to display all the
  files in the current 'OBJECTS' directory. If you use the menu, [left-click] on
  the filename to load the file.

[DECLUTTERING THE DISPLAY]

- Once the file loads, if it previously had vectors in it, then the image will
  be cluttered. To declutter it, move the mouse to the palette bar at the bottom
  of the screen and [right-click] on the following colors indices, 10, 11, 12,
  13. To disable the display of text only and leave the vectors intact, disable
  color 255. Disabling the color index also disables the text because the filter
  uses the color and there disables everything using that color. This does not
  affect texture maps. Press [shift+d] to do a screen re-draw if necessary.

  NOTE: The colors are numbered 0-255 from left to right with 0 being black.
        You can later use [shift+d] to enable all colors and force a redraw.

[VIEWING]

- Now that the file is de-cluttered, you may want to view it. By default and
  unless you used the /q command-line parameter, TED will display all four views
  and resize the object within each view. You can zoom to any area of the object
  in any window in the following manner:

  * First press [`] or to de-activate the mouse snap grid cursor. Using
    this will limit the cursor to grid constraints.

  * To define the viewing area, you need to draw a box. To this press [z] and
    when the cross-hair cursor appears, [left-click] on the TOP-LEFT corner that
    defines the box you wish to draw around the object and [left-click] a second
    time to define the LOWER-RIGHT corner of the box. The object will now zoom
    to fill that area in all visible views. Using this method, you can zoom to
    a section of an object or view the whole object by drawing a box around it.
    You can press [ESC] at anytime to cancel a command in progress.

  * Use can also press [shift+z] to zoom and center the object within the
    current view. This resets the view and displays the entire object. You will
    notice that sometimes the object will not fill the display, this is because
    it is also taking into account the extents of the animation vectors which
    are usually larger than the object. Even if those vectors are invisible, it
    still calculates them. Zooming the ISO view guarantees that the object will
    be display in full inside all four views. Don't forget to position the
    cursor inside the view you wish to zoom.

  * To zoom a view to full screen, activate the menu with a [right-click] and
    select the desired view from the VIEW menu option. You can also use the [-]
    and [=] keys to zoom the area below the cursor. You can also use the
    ALT+F1, ALT+F2, ALT+F3 and ALT+F4 view hot keys. Press [F9] to revert to
    all four views.

  * The isometric view is useful in viewing the ship from a variety of angles.
    Zoom the ISO view to fullscreen by pressing [alt+F4]. Press [end] to
    activate the viewing reticle (only works in ISO view). The X marks the
    current default viewing angle+orientation. Experiment by using the mouse
    to [left-click] anywhere on the reticle to change the viewing angle. Once
    the screen redraws, press [end] again to activate the viewing reticle.
    With practice, you'll figure out how it works. Read the manual below, for
    a more detailed description of how this view works. To revert to the
    default viewing angle, [left-click] somewhere along the 5 o'clock angle
    and on the third ring from the edge (the one just before the yellow ring).

    Do a redraw to remove the ISO reticle and press [ESC] to remove the
    crosshair cursor.

  * You can change the background display color by pressing [F1]. This changes
    it to color 0 (black). To select a new background, [left-click] the
    desired color on the palette bar and press [F1] again to set it as the new
    background color. If you pick a lousy color, press [F1] to reset it to color
    0 and try again.

  * To view difference rendering of the object, activate the viewing menu from
    the menu and pick an option in the VIEW->RENDER option tab.

    Note: TED does not handle surface removal very well because it is not as
    complex as the BC3K renderer, so expect to see some strange clipping and
    sorting anomalies when the object is rendered in any non-wireframe mode.

[VIEWING TEXTURES]

- You can view the textures in the OBJTEX directory by pressing [alt+t].
  Textures are displayed in there actually size and may require several pages.
  Press [Page-Down] to display subsequent pages. You can [right-click] to
  remove the the texture display. It is also removed once the last page is
  displayed. To find out the name of a texture, move the cursor over it and the
  name will be displayed in the status bar.

  If you don't know which texture goes with an object, you can convert the
  the .3D file to .3DT and look at the file.

  Note: Unless you know what you're doing, I would advise against assigning or
  manipulation textures in TED. It is complex and tricky. Use 3DStudio instead.

[DIMENSIONS]

- You can get accurate file dimensions using TED. First, move the mouse into the
  PLAN view and press [F6] to cycle through and display different grid types.
  The current unit dimension is displayed at the lower left corner of the
  display. If you are viewing in Feet, then 1:10FT is display indicating that
  each grid is 10 Feet square. You can then count the number of grids the object
  segment spans. You can change the viewing units from the UNIT menu.

  For accurate pin-point calculations, press [t] or [shift+t] to start drawing a
  line. When the crosshair appears, [left-click] at one end of where you want to
  start checking the length. Once you click, the L: value on the status bar
  will read zero, ie L:0. As you move the mouse, it will be updated to reflect
  the current line length. Once you have measured the segment length, you can
  press [escape] to cancel the line drawing action. If you accidentally do a
  [right-click], the line will be drawn and become a part of the object. You
  can either delete it by typing [shift+e] and [left-click] on the line or
  or you can reload the object to be safe because you may delete the wrong line
  and one that is part of the object.

  You can also scale and resize objects in TED but I would advise against it.
  Try and use the proper dimensions in your 3DStudio file in to prevent any sort
  of resizing in TED. It works but requires a knowledge of TED. You can resize
  objects from the GROUP menu.

[SAVING FILES]

- If you want to make a different copy of your working file, use the
  FILE-SAVEAS menu option and type in the drive+pathname for the file. TED
  does NOT like files that reside on other drives so try to keep all your files
  in the current drive and perhaps in a \TED\WORK directory. You can then move
  all your final file versions and textures to \TED\FINAL. You can also set up
  a temporary environment for OBJTEX and OBJECTS by simply modifying the SET
  statements in the TED32.BAT file to point to different direcories.

[ENDING A SESSION]

- To exit TED press [F10] and press [y] to exit without saving the object. You
  can also exit by using the FILE menu.

- TED was originally developed to create objects from scratch (which it does) as
  well as for constructing the 3D layout of the game galaxy. It is a developers
  tool and artists were more comfortable using 3DStudio rather than learning 
  TED, so the TED2ASC converter was created. TED is now primarily used by 
  artists to view the results of their converted objects created in 3DStudio 
  where all construction, layout, scaling etc, are done. Once the object is 
  accepted, I then go in, using TED, and put in all the required vector entities 
  and any last minute scaling operations if necessary.

  TED has a different lighting/sorting scheme than the BC3K engine and therefore
  is less accurate. To view your object as it would look in the game, you can 
  use BC3K as a viewer. In this example, I am using BC3K to view the player's 
  own Battlecruiser. In BC3K, you can use the arrow, ins, home, del, end keys 
  for rotation, viewing etc. You can exit as normal by using ALT+Q

            bc3000ad /q /o\gbs\scenery\objects\bcruzmk2.3d

  Note: You can also use the VIEW3D.BAT file. Type 'view3d bcruzmk2' to view
        the object. Be sure to edit the VIEW3D.BAT file to match your settings.

--------------------------------------------------------------------------------
                           IMPORTING 3DSTUDIO FILES
--------------------------------------------------------------------------------

TED has the ability to support converted 3DStudio files .ASC ascii files. The
TED2ASC.EXE utility is used to convert from .ASC to .3D. It also converts the
.BMP files to the .PCX files that TED reads. This utility was written so that
artists and modellers who are already familiar with this popular program can
begin to create models right away without learning how to use TED. For these
artists, TED is only used to (a) view the object to make sure it converted ok.
How it's displayed in TED is exactly how it will look in the game (b) to assign
the object vectors which BC3K requires such explosions, animations, guns etc.

Steps are

  - Create .3DS object and save as .ASC complete with .BMP textures
  - Use TED2ASC to convert the .ASC+.BMP to .3D+.PCX
  - Copy the converted .PCX files to the TED 'OBJTEX' directory and copy the
    .3D files to the TED 'OBJECTS' directory.
  - Startup TED, load the object, verify that it's ok and apply the required
    vectors.
  - Save the file

  * If later you decide to change the explosion vectors i.e in the instance when
    new explosions are done, you can use the CV3D utility to conver the .3D file
    to a .3DT ascii file, locate the @animation line and change the vector. Use
    the utility to convert the .3DT file back to the .3D. Editing a text file is
    faster than loading the 3D file in TED and doing it from there.

  * Running CV3D.EXE with no parameters shows usage

===============================================================================
            SPECS FOR BUILDING 3DSTUDIO REL4 OR MAX OBJECTS FOR BC3K
===============================================================================

- Objects should have a LOW poly count. This is a game and speed is important. 
  For objects of interest, you can go as high as 250 polygons. If you can 
  do it for less, do it. Just keep it simple.

  Note: Because of the 3D accelerated feature now in BC3K, poly counts for
  objects can double but these will only be used when the 3D version is running

- The textures should be created using the BC3K palette which is in the
  DEFAULT.PCX file.

  The palette must NOT be altered and DO NOT use any of the entries in the
  upper range (they are blacked out) because they are reserved for dynamic
  runtime modification by the program.

  NOTE: This is for BC3K v2.0x only because all future versions use 16-Bit
        non-palettized textures.

- Texture sizes MUST be a power of 2 and must not exceed 128x128.

- Do NOT use ANY dithering in the textures. Keep the coloring 'clean'
  Your textures (materials) can have features on them or just be composed
  of a plain single color.

- Textures should be saved in .BMP format. When you save them, make sure
  they match the palette provided. Some programs reverse the palette. Watch
  out for this!

- Try to share the textures if possible, ie create a stock set of textures
  but try to make sure the objects don't look the same.

- Color 0, black, is used for transparency, so if you need black in your
  texture, use another color that's close to black or it will be transparent
  Use color 16. Do NOT use color 0 in *ANY* of the textures.

- The files must be in .3DS and converted .ASC format. A complete object
  consists of the .3DS and .ASC files, as well as all .BMP textures. 3DS MAX
  has crappy .ASC file support, so you need to know what you're doing if you
  don't have 3DS Rel 4. Converters are located here:

              http://ourworld.compuserve.com/homepages/thbaier
              http://www.okino.com

- IMPORTANT: Some converters, even the one that comes with MAX will create an
  improper .ASC file which will cause TED2ASC to choke on the .BMP->PCX
  conversion. Here's why:
  
   Material: "mytexture"  <- incorrect
   Material:"mytexture""  <- correct
   
   When you convert the .3DS file to .ASC, use a text editor and check to see
   if the line above are in the correct format. If not, then use the editor's
   search & replace function to change all 'material' lines so that there is
   no space between the : and the " in the material name. If not, TED2ASC will
   be unable to convert the .BMP texture to .PCX and complain that it cannot
   find the named material (texture).

- Files should be named according to the theme, ie build1.3ds, build1.asc etc

- When assigning the material in 3DS or MAX, you MUST give the material the
  SAME name as the texture file. This is because TED2ASC converts the .ASC
  file to the required .3D format and it uses the image file name to assign
  the texture. Take a look at the attached .ASC files in the ASC directory for
  samples.

  If you have a texture called dirt.bmp, give the material the same name,
  ie 'dirt'. Then, in the .ASC file, it will be listed as 'material: dirt' in
  the materials section of the .ASC file.

  TED2ASC looks for the texture in the 'material' line and converts it. If it
  finds a material called 'my material' it will choke. If it sees 'material'
  and there is a material.bmp on disk, it will work ok.

- When creating objects, they _must_ be SINGLE entities! So if you are doing
  a structure with several parts, be sure to decompose them so that they
  become one single object. If not, the converter will choke. The converter
  does not yet support multiple entities, so if you're doing say, a marine and
  you created the arms/legs/torso etc, separate, be sure to combine them into
  a single object before sending. In the future, the converter and BC3K will
  support multiple entities so that animated objects can be created as well
  as skeletal ones.

- NO intersecting polygons in the object

- The front of the object must face East, (to the right)

- When you convert the .ASC+.BMP file to .3D+.PCX using TED2ASC, copy them to
  the OBJECTS directory and view them in TED. TED does not have advanced
  sorting or lighting routines, so if you see sorting anomalies in the file
  that are not present in the 3DS version, ignore them.

--------------------------------------------------------------------------------
                                     UNITS
--------------------------------------------------------------------------------

By default TED units are megameters, mm. To get acceptable accuracy it is
important to use larger units of measure. The Foot is recommended as the
minimum practical unit. You can change units in the process of drawing, but it
is best to stick to either imperial or metric units.  The units you are
currently using are saved with the file.  Astronomical Units are for a
special purpose and should not be used for normal drawing tasks. Units can be
changed using the Unit menu.  You can see which units are in effect by looking
at the status line.

--------------------------------------------------------------------------------
                                  STATUS LINE
--------------------------------------------------------------------------------

Some operations require an optional parameter N to be entered, ie when drawing
an N-sided polygon. The amount is entered on the keyboard as normal and causes
the status line to shift to the right by the number of digits. This N value
remains in effect for ALL operations!

[file][revision]:[group][shading][identifier] [L:] [X:][Y:][Z:] [unit]

[file]        - current file
[revision]    - revision of current file. Either r8 (16-bit) or r9 (32-bit)
[group]       - current working group
[shading]     - current shading option
[identifier]  - name of primitive that was last selected or the name of a
                primitive that uses a point that was last selected.
[L]           - distance from last selected cursor location to current location
[X]           - distance along X axis from 0,0,0 origin
[Y]           - distance along Y axis from 0,0,0 origin
[Z]           - distance along Z axis from 0,0,0 origin
[UNIT]        - current unit of measurement

--------------------------------------------------------------------------------
                                   PRIMITIVES
--------------------------------------------------------------------------------

The two basic primitives in TED are "tip to tail line" (TT-Line) and the
"group instance", the former is used as the basis for boxes, polygons, random
lines etc, and the latter is used to call up a "group" which is an aggregate
of primitives that can be treated as a single entity. The TT-line primitive
is referred to as a STRUCTURE in this documentation.

--------------------------------------------------------------------------------
                                     GROUPS
--------------------------------------------------------------------------------

A group is a collection of primitives that can be manipulated as a single
entity. The entire drawing is contained in the "MAIN" group.

Each group has a group name (distinct from primitive names). For a group
to be visible it must be "called up" or instanced. Each instance of the
group may modify the basic group by rotating or scaling it. Each instance
may also have an primitive name that gives special meaning to that instance.
It is best to design groups so that it is not necessary to subsequently
scale or rotate it when instancing, as this will add overhead.

Group instances can be moved or copied or erased just like primitives. If
you select a group instance and erase it, the instance is erased, but the
group itself is not effected. Erasing all instances of a group will not
destroy the group itself. If you have erased all of the instances of
a group, the only way to make a new instance is by calling up the group using
the "Group Menu/Call up group" command.

The group itself is protected and you cannot modify it, you can only change
it's instance.

To make changes to the group itself you must make it the "WORKING GROUP"
using the "Group Menu/Set Working group" command. When you are working on a
group, you cannot see or access the parent group that instances the working
group. Changing the group will effect all instances of the the group in the
parent group. If the group is visible (instanced) you can also change to it
by using the "w" command and clicking on the reference point of any instance
of the group. You can go  back to the parent group (the one that instances
the present working group) by pressing "W".

You can make the group a part of the current group by FRAGMENTING the group.

You can make reference to a group that does not yet exist. You do this
by calling up a group "Group Menu/Call up Group" and when asked select DEFER.
When the group is later created the instances will come into effect. Until
that time you can only see the instance (which appears as a small + on
the screen, with the group name).

If you delete a group using the "Group Menu/Delete Group" command, none
of the instances are effected. However, renaming a group using
"Group Menu/Rename Group" will rename the group and change all instances
that reference the group to maintain a link to it.

The "Group Menu/Optimise" command will delete any groups that are not
instanced. This will clean up any unused groups in the database.

You can include groups from another file in the current database by merging
the file with "Group/Merge". This places all the subgroups of that file into
the current group using the filename as the group name. You must then make
an instance to the group using "Group/Call up" to include the group into the
database.

If you Merge a group in this fashion and do not change the name of the group
(using the rename facility) so its name still ends in ".3D" then the merged
subgroup will NOT BE SAVED with the graphics. Any changes you make to the
subgroups of the .3D group will be lost! BUT when you re-load the current
file, the Merged group WILL BE RELOADED from the original file. This allows
you to make reference to the group AS A LIBRARY ITEM. If you rename the group
so it DOES NOT END IN .3D it will become a part of the current file and be
saved with it.

Therefore renaming a group you create to <something>.3D will mean that
it will NOT BE SAVED. This facility can be useful for instancing groups
that will be created later.

--------------------------------------------------------------------------------
                                   IDENTIFIERS
--------------------------------------------------------------------------------

An identifier or name, is simply an optional label that is attached to a
primitive. Names work like colours in that you can identify a "current name"
("i" command), and all objects you subsequently create will take on that name.
Alternatively you can set/change the name of objects previously created to the
current name using the ("I" command), or SELECT. If the name is set to nothing,
then no name is applied to an object, and any previously defined name is removed
when using the "I" command. If you copy an object, the new object will have the
same name as the orignal. If you select a point using the TAB key, then the
name of the first structure found that uses that point will be displayed on
the status line.

The purpose of names is to add non graphical data to the graphics database
such as defining planes, animation frames, ai parameters, shading effects etc.
Identifiers can be 'turned off' either by (a) turning off color 254 in the
palette (b) by turning off the color it is drawn. Both operations can be
performed by putting an x in the palette box using the right mouse button.

Valid identifiers.

= The object has two sides. Use this for "thin wings". This turns off any
  backface removal for the object.

* indicates the object should be gouraud shaded.

- indicates the object should be a constant colour, and not light source
  shaded. Overrides "*" (above).

+ indicates that the object is not to be filled but treated as a wire frame
  polygon. Note that this character does not imply "two sides" (see = above)
  since the object may be a surface feature. The name should have have both
  characters in it if a twosided wireframe shape is actually desired.
  Overrides "-" and "*" (above).

@ Defines an animation file associated with this object.

/strobe,x - a strobe light vector. x determines on/off interval

/gun:name - direction and location of laser gun. Also indicates firing animation

/missile:x1,x2,x3

         - launch direction and location of missile bay. Also indicates default
           missile types and number

/attach:turret - direction of turret firing vector

/mine:x - launch direction and location of mine bay

/ods:x - launch direction and location of ODS bay

/escape_pod:x - launch direction and location of escape pod. x is pod type

/cockpit - direction of cockpit vector

/probe - launch direction and location of probe launch bay

--------------------------------------------------------------------------------
                                 POINT SHARING
--------------------------------------------------------------------------------

The points used for a structure can be shared amoung several primitives.
There are some disadvantages to point sharing, but it is important in
reducing the memory requirements of the graphics data and speeding processing
in the STE.

A group instance has only a single point you can manipulate at any time.
This point is drawn as a small "+". Usually the name of the group the
instance refers to is drawn below the +. If the instance is named, the
name used is shown instead (above the point).

A structure can share a group instance point, and this has certain advantages.
For example you can join a set of instances with a TT-line. If you move
the TT-line (shift all it's points) all instances that share points with
the tt-line will also move. Rotating and scaling the TT-line will also
effect the instance points, so the instances themselves will move (but they
will not themselves change scale or orientation).

Sharing of points becomes a problem when you want to operate on a single
structure and you cannot distinguish it from another primitive that shares
its points. One solution to this is to use the add point command to add a
point temporarily to one of the primitives. This added point is part
of one of the primitives only.

--------------------------------------------------------------------------------
                                    PALETTE
--------------------------------------------------------------------------------

The lower part of the display shows the palette. You select the current
colour by clicking on it with the left mouse button. A box is drawn around
the current colour. If you select a colour with the right mouse button so
an X is drawn over it, then that colour is "turned off". Turned off
colours are not shown during a re-draw. Structures that use turned off
colours cannot be selected either individually or using the SELECT command,
and cannot be picked (using the TAB key). Colour Index 254 (white) has special
significance, and display of text is disabled if there is an X in this
colour. When the crosshairs are in the palette area, the index of the
colour nearest the crosshairs is shown on the status line. An example of this
feature is implemented whilst working in groups.

TED uses the DEFAULT.PAL file by default since it contains all the universal
colous for the palettes.

--------------------------------------------------------------------------------
                                  CONSTRUCTION
--------------------------------------------------------------------------------

Rectilinear forms constrain new lines so that they are vertical or horizontal.
In most forms, you select points by clicking with the left mouse button and
start a fresh structure by pressing the right mouse button. pressing the right
mouse button twice in succession will usually terminate the present
construction and return to the outermost command level, but entering most
commands will also terminate the present construction. The N-sided figure
construction allows a PREFIX that specifies how many points are to be
generated in the figure.

The construction takes on the current colour and name. The current colour is
defined by the boxed entry in the palette. The current name is defined by
the Identify command.

The constructions Extrude (x), (X) and Peak (k) commands are somewhat
different.

The Extrude commands require you to select a control structure and then one
or more object structures.

A N-sided figure primitive is activated by pressing "n".  The number of sides
is by default 8 (regular octagon), but this can be modified by entering a
numeric prefix. The figure is drawn by selecting a centre point, and a vertex.
The prefix is stored for later use. N-sided figures a presently always drawn
parallel to the X-Y axis. A rectilinear form "N" forces the second point to be
left/right/above/below the first point. Otherwise the second point can be
anywhere in the window. N-sided polygons are useful for drawing boxes at odd
angles, for generating cylindrical solids using extrude, and for constructing
circle approximations. For high values of N, there is insufficient storage
allocated for full banding. In this case only part of the figure will be seen
during banding. 32 is best for drawing a circle.

--------------------------------------------------------------------------------
                              SOLIDS OF REVOLUTION
--------------------------------------------------------------------------------

EXTRUDE:

The first (original) form of extrude (x) actually works like a surface of
revolution operation. The path should be an open tip-to tail or rectilinear
line. If the base object is a regular polygon (eg formed using
the N-sided polygon construction), then surface of revolution is exactly what
this extrude operation does; the path is rotated about the objects centre
(calculated as the mean of its points), creating 4 sided polygons in the
process. Irregular polgons or open structures may be used for the base
object, giving predicatable results.

The first point of the path is attached to the first point in the
base polygon, so if the path is drawn from "bottom to top" then the final
object will be drawn from bottom to top. The "cutting depth" is determined
by the X value of the path. If the X value of a point is greater than (to the
right of) the first point, the object will be thickened at this point. If the
X is less than (to the left of) the first point, it will be thinner. If the
X is so far to the left as to result in -ve thickness, the results will be
unpredictable.

The axis of revolution is defined by a vector normal to the plane of the base
polgon (or other object). The normal is calculated using the first two points
of the object and the mean point. If the object is not planar, results will be
unpredictable.

The base object becomes the base of a solid structure, and the newly created
structure is made into a subgroup of the working group, called EXTRUDEnnnn.
Since the object is now a subgroup it is not possible to change the object
(or select points on it with the TAB key), but it is possible to
move/copy/erase & rotate/scale the object. Extruded objects have their
origin set at the mean of points in base structure, This is so that scaling
the object in Z will not effect the Z position of the base, which is desirable
if the object rests on another object. Yo can effectively change the origin
by "working on" the extrusion group and shifting all its points.

The second extrude operation (X) does perform a extrusion in the literal
sense. This time you specify a polgon as the "shape" and one or more tip
to tail lines as the object to change. This will result int a "pipe" type
construction.

The control shape may be drawn in any orientation, the system will rotate
it as required so that the first face in the pipe perpendicular to the
direction of the path. Note that this implicit rotation can produce
unpredictable results if the control shape not a regular polygon. In order
to minimise confusion it is recommended that the control shape is drawn
in a DIFFERENT window to that used for the path lines (not the iso window!!).

Like the previous form, this extrusion method will make a new group (called
PIPEnnnn), however the original path remains in the working group. This is
due to the anticipated use of this function for creating surface detail (eg
roads), that must be visible in simplified form from a distance.

PIPES:

Roads can be made from "flat" pipes, ie you can specify a line in place of a
polygon for the intial control shape, and this will convert a TT-line into
solid flat shape, with a width the same as the length of the shape line. Since
this is a 2D construction, there is insufficient information to perform an
implicit rotation of the control shape to produce a butt-end, therefore the
current window is used to DEFINE the plane of the resulting shape. Therefore,
in scenery work, use the PLAN view for a "road", and the FRONT view for a
"fence".  Only the length of the control shape is used and it may be drawn in
any of the views.

PEAK:

The Peak (k) command creates new structures, but it does not form a new group.
This function will break an existing primitive object with N sides into
N new primitives that all share a common point that can be shifted. The
original object is destroyed. This is the easiest way of adding irregularity
to objects, or to form mountains.

--------------------------------------------------------------------------------
                                 ISOMETRIC VIEW
--------------------------------------------------------------------------------

Pressing the END key will display a polar grid in the current window. The
best window to select the grid in is the plan view, but meaning of the
grid is the same in all views. Superimposed on the grid is a large X, which
represents the present setting. You change the iso view direction by clicking
with the left button somwhere on the grid. If the grid is displayed in the
plan view, it is easy to determine the correct place to click.

Clicking anywhere ON the YELLOW circle will set a 0 pitch angle, like looking
parallel to the ground. clicking INSIDE the YELLOW circle
will set the view so you are looking at the objects from UNDERENEATH. OUTSIDE
the circle is from ABOVE. The innermost circle of the grid represents a view
looking straight UP, and the outermost circle a view pointing straight DOWN.
Usually (and for scenery, always), you will select a point OUTSIDE the yellow
circle.

To determine the correct place AROUND the grid you simply imagine a line
from the place you click to the centre of the grid, and mentally superimpose
that line on the plan view below. This will be the view direction.

You can also use the grid as a rough measure of angles. The centre of the
grid is at the current screen centre, so you may wish to set one end of
a line at this point. This can be done by pressing TAB to precisely find
the point and then press "o" to reset the origin to that point.

--------------------------------------------------------------------------------
                           DRAWING COORDINATE SYSTEM
--------------------------------------------------------------------------------

Sometimes it would be convenient to draw in a plane that is orthogonal to
the usual X,Y,Z co-ordinate system. For example if you have created an
extruded shape and you wish to add surface detail to a face that is at
an odd angle. To change the drawing co-ordinate system press "l" (think of
the capital "L" as looking like graph axes). You should then select 3 points
on the face. The order of the points is significant. The first two points
define the new X axis, and you should select the point you wish to be "on
the right" first. The third point defines which side of the face you will
operate on. In most cases you want to work on the outside of the object.
The third point would be above the first two points if you want to work on
the outside, AND you are presently "looking at" the outside of the face.
Otherwise you should make the third point BELOW the first two points.
If the points you select all lie on a line, the program will probably crash,
so always save the file first if you are not sure what you are doing!

To revert to the standard co-ordinate system, press "L".

--------------------------------------------------------------------------------
                                TEXTURE MAPPING
--------------------------------------------------------------------------------

Textures can be applied to polygons. Transparent textures are also supported.
In this manner, decals (smaller textures) can be applied to an already textured
polygon.

To texture map all polygons in an object, first call up the texture menu which
will display all detected textures in the directory. Click on the desired
texture to use. The currently selected texture is bounded by a yellow box. Next
select 'select multiple' from the EDIT menu or use the <S> command. Draw a box
around all the polygons you want texture mapped with the current texture. Next
select 'texture structure' from the SELECT menu. Decals are applied in the same
manner. TED expects textures to reside in the path specific by the OBJTEX
environment.

--------------------------------------------------------------------------------
                              ANIMATION VECTORS
--------------------------------------------------------------------------------

TED uses special animation vectors to for various effects. The animation frames
are stored within BC3K. When it parses a file at runtime, it checks the
animation vectors and plays them accordingly. All the objects contain explosion
animations which BC3K interprets and plays at runtime. The identifier for the
explosion is entered in the file as follows.

syntax: ANIMATE-<type>[[[,<repeat>],<sequence>],<first frame>]

<type> eg XPL1,METEOR,SMK etc from .CAF filename

<repeat> 0 for once only, -ve for infinite repeat (default), otherwise
         number of times to repeat

<sequence> frame number from start of scene to begin animation (default 0)

<first frame> first frame of animation to display (default 1)

Creating "destroyed sequences"

If an object is destroyed, a destroyed sequence is played for it. The
exception to this rule is laser objects.  For lasers it is only played if the
laser impacts a target or the ground. The destroyed sequence for an object
starts at frame N. N is usually a negative number, which is calculated by
finding the animation object with most negative frame number.

N increments for each frame (assumed as 100mS).

The "destroyed" anim always starts at the most negative sequence number.
When an animation sequence number equals N that animation is begun.
For N >= 0, the base object is not displayed.

In this example, the first animation is played and the second starts just before
the object disappears at frame 0.

@animate-xpl1,0,-32
@animate-xpl2,8,-1

During normal display of the object the animation elements must not be
displayed. Therefore, the animation name must be prefixed by "@". Objects
with names containing @ are not drawn unless the object is "destroyed".
The animation is played only when there is a transition from "operational"
to "destroyed" status. After N=0 objects not named @ are not displayed,
and only objects named @ are displayed.

The minimum N is -127, the maximum is +127

--------------------------------------------------------------------------------
                                  VECTOR KEYWORDS
--------------------------------------------------------------------------------

BC3K interpretes certain keywords which it uses at runtime. Vectors can be any
color but by using a uniform scheme, it will be easy to disable these vectors.
For instance, I use color 10 (green) for explosion animation vectors.

/gun:<type>      - Gun animation
/missile:<slot>  - Missile slot
/ship:<slot>     - Ship launch bay
/pod:<slot>      - Escape pod launch bay
/turret:<slot>   - Turret slots
/cockpit         - Cockpit directional vector

--------------------------------------------------------------------------------
                        EXPLOSION ANIMATIONS
--------------------------------------------------------------------------------

NAME                NUMBER OF FRAMES        DESCRIPTION

XPL1                     8                  Explosion
XPL2                    10                  "
XPL3                     9                  "
XPL4                     9                  "
XPL5                    16                  "
XPL6                    16                  "
XPL7                    17                  "
XPL8                    10                  "
XPL9                    16                  "
XPL10                   16                  "
XPL11                   16                  "
XPL12                   16                  "
XPL13                   16                  "
XPLG1                   16                  Mushroom cloud explosion
XPLG2                   16                  Explosion
XPLG3                   16                  Fire
XPLG4                   16                  Smoke
XPLG5                   16                  Fire+Smoke
