home  previous   next  contents

Shout3D™ 1.0 - User Guide

What's Where?

Shout3D 1.0 contains the following directories. All of these are located within the top-level directory into which you installed Shout3D 1.0.

  • docs - contains all of the following:
    • Quick Start Tutorial - a 10 minute introduction to Shout3D.
    • Demos - descriptions and links to all the bundled demos.
    • User Guide - this very guide! How to author for, program, and publish using Shout3D and the Shout3DWizard.
    • Shout3D Specification - technical description of all the elements of Shout3D scenes and applets, and how these elements interoperate.
    • JavaDocs - complete documentation of the Java API for all classes and interfaces in the Shout3D package
  • Shout3d_wizard - contains the Shout3DWizard, an interactive tool for publishing 3D applets to the web. Also contains the VRML 2.0 to Shout3D converter (vrml2tos3d.exe).
  • Shout3D_runtime - Contains all the files you need to run Shout3D applets -- the java classes that comprise Shout3D applets and also the resource files (html, VRML, images, etc) used by the bundled demos. Contains:
    • codebase -- java classes, source code for demos, and assets:
      • applets -- a java package of sample applets (source java included)
      • custom_nodes -- a java package of sample nodes (source java included)
      • models - The 3D models used in the demos. Most of these have 3 versions: a VRML 97 model, a Shout3D format (.s3d) version, and a compressed Shout3D format (.s3z) version.
        • images -- media assets used in the demos
        • sounds -- media assets used in the demos
      • shout3d -- a java package containing the Shout3DApplet and Shout3DPanel, as well as 3 other nested packages
        • core -- a java package containing the core Shout3D classes (source not included)
        • math -- a java package containing some handy matrix and rotation methods (source not included)
        • sound - a java package containing the JavaSound node, for playing sounds within a 3D scene.(source not included)
    • demos - A set of html files. Each loads some assets from the codebase directory into an applet also contained in the codebase directory. Click here to see a web page that describes and links to all the demos.


Copyright© 1999-2000, Shout Interactive, Inc.