Changeset 18919

Show
Ignore:
Timestamp:
05/30/06 15:42:53 (2 years ago)
Author:
patrick
Message:

List the dependencies for each module.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/trunk/doc/INSTALL.xml

    r18918 r18919  
    129129 
    130130      <section> 
    131          <title>Important Note for Win32 Users</title> 
     131         <title>Important Note for Windows Users</title> 
    132132 
    133133         <para>VR Juggler 1.1 and newer use a lot of C++ features not 
    …… 
    386386         url="README-WINDOWS.html">README-WINDOWS.html</ulink> file located in 
    387387         this directory. Do not bother to the rest of this document.</para> 
     388 
     389         <section> 
     390            <title>Per-Module Dependencies</title> 
     391 
     392            <para>Here, we provide per-module dependency information. Given 
     393            that the dependencies for any single module are met, the modules 
     394            may be reused effectively outside the scope of immersive VR 
     395            application development. Below, we list the 
     396            <emphasis>minimum</emphasis> required version for each dependency, 
     397            and where appropriate, we note which dependencies are 
     398            optional.</para> 
     399 
     400            <section> 
     401               <title>VPR</title> 
     402 
     403               <para>VPR provides a cross-platform, object-oriented operating 
     404               system abstraction. It is the foundation for all other Juggler 
     405               modules.</para> 
     406 
     407               <itemizedlist> 
     408                  <listitem> 
     409                     <para>CppDOM 0.3.2</para> 
     410                  </listitem> 
     411 
     412                  <listitem> 
     413                     <para>Boost headers and Boost.Filesystem 1.31.0</para> 
     414                  </listitem> 
     415 
     416                  <listitem> 
     417                     <para>NSPR (Windows, Solaris, and HP-UX only) 4.4</para> 
     418                  </listitem> 
     419               </itemizedlist> 
     420            </section> 
     421 
     422            <section> 
     423               <title>Tweek C++ API</title> 
     424 
     425               <para>Tweek implements a distributed model/view/controller 
     426               system on top of CORBA. The Tweek C++ API provides the C++ 
     427               component of that system. Code written on top of the Tweek C++ 
     428               API normally acts as the model piece of the distributed 
     429               model/view/controller system.</para> 
     430 
     431               <itemizedlist> 
     432                  <listitem> 
     433                     <para>VPR</para> 
     434                  </listitem> 
     435 
     436                  <listitem> 
     437                     <para>omniORB 4.0</para> 
     438                  </listitem> 
     439               </itemizedlist> 
     440            </section> 
     441 
     442            <section> 
     443               <title>Tweek Java API</title> 
     444 
     445               <para>Tweek implements a distributed model/view/controller 
     446               system on top of CORBA. The Tweek Java API provides the Java 
     447               component of that system. The main part of the Tweek Java API 
     448               is the Tweek JavaBean Loader, a GUI application that loads 
     449               Tweek Beans that normally function as the view and controller 
     450               pieces of the distributed module/view/controller system.</para> 
     451 
     452               <itemizedlist> 
     453                  <listitem> 
     454                     <para>J2SE SDK 1.4</para> 
     455                  </listitem> 
     456 
     457                  <listitem> 
     458                     <para>JDOM (included with Juggler source)</para> 
     459                  </listitem> 
     460 
     461                  <listitem> 
     462                     <para>Ant (included with Juggler source)</para> 
     463                  </listitem> 
     464 
     465                  <listitem> 
     466                     <para>JacORB IDL-to-Java compiler (included with Juggler 
     467                     source)</para> 
     468                  </listitem> 
     469               </itemizedlist> 
     470            </section> 
     471 
     472            <section> 
     473               <title>Tweek Python API</title> 
     474 
     475               <para>Tweek implements a distributed model/view/controller 
     476               system on top of CORBA. The Tweek Python API provides the 
     477               Python component of that system. The main part of the Tweek 
     478               Java API is the <emphasis>unfinished</emphasis> TweekQt GUI, an 
     479               application that loads Python modules that normally function as 
     480               the view and controller pieces of the distributed 
     481               module/view/controller system.</para> 
     482 
     483               <itemizedlist> 
     484                  <listitem> 
     485                     <para>Python 2.3</para> 
     486                  </listitem> 
     487 
     488                  <listitem> 
     489                     <para>omniORBpy 2.0</para> 
     490                  </listitem> 
     491               </itemizedlist> 
     492            </section> 
     493 
     494            <section> 
     495               <title>JCCL C++ API</title> 
     496 
     497               <para>The JCCL C++ API provides an interface for loading 
     498               XML-based configurations. It includes the run-time 
     499               reconfiguration feature of Juggler.</para> 
     500 
     501               <itemizedlist> 
     502                  <listitem> 
     503                     <para>VPR</para> 
     504                  </listitem> 
     505               </itemizedlist> 
     506            </section> 
     507 
     508            <section> 
     509               <title>JCCL Java API</title> 
     510 
     511               <para>The JCCL Java API provides a programming interface for 
     512               editing Juggler configuration files and config definition files 
     513               as well as JavaBeans for editing these files using a graphical 
     514               interface.</para> 
     515 
     516               <itemizedlist> 
     517                  <listitem> 
     518                     <para>Tweek Java API</para> 
     519                  </listitem> 
     520 
     521                  <listitem> 
     522                     <para>TableLayout package (included with Juggler 
     523                     source)</para> 
     524                  </listitem> 
     525               </itemizedlist> 
     526            </section> 
     527 
     528            <section> 
     529               <title>JCCL Remote Run-Time Reconfiguration Plug-in 
     530               (C++)</title> 
     531 
     532               <para>The C++ JCCL Remote Run-Time Reconfiguration Plug-in is 
     533               an optional extension to the JCCL Config Manager for allowing 
     534               remote manipulation of a Juggler configuration at run time 
     535               based on Tweek.</para> 
     536 
     537               <itemizedlist> 
     538                  <listitem> 
     539                     <para>Tweek C++ API</para> 
     540                  </listitem> 
     541               </itemizedlist> 
     542            </section> 
     543 
     544            <section> 
     545               <title>JCCL Remote Run-Time Reconfiguration Plug-in 
     546               (Java)</title> 
     547 
     548               <para>The Java JCCL Remote Run-Time Reconfiguration Plug-in is 
     549               an optional extension that provides the features needed for a 
     550               Java-based editor to communicate with the C++ Remote Run-Time 
     551               Reconfiguration Plug-in to edit Juggler configurations 
     552               live.</para> 
     553 
     554               <itemizedlist> 
     555                  <listitem> 
     556                     <para>Tweek Java API</para> 
     557                  </listitem> 
     558               </itemizedlist> 
     559            </section> 
     560 
     561            <section> 
     562               <title>Sonix</title> 
     563 
     564               <para>Sonix is an abstraction layer for positional sound 
     565               software. Sonix itself cannot play audio, but it includes 
     566               plug-ins based on popular interfaces for playing audio. Each 
     567               plug-in depends on a specific audio software library.</para> 
     568 
     569               <itemizedlist> 
     570                  <listitem> 
     571                     <para>VPR</para> 
     572                  </listitem> 
     573 
     574                  <listitem> 
     575                     <para>GMTL 0.1.9</para> 
     576                  </listitem> 
     577               </itemizedlist> 
     578 
     579               <section> 
     580                  <title>Sonix OpenAL Plug-in</title> 
     581 
     582                  <itemizedlist> 
     583                     <listitem> 
     584                        <para>Sonix</para> 
     585                     </listitem> 
     586 
     587                     <listitem> 
     588                        <para>OpenAL</para> 
     589                     </listitem> 
     590 
     591                     <listitem> 
     592                        <para>Free ALUT</para> 
     593                     </listitem> 
     594                  </itemizedlist> 
     595               </section> 
     596 
     597               <section> 
     598                  <title>Sonix Audiere Plug-in</title> 
     599 
     600                  <itemizedlist> 
     601                     <listitem> 
     602                        <para>Sonix</para> 
     603                     </listitem> 
     604 
     605                     <listitem> 
     606                        <para>Audiere</para> 
     607                     </listitem> 
     608                  </itemizedlist> 
     609               </section> 
     610 
     611               <section> 
     612                  <title>Sonix AudioWorks Plug-in</title> 
     613 
     614                  <itemizedlist> 
     615                     <listitem> 
     616                        <para>Sonix</para> 
     617                     </listitem> 
     618 
     619                     <listitem> 
     620                        <para>AudioWorks</para> 
     621                     </listitem> 
     622                  </itemizedlist> 
     623               </section> 
     624            </section> 
     625 
     626            <section> 
     627               <title>Gadgeteer</title> 
     628 
     629               <para>Gadgeteer handles all input devices that can be used by 
     630               VR Juggler applications.</para> 
     631 
     632               <itemizedlist> 
     633                  <listitem> 
     634                     <para>VPR</para> 
     635                  </listitem> 
     636 
     637                  <listitem> 
     638                     <para>JCCL</para> 
     639                  </listitem> 
     640 
     641                  <listitem> 
     642                     <para>GMTL 0.1.9</para> 
     643                  </listitem> 
     644 
     645                  <listitem> 
     646                     <para>X Window System (non-Windows platforms)</para> 
     647                  </listitem> 
     648               </itemizedlist> 
     649            </section> 
     650 
     651            <section> 
     652               <title>Gadgeteer Device Driver Plug-ins</title> 
     653 
     654               <para>The device driver plug-ins for Gadgeteer are independent 
     655               components that are discovered and used at run time based on 
     656               the application configuration. Drivers with dependencies are 
     657               optional.</para> 
     658 
     659               <itemizedlist> 
     660                  <listitem> 
     661                     <para>Gadgeteer</para> 
     662                  </listitem> 
     663 
     664                  <listitem> 
     665                     <para>VRPN 06.06 for the VRPN driver plug-in</para> 
     666                  </listitem> 
     667 
     668                  <listitem> 
     669                     <para>TrackD API 4 for the TrackD API driver 
     670                     plug-in</para> 
     671                  </listitem> 
     672 
     673                  <listitem> 
     674                     <para>Microsoft Speech API for the MS Speech API driver 
     675                     plug-in</para> 
     676                  </listitem> 
     677               </itemizedlist> 
     678            </section> 
     679 
     680            <section> 
     681               <title>Gadgeteer Cluster Plug-ins</title> 
     682 
     683               <para>The cluster plug-ins extend the functionality of the 
     684               clustering infrastructure built into Gadgeteer.</para> 
     685 
     686               <itemizedlist> 
     687                  <listitem> 
     688                     <para>Gadgeteer</para> 
     689                  </listitem> 
     690               </itemizedlist> 
     691            </section> 
     692 
     693            <section> 
     694               <title>VR Juggler</title> 
     695 
     696               <para>The VR Juggler module is the unifying piece that pulls 
     697               all the other Juggler modules together. It provides a virtual 
     698               platform for VR application development. Real-time rendering is 
     699               controlled by Draw Managers. The OpenGL Performer Draw Manager 
     700               is optional.</para> 
     701 
     702               <itemizedlist> 
     703                  <listitem> 
     704                     <para>Gadgeteer</para> 
     705                  </listitem> 
     706 
     707                  <listitem> 
     708                     <para>Sonix</para> 
     709                  </listitem> 
     710 
     711                  <listitem> 
     712                     <para>OpenGL</para> 
     713                  </listitem> 
     714 
     715                  <listitem> 
     716                     <para>OpenGL Performer for the 
     717                     <emphasis>optional</emphasis> OpenGL Performer Draw 
     718                     Manager</para> 
     719                  </listitem> 
     720               </itemizedlist> 
     721            </section> 
     722 
     723            <section> 
     724               <title>VR Juggler Run-Time Performance Monitoring Plug-in 
     725               (C++)</title> 
     726 
     727               <para>The C++ VR Juggler Run-Time Performance Monitoring 
     728               Plug-in provides an optional extension to VR Juggler for remote 
     729               visualization of performance metrics that are captured while 
     730               running a VR Juggler application. Communication is performed 
     731               using the Tweek C++ API on top of CORBA.</para> 
     732 
     733               <itemizedlist> 
     734                  <listitem> 
     735                     <para>Tweek C++ API</para> 
     736                  </listitem> 
     737 
     738                  <listitem> 
     739                     <para>VR Juggler</para> 
     740                  </listitem> 
     741               </itemizedlist> 
     742            </section> 
     743 
     744            <section> 
     745               <title>VR Juggler Run-Time Performance Monitoring Plug-in 
     746               (Java)</title> 
     747 
     748               <para>The Java VR Juggler Run-Time Performance Monitoring 
     749               Plug-in is an optional extension that provides the features 
     750               needed for Java-based visualization of performance data 
     751               collected while a VR Juggler application is running. This is 
     752               another JavaBean handled by the Tweek JavaBean Loader, and it 
     753               uses CORBA to communicate with the C++ VR Juggler Run-Time 
     754               Performance Monitoring Plug-in.</para> 
     755 
     756               <itemizedlist> 
     757                  <listitem> 
     758                     <para>JCCL Java API</para> 
     759                  </listitem> 
     760 
     761                  <listitem> 
     762                     <para>JFreeChart (included with Juggler source)</para> 
     763                  </listitem> 
     764               </itemizedlist> 
     765            </section> 
     766 
     767            <section> 
     768               <title>VRJConfig</title> 
     769 
     770               <para>VRJConfig is the graphical editor for Juggler 
     771               configurations. It is a JavaBean loaded by the Tweek JavaBean 
     772               Loader, and it makes use of the editor Beans provided by the 
     773               JCCL Java API.</para> 
     774 
     775               <itemizedlist> 
     776                  <listitem> 
     777                     <para>JCCL Java API</para> 
     778                  </listitem> 
     779 
     780                  <listitem> 
     781                     <para>JGraph (included with Juggler source)</para> 
     782                  </listitem> 
     783               </itemizedlist> 
     784            </section> 
     785         </section> 
    388786 
    389787         <section id="config.vrjuggler.section">