You can of course compile the codebase by hand using javac. This is entirely possible, and we make sure to architect the codebase so that you will not get caught with needing to compile 3 different directories simultaneously. However we do recommend using the build environment because it makes life soooooo much easier.

Win32

Unix

MacOS

Environment Settings

   /home/justin/projects/j3d.org/aviatrix3d

  c:/cygwin/home/justin/projects/j3d.org/aviatrix3d

Many people have their own, personal classpath setups too. The makefile that comes with this codebase ignores you standard CLASSPATH. To include and of that system-level information, you can define another variable called PROJECT_CLASSPATH. This is used to bring in any other general/system JARs that you might wish to include other than the those used internally. The typical usage is to write the following:

  export PROJECT_CLASSPATH=${CLASSPATH}

J3D_HOME=${HOME}/j3d.org
J3D_DOS_HOME="c:/cygwin/home/justin/j3d.org"
J3D_SVNROOT=":pserver:anonymous@cvs.j3d.org:/cvs/j3d/cvsroot"
J3D_AV3D_HOME=${J3D_HOME}/aviatrix3d
J3D_AV3D_PROJECT_ROOT="${J3D_DOS_HOME}/aviatrix3d"
J3D_BASE_CLASSPATH="${TEST_CLASSPATH}"
J3D_AV3D_CLASSPATH="${J3D_AV3D_PROJECT_ROOT}/classes"
J3D_AV3D_CLASSPATH="${J3D_AV3D_CLASSPATH};${J3D_AV3D_PROJECT_ROOT}/config"
J3D_AV3D_CLASSPATH="${J3D_AV3D_CLASSPATH};${J3D_AV3D_PROJECT_ROOT}/images"
J3D_LIB_PATH=
J3D_PATH=$PATH

cd()
{
  case $# in
    0)  builtin cd $HOME
        ;;
    1)  builtin cd $1
        echo `pwd`
        ;;
    2)  dir=$1/$2
        if [ ! -x $dir ] ; then
          echo $2 does not exist
          builtin cd $1
        else
          builtin cd $dir
          echo `pwd`
        fi
  esac
}

j3d()
{
  export PROJECT_HOME=${J3D_AV3D_HOME}
  export AREA=j3d
  export PS1="[$AREA \W] \$ "
  export SVNROOT=$J3D_SVNROOT
  export LD_LIBRARY_PATH=$J3D_LIB_PATH
  export PATH=$J3D_PATH
  export PROJECT_ROOT=${J3D_AV3D_PROJECT_ROOT}
  export CLASSPATH="${J3D_BASE_CLASSPATH};${J3D_AV3D_CLASSPATH}"

  cd $PROJECT_HOME $1
}

Using the Build Environment

  bash$ cd $PROJECT_ROOT
  bash$ make

• class - Generates just the class files
• jar - Compiles the code and creates a JAR file
• javadoc - Creates javadoc for you
• clean - Cleans up everything!

• make The makefiles for building the code
• config Runtime configuration files and images (if defined)
• docs Project documentation and the generated javadoc
• src Source files for the project. Sub directories broken down by implementation language
• examples Example code to show how to use the toolkit

Building the class files

   [j3d aviatrix3d] $ cp make/Makefile .
   [j3d aviatrix3d] $ make clean
   [j3d aviatrix3d] $ make class

If you only wish to recompile a single directory then you can change to that directory and just type:

   [j3d aviatrix3d] $ make

Building JAR files

   [j3d aviatrix3d] $ make jar

Building Javadocs

Firstly change into the $PROJECT_ROOT/java directory. There you will find a file called Makefile. Open this up in your editor of choice and go to the very bottom of the file. There you will find a variable called LINK_URLS. Edit the values there to suit your system. Make sure you follow the instructions there and put fully qualified URLs.

Now, to generate the documentation, change back to the project root directory and type

   [j3d aviatrix3d] $ make javadoc

Example Code

To run the demo code after you have compiled it, change to the appropriate directory and run the class file with the normal java command. You will need to be in the directory where the .class file is normally as a lot of the examples reference resources, like images for textures, using relative file paths.