Changeset 18951

Show
Ignore:
Timestamp:
06/04/06 08:30:10 (2 years ago)
Author:
patrick
Message:

Merged the following revisions from the trunk:

Revision 18918: Indicate that the "darwin" toolset should be used when

building Boost on Mac OS X.

Revision 18919: List the dependencies for each module.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/branches/2.0/doc/INSTALL.xml

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