Changeset 20287

Show
Ignore:
Timestamp:
06/03/07 11:27:12 (1 year ago)
Author:
patrick
Message:

Avoid referring to VR Juggler simulator configurations as "simulator mode"
and improve/update the information about the example VR Juggler simulator
configuration files.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/branches/2.2/modules/vrjuggler/doc/getting.started.guide/getting.started.guide.xml

    r20286 r20287  
    13611361 
    13621362      <para>It is important to note that the same VR Juggler application can 
    1363       be run in simulator mode or in a full-scale VR system with no 
     1363      be run in a simulator configuration or in a full-scale VR system with no 
    13641364      modifications. What does change is the configuration files used when 
    13651365      starting the program. In 
    …… 
    13961396         <title>Running an Application with a Simulator Configuration</title> 
    13971397 
    1398          <para>Running in <quote>simulator mode</quote> means that your input 
    1399          is simulated and your display windows may have limited functionality. 
    1400          (By <quote>simulated input</quote>, we mean that input is provided 
    1401          through windows that take keyboard and mouse input and translate that 
    1402          into transformations in the virtual world.) Simulator viewports are 
    1403          limited primarily in that they cannot display stereo graphics. It is 
    1404          important to note that a simulator viewport is a special kind of VR 
    1405          Juggler viewport within a display window. Instead of basing its 
    1406          viewpoint on the head position of one of the users, the viewpoint is 
    1407          controlled by a separate camera that is just another positional 
    1408          device. Within a simulator viewport, VR Juggler draws certain objects 
    1409          to help visualize the environment. For example, the heads of users 
    1410          are represented as blue ellipsoids with gray eyes, and a wand (if 
    1411          present) is drawn as a green pointing device. Besides these common 
    1412          simulator objects, display surfaces can be drawn. These represent 
    1413          projection screens or HMD viewing projections and are drawn as 
    1414          translucent rectangles.</para> 
     1398         <para>Running with a simulator configuration means that your input is 
     1399         simulated and your display windows may have limited functionality. 
     1400         (By <quote>simulated input,</quote> we mean that input is provided 
     1401         through desktop windows that take keyboard and mouse input and 
     1402         translate that into what would be provided by various types of 
     1403         physical input devices used in VR systems.) Simulator viewports are 
     1404         limited primarily in that they cannot display stereo graphics.</para> 
     1405 
     1406         <para>It is important to note that a simulator viewport is a special 
     1407         kind of VR Juggler viewport within a display window. Instead of 
     1408         basing its viewpoint on the head position of one of the users, the 
     1409         viewpoint is controlled by a separate camera that is just another 
     1410         positional device. Within a simulator viewport, VR Juggler draws 
     1411         certain objects to help visualize the environment. For example, the 
     1412         heads of users are represented as blue ellipsoids with gray eyes, and 
     1413         a wand (if present) is drawn as a green pointing device. Besides 
     1414         these common simulator objects, display surfaces can be drawn. These 
     1415         semi-transparent rectangles represent projection screens or HMD 
     1416         viewing projections.</para> 
    14151417 
    14161418         <para>As mentioned, several simulator configuration files are 
    …… 
    14221424         refer to the <emphasis>VRJConfig Guide</emphasis>. (Using VRJConfig 
    14231425         is the best way to find out how a specific configuration file is set 
    1424          up.) The configuration files of interest for simulator mode are as 
    1425          follows:</para> 
     1426         up.) The configuration files of interest for simulator configurations 
     1427         are as follows:</para> 
    14261428 
    14271429         <itemizedlist> 
    14281430            <listitem> 
    14291431               <para><filename>sim.base.jconf</filename> - The basic 
    1430                configuration file needed by all applications when run in 
    1431                simulator mode. It defines commonly used VR Juggler concepts 
    1432                that are beyond the scope of this particular book. It also 
    1433                defines simulated head movement using the keyboard. For now, it 
    1434                is sufficient to know that it is required to run the sample 
    1435                applications in simulator mode.</para> 
    1436  
    1437                <para>This file also contains the basic simulator display 
    1438                configuration file needed by all applications when run in 
    1439                simulator mode. It defines the display windows where the 
    1440                rendering magic occurs. Two simulator display windows are 
    1441                configured by this file: a small one that is active by default 
    1442                and a larger one that is inactive initially.</para> 
     1432               configuration file used with other simulator configuration 
     1433               <quote>mix-in</quote> files. It defines commonly used VR 
     1434               Juggler concepts that are beyond the scope of this particular 
     1435               book. It also defines simulated head movement using the 
     1436               keyboard. This file also contains the display configuration 
     1437               information needed by other simulator configuration mix-in 
     1438               files. It defines the display window with its simulator 
     1439               viewport where the rendering occurs.</para> 
    14431440            </listitem> 
    14441441 
    …… 
    14471444               <quote>mix-in</quote> configuration file that defines simulated 
    14481445               analog input using the keyboard. This is only required for 
    1449                applications where analog input is used and needs to be 
    1450                simulated when in simulator mode.</para> 
     1446               applications where analog input is used and a physical analog 
     1447               input device needs to be simulated.</para> 
    14511448            </listitem> 
    14521449 
    …… 
    14611458               <para><filename>sim.c6displays.mixin.jconf</filename> - A 
    14621459               <quote>mix-in</quote> configuration file that defines the 
    1463                surface displays of VRAC's C6. This is not required for any 
     1460               surfaces of a six-wall <productname 
     1461               class="trade">CAVE</productname>-like VR system with two 
     1462               additional surfaces at odd angles. Each surface is rendered in 
     1463               a separate display window. This is not required for any 
    14641464               application but can be used to test opening multiple display 
    14651465               windows (each containing either a surface or a simulator 
    1466                viewport) before running in a multi-screen VR system.</para> 
     1466               viewport) before running in a multi-pipe VR system. Note, 
     1467               however, that this configuration does not leverage 
     1468               multi-threaded rendering, just multi-window rendering.</para> 
     1469            </listitem> 
     1470 
     1471            <listitem> 
     1472               <para><filename>sim.c6viewports.mixin.jconf</filename> - A 
     1473               <quote>mix-in</quote> configuration file that defines the 
     1474               surfaces of a six-wall <productname 
     1475               class="trade">CAVE</productname>-like VR system. Each surface 
     1476               is rendered in a separate viewport within a single display 
     1477               window. This is not required for any application but can be 
     1478               used to test using multiple viewports in a single window (each 
     1479               containing either a surface or a simulator viewport).</para> 
    14671480            </listitem> 
    14681481 
    …… 
    14711484               <quote>mix-in</quote> configuration file that defines simulated 
    14721485               digital glove input using the keyboard. This is only required 
    1473                for applications where digital glove input is used and needs to 
    1474                be simulated when in simulator mode.</para> 
     1486               for applications where digital glove input is used and a 
     1487               physical digital input device needs to be simulated.</para> 
    14751488            </listitem> 
    14761489 
    …… 
    14801493               gesture-based glove input using the keyboard. This is only 
    14811494               required for applications where gesture-based glove input is 
    1482                used and needs to be simulated when in simulator mode.</para> 
     1495               used and a physical glove needs to be simulated.</para> 
    14831496            </listitem> 
    14841497 
    …… 
    14871500               <quote>mix-in</quote> configuration file that defines simulated 
    14881501               wand input using the mouse. This is only required for 
    1489                applications where wand input is used and needs to be simulated 
    1490                when in simulator mode.</para> 
     1502               applications where wand input is used and needs to be 
     1503               simulated. Wand input is defined as a tracked positional device 
     1504               with several digital buttons.</para> 
    14911505            </listitem> 
    14921506 
    …… 
    14991513            </listitem> 
    15001514         </itemizedlist> 
    1501  
    1502          <para>For the MPApp application, we need the base configuration file 
    1503          and the wand mix-in configuration file.</para> 
    15041515 
    15051516         <section> 
    …… 
    23332344 
    23342345         <para>Running an application full-scale in a VR system tends to be 
    2335          more complicated than running in simulator mode. The reason for this 
    2336          is that VR systems tend to differ in configuration and in available 
    2337          hardware. VR Juggler is flexible enough to handle most any 
    2338          configuration you throw at it, but those configurations need to be 
    2339          put together first. VR systems can be driven by a single, multi-pipe 
    2340          machine or a cluster of computers communicating over a network. VR 
    2341          Juggler supports both, and the details are captured in the 
    2342          configuration.</para> 
     2346         more complicated than running with a simulator configuration. The 
     2347         reason for this is that VR systems tend to differ in configuration 
     2348         and in available hardware. VR Juggler is flexible enough to handle 
     2349         most any configuration you throw at it, but those configurations need 
     2350         to be put together first. VR systems can be driven by a single, 
     2351         multi-pipe machine or a cluster of computers communicating over a 
     2352         network. VR Juggler supports both, and the details are captured in 
     2353         the configuration.</para> 
    23432354 
    23442355         <para>Example configuration files for different VR system 
    …… 
    24162427            </itemizedlist> 
    24172428 
    2418             <para>Running the application is the same as in simulator mode 
    2419             except that the configuration files given on the command line are 
    2420             different. For example, to run MPApp in the C4 with stereoscopic 
    2421             graphics, the following command would be used:</para> 
     2429            <para>Running the application is the same as with a simulator 
     2430            configuration except that the configuration files given on the 
     2431            command line are different. For example, to run MPApp in the C4 
     2432            with stereoscopic graphics, the following command would be 
     2433            used:</para> 
    24222434 
    24232435            <screen>% MPApp C4.closed.jconf</screen>