
WAVEFRONT TOOLS

This directory contains a number of Wavefront-related shell scripts, data
files, and programs.  This file will attempt to describe the use of these
tools.  But first, a procedure for installing these tools will be given.

Installation:
The following two steps should be performed by either the system
administrator or the Wavefront administrator.

1) Determine a suitable location for these tools.  One possible location
   would be immediately under the top level Wavefront directory.  For
   example, if you have a directory called "/usr/local/wave", you could
   put these files in a directory called "/usr/local/wave/lbin".  The
   following commands will perform this.

   cd /usr/local/wave
   mkdir lbin
   cd lbin
   zcat wavefront-tools.tar.Z | tar xvof -

2) Once installed, edit the following files as described.
   wfrc: Set the path of the WF_AV_DIR environment variable.  This is usually
         set to /usr/wave/TAV4.0 or /usr/local/wave/TAV4.0.
         Set the path of the WF_CMD_DIR environment variable.  This is usually
         set to /usr/wave/lbin or /usr/local/wave/lbin.
         Change the definition of any other Wavefront variable as necessary.
   modrc: Change the path to reflect the location of your wave/lbin directory.

New User Setup: (after the tools have been installed)
The next two steps may be performed by anyone wishing to use these tools and
Wavefront's Advanced Visualizer.

1) Place the following line near (or at) the end of your .login file:

   SETENV WF_PRJ_DIR $HOME/wavefront
   source /usr/wave/lbin/RC/wfrc
     or
   SETENV WF_PRJ_DIR $HOME/wavefront
   source /usr/local/wave/lbin/RC/wfrc

   NOTE:  The project directory is the location under which all wavefront
          jobs will be done.
   NOTE:  This line may need to be modified to reflect the actual location
          of the lbin directory (see your Wavefront administrator).
   NOTE:  After editing the .login file, one must re-login or "source"
          the .login file before attempting to use the software described
          in this file.
   If you have the Wavefront software on only one machine and your home
   directory is accessable from many machines, you may wish to place an
   "if" statement around the previous lines like this:

   if (`hostname` == i1) then
      SETENV WF_PRJ_DIR $HOME/wavefront
      source /usr/local/wave/lbin/RC/wfrc
   endif

   Where "i1" would be replaced with your Wavefront machine name.

2) To create a new Wavefront user directory type:

   cd $WF_PRJ_DIR
   new_dir dname

   where "dname" is the name of the directory to be created.  This command
   creates a directory in which the Wavefront software will properly run.
   It also creates some sub-directories and links to often-used Wavefront
   data files.

Overview:
The way these tools were written was based upon the assumption that Wavefront
obj, pv, and tex files are always kept in sub-directories.  For example, if
you had a directory called "movie", you would not have all obj and pv files
located directly under this directory.  Instead, there would be several
sub-directories, namely: OBJECTS and PREVIEWS.  In each of these
sub-directories the respective files would be kept.  The Wavefront software
accomplishes this by using environment variables.

Tools descriptions:

Shell scripts:
composite:	Composite a number of images over either a static or multiple
		background images.
fade:		Create a fade between to different images.
wmovie:		Produce a movie intro using text from the specified data file.
		See the corresponding man page.
new_dir:	This script will create a new Wavefront directory containing
		subdirectories for objects, textures, etc., and the default
		color.mtl file, etc.
new_pv:		This script will create a new preview file of any name, number
		of objects, and number of frames.
wavefront.1:	Man page giving overall description of Wavefront.

Wavefront scripts:
CMD/bevel:	Model script; places a bevel on the front of any elements in
		the default group.
CMD/bevel2:	Model script; places a bevel on the front and back of any
		elements in the default group.
CMD/extbvlin:	Model script; extrudes elements in the default group along
		the Z direction, then adds bevels to the front and back on
		the inside of the original face outlines.
CMD/extbvlout:	Model script; extrudes elements in the default group along
		the Z direction, then adds bevels to the front and back on
		the outside of the original face outlines.
CMD/extrude:	Model script; extrudes elements in the default group.
CMD/fixcam:	Set the viewport for the main camera
modelcmds.1:	Man page for these command files.

Wavefront data files:
modrc:		A model startup file copied to the users home directory the
		first time "new_dir" is used.  This file contains aliases
		for the model command files.
new.pv		An empty preview file copied to the users Wavefront directory
		when "new_dir" is used.  This preview file is 10 objects by
		100 frames long.
pvrc:		A preview startup file copied to the users home directory the
		first time "new_dir" is used.  This contains aliases used by
		the preview program.
safe.hdr:	Data used by new_pv to create a new preview file.
safe.mth:	Data used by new_pv to create a new preview file.
safe.set:	Data used by new_pv to create a new preview file.
safe_small.set:	Data used by fade to create a new preview file for fading.
4Dgifts.mtl:	A material file created from materials found in the 4Dgifts
                directory.  This file is combined with colors.mtl when the
                "new_dir" command is used.
spectral.mtl:	A Wavefront material file containing spectral definitions
		of a number of metals.  This file is combined with colors.mtl
		when the "new_dir" command is used.
wfrc:		A "run command" file sourced from the users .login file.
		This file sets up the Wavefront environment variables.

Any questions, comments, suggestions may be directed to Wes Barris
(wes@msc.edu).
