Changeset 13785

Show
Ignore:
Timestamp:
11/06/03 13:16:25 (5 years ago)
Author:
patrickh
Message:

Regenerate.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/juggler/README.html

    r13686 r13785  
    11<html><head> 
    22      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 
    3    <title>Juggler Project Overview</title><link rel="stylesheet" href="base_style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.62.4"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>Juggler Project Overview</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="othername">The Juggler Team</span></h3></div></div></div><div><p class="pubdate">$Date$</p></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#d0e15">Introduction</a></span></dt><dt><span class="section"><a href="#d0e20">Compiling</a></span></dt><dt><span class="section"><a href="#modules-section">Modules</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e33">VR Juggler</a></span></dt><dt><span class="section"><a href="#d0e47">VR Juggler Portable Runtime (VPR)</a></span></dt><dt><span class="section"><a href="#d0e81">Juggler Configuration and Control Library (JCCL)</a></span></dt><dt><span class="section"><a href="#d0e105">Gadgeteer</a></span></dt><dt><span class="section"><a href="#d0e119">Sonix</a></span></dt><dt><span class="section"><a href="#d0e135">Tweek</a></span></dt></dl></dd><dt><span class="section"><a href="#d0e151">VR Juggler 2.0</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e15"></a>Introduction</h2></div></div><div></div></div><p>Congratulations, you have downloaded the source code to the Juggler 
    4     Project, open source software for virtual reality from the Virtual Reality 
    5     Applications Center at Iowa State University. Within this document, you 
    6     will find information about the new VR Juggler 2.0 directory structure 
    7     including descriptions of all the component modules that make up the 
    8     Juggler Project. Instructions for building the individual modules can be 
    9     found within the specific module directories and on the VR Juggler 
    10     website.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e20"></a>Compiling</h2></div></div><div></div></div><p>For information on compiling the source code, refer to the 
    11     <tt class="filename">INSTALL</tt> file found in this directory.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="modules-section"></a>Modules</h2></div></div><div></div></div><p>The Juggler Project is made up of several modules that have evolved 
     3   <title>Juggler Project Overview</title><link rel="stylesheet" href="base_style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.62.4"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>Juggler Project Overview</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="othername">The Juggler Team</span></h3></div></div></div><div><p class="pubdate">$Date$</p></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#d0e15">Introduction</a></span></dt><dt><span class="section"><a href="#d0e26">Compiling</a></span></dt><dt><span class="section"><a href="#modules-section">Modules</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e42">VR Juggler</a></span></dt><dt><span class="section"><a href="#d0e56">VR Juggler Portable Runtime (VPR)</a></span></dt><dt><span class="section"><a href="#d0e93">Juggler Configuration and Control Library (JCCL)</a></span></dt><dt><span class="section"><a href="#d0e117">Gadgeteer</a></span></dt><dt><span class="section"><a href="#d0e131">Sonix</a></span></dt><dt><span class="section"><a href="#d0e147">Tweek</a></span></dt><dt><span class="section"><a href="#d0e163">VRJConfig</a></span></dt></dl></dd><dt><span class="section"><a href="#d0e175">VR Juggler 2.0</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e15"></a>Introduction</h2></div></div><div></div></div><p>Congratulations, you have downloaded the source code to the Juggler 
     4    Project, open source software for virtual reality from the <a href="http://www.vrac.iastate.edu/" target="_top">Virtual Reality Applications Center</a> 
     5    at <a href="http://www.iastate.edu/" target="_top">Iowa State University</a>. 
     6    Within this document, you will find information about the new VR Juggler 
     7    2.0 directory structure including descriptions of all the component 
     8    modules that make up the Juggler Project. Instructions for building the 
     9    individual modules can be found within the specific module directories and 
     10    on the VR Juggler website.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e26"></a>Compiling</h2></div></div><div></div></div><p>For information on compiling the source code, refer to either the 
     11    <tt class="filename">INSTALL.txt</tt> or <tt class="filename">INSTALL.html</tt> file 
     12    found in this directory.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="modules-section"></a>Modules</h2></div></div><div></div></div><p>The Juggler Project is made up of several modules that have evolved 
    1213    from the original VR Juggler source tree. Within this section, we describe 
    1314    each of the modules, what they are used for, and, when possible, how they 
    14     relate to VR Juggler 1.0.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e33"></a>VR Juggler</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e36"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/vrjuggler</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e42"></a>Description</h4></div></div><div></div></div><p>VR Juggler is still VR Juggler. There are many new features in 
     15    relate to VR Juggler 1.0.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e42"></a>VR Juggler</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e45"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/vrjuggler</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e51"></a>Description</h4></div></div><div></div></div><p>VR Juggler is still VR Juggler. There are many new features in 
    1516        VR Juggler since the 1.0 series, but in essence, it is still the same 
    1617        familiar tool. Of the projects listed below, VR Juggler depends on 
    17         VPR, JCCL, and Gadgeteer. Its individual components have simply been 
    18         broken out into individually developed modules. More information about 
    19         the latest version of VR Juggler is given in the following section.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e47"></a>VR Juggler Portable Runtime (VPR)</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e50"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/vapor</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e56"></a>Description</h4></div></div><div></div></div><p>VPR is the foundation for all the Juggler modules. It provides 
     18        VPR, JCCL, Sonix, and Gadgeteer. Its individual components have simply 
     19        been broken out into individually developed modules. More information 
     20        about the latest version of VR Juggler is given in the following 
     21        section.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e56"></a>VR Juggler Portable Runtime (VPR)</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e59"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/vapor</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e65"></a>Description</h4></div></div><div></div></div><p>VPR is the foundation for all the Juggler modules. It provides 
    2022        an object-oriented, cross-platform abstraction layer to common 
    2123        operating system features such as threads, semaphores, and sockets. 
    2224        All the other modules depend on VPR so that they may be ported easily 
    2325        to other platforms. In VR Juggler 1.0, VPR was the collection of 
    24         directories Threads, SharedMem, and Sync. Since then, that code 
    25         collected into a single library and greatly extended into what is now 
    26         VPR.</p><p>VPR itself contains a great deal of platform-specific code. It 
     26        directories Threads, SharedMem, and Sync. Since then, that code has 
     27        been collected into a single library and greatly extended into what is 
     28        now VPR.</p><p>VPR itself contains a great deal of platform-specific code. It 
    2729        categorizes this code into subsystems, and various subsystems may be 
    2830        chosen depending upon the target platform and target threading system. 
    2931        For example, on IRIX, there are three possible subsystems: SPROC, 
    30         POSIX and Netscape Portable Runtime (NSPR). Win32, on the other hand, 
     32        POSIX, and Netscape Portable Runtime (NSPR). Win32, on the other hand, 
    3133        only uses the NSPR subsystem. The subsystems are:</p><div class="itemizedlist"><ul type="disc"><li><p>SPROC (IRIX only)</p></li><li><p>POSIX (UNIX-based platforms only)</p></li><li><p>NSPR (all platforms, required on Win32 and Mac OS X)</p></li></ul></div><p>Because VPR is the foundation for all the other modules, it is 
    3234        important to choose the right subsystem.</p><p>Choosing the correct subsystem depends on many factors. For 
    …… 
    4648        UNIX-based platforms. On Win32 and Mac OS X, NSPR is required.</p><p>As mentioned above, all the other modules depend on VPR, so it 
    4749        must be compiled before anything else. For more information on 
    48         compiling VPR, refer to modules/vapor/INSTALL.txt.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e81"></a>Juggler Configuration and Control Library (JCCL)</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e84"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/jackal</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e90"></a>Description</h4></div></div><div></div></div><p>JCCL provides the configuration layer for VR Juggler and other 
     50        compiling VPR, refer to <tt class="filename">modules/vapor/INSTALL.txt</tt>.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e93"></a>Juggler Configuration and Control Library (JCCL)</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e96"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/jackal</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e102"></a>Description</h4></div></div><div></div></div><p>JCCL provides the configuration layer for VR Juggler and other 
    4951        modules. The config chunks and reusable configuration editor JavaBeans 
    5052        come from JCCL. These JavaBeans are used by the VR Juggler 
    51         configuration editor tool, VRJConfig. In essence, JCCL is the VR 
    52         Juggler 1.0 Config directory with many new features including 
     53        configuration editor tool, VRJConfig (see below). In essence, JCCL is 
     54        the VR Juggler 1.0 Config directory with many new features including 
    5355        XML-based config files.</p><p>To build the JCCL C++ library, CppDOM is required for parsing 
    5456        XML. CppDOM is a lightweight XML parser written in C++ and designed to 
    …… 
    5860        and it will be built automatically as a dependency of JCCL. JDOM comes 
    5961        with the Juggler Project source code and can be found in the directory 
    60         <tt class="filename">juggler/external/jdom</tt>.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e105"></a>Gadgeteer</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e108"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/gadgeteer</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e114"></a>Description</h4></div></div><div></div></div><p>Gadgeteer is made up of the code that was formerly in the VR 
     62        <tt class="filename">juggler/external/jdom</tt>.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e117"></a>Gadgeteer</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e120"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/gadgeteer</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e126"></a>Description</h4></div></div><div></div></div><p>Gadgeteer is made up of the code that was formerly in the VR 
    6163        Juggler 1.0 Input directory. It contains all the drivers used for VR 
    6264        Juggler input devices, and it contains the high-level Input Manager. 
    …… 
    6567        must still be compiled in, but we hope to generalize the concepts of 
    6668        VR Juggler Managers to the point that the kernel knows nothing about 
    67         them until they are loaded at run time.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e119"></a>Sonix</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e122"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/sonix</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e128"></a>Description</h4></div></div><div></div></div><p>Sonix provides an interface useful to many simple VR and 
     69        them until they are loaded at run time.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e131"></a>Sonix</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e134"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/sonix</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e140"></a>Description</h4></div></div><div></div></div><p>Sonix provides an interface useful to many simple VR and 
    6870        entertainment applications to trigger and position sounds in 3D. This 
    6971        library provides simple audio sound objects on top of several audio 
    …… 
    7375        reconfigurable allowing audio APIs to be safely swapped out at runtime 
    7476        without the dependent systems noticing. Systems using this layer 
    75         expect to be completely portable.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e135"></a>Tweek</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e138"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/tweek</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e144"></a>Description</h4></div></div><div></div></div><p>Tweek is a cross-platform, cross-language library consisting of 
     77        expect to be completely portable.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e147"></a>Tweek</h3></div></div><div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e150"></a>Directory</h4></div></div><div></div></div><p><tt class="filename">juggler/modules/tweek</tt></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e156"></a>Description</h4></div></div><div></div></div><p>Tweek is a cross-platform, cross-language library consisting of 
    7678        a C++ API and a Java API. Its purpose is to provide a convenient 
    7779        mechanism for a Java-based GUI to interact with a complex C++ library 
    …… 
    8587        application simply loads the Beans it finds and presents them to the 
    8688        user in some sort of structured manner (for example, a collection of 
    87         icons with web-style navigation).</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e151"></a>VR Juggler 2.0</h2></div></div><div></div></div><p>TODO... (this is the version number of the next release of Juggler)</p></div></div></body></html> 
     89        icons with web-style navigation).</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e163"></a>VRJConfig</h3></div></div><div></div></div><p>VRJConfig is the configuration editor for VR Juggler. It is a 
     90      complete rewrite of VjControl, both in terms of the user interface and 
     91      the back-end code. The new interface is based on open discussion and 
     92      feedback from users of VR Juggler 1.0 and VjControl.</p><p>The back-end is much more extensible. It allows users to write 
     93      plug-in editors to simplify complex editing tasks. User-defined 
     94      configuration elements can be handled in a much more dynamic manner as 
     95      well. No modification of VR Juggler or JCCL &#8220;<span class="quote">system</span>&#8221; files 
     96      must be made to get user-defined elements into the editor.</p><p>VRJConfig is itself a JavaBean that is loaded into the Tweek Java 
     97      GUI. VRJConfig uses JavaBeans internally to facilitate user extensions. 
     98      All in all, VRJConfig is a highly dynamic, powerful editor for VR 
     99      Juggler configurations.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e175"></a>VR Juggler 2.0</h2></div></div><div></div></div><p>TODO... (this is the version number of the next release of Juggler)</p></div></div></body></html> 

  • trunk/juggler/README.txt

    r13686 r13785  
    2626 
    2727                Tweek 
     28 
     29                VRJConfig 
    2830 
    2931   VR Juggler 2.0 
    …… 
    4244Compiling 
    4345 
    44    For information on compiling the source code, refer to the INSTALL file 
    45    found in this directory. 
     46   For information on compiling the source code, refer to either the 
     47   INSTALL.txt or INSTALL.html file found in this directory. 
    4648 
    4749Modules 
    …… 
    6264   VR Juggler is still VR Juggler. There are many new features in VR Juggler 
    6365   since the 1.0 series, but in essence, it is still the same familiar tool. 
    64    Of the projects listed below, VR Juggler depends on VPR, JCCL, and 
     66   Of the projects listed below, VR Juggler depends on VPR, JCCL, Sonix, and 
    6567   Gadgeteer. Its individual components have simply been broken out into 
    6668   individually developed modules. More information about the latest version 
    …… 
    8082   modules depend on VPR so that they may be ported easily to other 
    8183   platforms. In VR Juggler 1.0, VPR was the collection of directories 
    82    Threads, SharedMem, and Sync. Since then, that code collected into a 
    83    single library and greatly extended into what is now VPR. 
     84   Threads, SharedMem, and Sync. Since then, that code has been collected 
     85   into a single library and greatly extended into what is now VPR. 
    8486 
    8587   VPR itself contains a great deal of platform-specific code. It categorizes 
    8688   this code into subsystems, and various subsystems may be chosen depending 
    8789   upon the target platform and target threading system. For example, on 
    88    IRIX, there are three possible subsystems: SPROC, POSIX and Netscape 
     90   IRIX, there are three possible subsystems: SPROC, POSIX, and Netscape 
    8991   Portable Runtime (NSPR). Win32, on the other hand, only uses the NSPR 
    9092   subsystem. The subsystems are: 
    …… 
    131133   The config chunks and reusable configuration editor JavaBeans come from 
    132134   JCCL. These JavaBeans are used by the VR Juggler configuration editor 
    133    tool, VRJConfig. In essence, JCCL is the VR Juggler 1.0 Config directory 
    134    with many new features including XML-based config files. 
     135   tool, VRJConfig (see below). In essence, JCCL is the VR Juggler 1.0 Config 
     136   directory with many new features including XML-based config files. 
    135137 
    136138   To build the JCCL C++ library, CppDOM is required for parsing XML. CppDOM 
    …… 
    205207   navigation). 
    206208 
     209  VRJConfig 
     210 
     211   VRJConfig is the configuration editor for VR Juggler. It is a complete 
     212   rewrite of VjControl, both in terms of the user interface and the back-end 
     213   code. The new interface is based on open discussion and feedback from 
     214   users of VR Juggler 1.0 and VjControl. 
     215 
     216   The back-end is much more extensible. It allows users to write plug-in 
     217   editors to simplify complex editing tasks. User-defined configuration 
     218   elements can be handled in a much more dynamic manner as well. No 
     219   modification of VR Juggler or JCCL "system" files must be made to get 
     220   user-defined elements into the editor. 
     221 
     222   VRJConfig is itself a JavaBean that is loaded into the Tweek Java GUI. 
     223   VRJConfig uses JavaBeans internally to facilitate user extensions. All in 
     224   all, VRJConfig is a highly dynamic, powerful editor for VR Juggler 
     225   configurations. 
     226 
    207227VR Juggler 2.0 
    208228