MindViewer Release Notes

********************
V2.5 3rd December 1997
********************

There are more powerful features included in this release.
In particular, the walkthrough functionality opens up many new
applications for the VREK.

(1) Walkthrough functions.
This release of MindSetter and MindViewer includes walkthrough functionality.
This functionality includes the ability to record and playback navigation
and HMD information from a session. Multiple sections of navigation may
be concatenated in one recording file. This functionality is available
from both the MindSetter and MindViewer tools.

In the main menu of each tool there is a SESSION menu which is now described:

PLAYBACK...
    This sub-menu contains commands relating to session playback.
FILE...
    This command allows the user to specify the current playback file.
PLAY
    This command causes the current playback file to start running.
STOP
    This command causes the current playback file to stop.
PAUSE
    This command pauses the current playback.
RESUME
    This command resumes the current playback from a prior PAUSE.
HMD Info...
    This sub-menu contains two commands USE and DISCARD. USE causes
    the HMD information in the playback file to vary the view.
    DISCARD causes the HMD information in the playback file to be
    ignored. This allows a user to use their own HMD in conjunction
    with the navigation information in the playback.


RECORDING...
    This sub-menu contains commands relating to session recording.
FILE...
    This command allows the user to specify the current recording file.
    Note that the user may specify the name of a file that does not yet exist.
RECORD
    This command clears the current recording file and starts a new recording.
APPEND
    This command starts a new recording by appending to the end of the current
    recording file.
STOP
    This command stops the current recording. The user may then continue
    recording by subsequent APPEND commands.

The following hot-keys are now active:

Shift-F1
    To toggle between PLAY and STOP of the current playback file.
Shift-F2
    To toggle between PAUSE and RESUME of the current playback file.
Shift-F3
    To perform a SESSION/RECORDING/RECORD command to record to the
    current recording file.
Shift-F4
    To perform a SESSION/RECORDING/APPEND command to append to the
    current recording file.
Shift-F5
    To STOP the current recording.


Note that the user must enter MOVE mode in order to record navigation
information in the recording file.

Walkthrough files are in a text format and have the .MSR file extension.
These files are kept in the CONFIG sub-directory.

Note that it is possible to play and record at the same time. For example,
by using a source playback file which contains navigation information we
can play back the session discarding the HMD info. If, when the source session
is played back, we are recording at the same time, then not only will the
navigation information be recorded to the new file, but so too will any
new HMD information - allowing a user to record different subject's responses
to the same navigation walkthrough.


MSR File Format (MSR=MindSetter Recording)
---------------

An MSR file is a text file. Each line in the file contains a time stamp,
a command and command parameters.

<TIME> <COMMAND> <COMMAND PARAMETERS>

The time indicates when the command will be obeyed. In the case of the
INTVIEW command, which causes a smooth change in view position, orientation
and HMD information, the time indicates at which time the smooth transition
will be completed.

The time stamp can be written in one of two formats:
(a) Formatted time:
    HH:MM:SS.hh
    eg. 12:34:56.78 is 12 hours, 34 minutes, 56 seconds and 78 hundredths.

(b) Hundredths:
    eg. 123456 is 123456 hundredths of a second.
    Note no decimal places allowed in this format.

There are currently 4 command types:
    SECTION     - indicates start of a 'scene'.
    ENDSECTION  - indicates end of a 'scene'.
    SETVIEW     - Allows setting of view position, orientation and HMD info.
    INTVIEW     - Allows smooth changing of view position, orientation and HMD info.

The command parameters depend on the type of the command:

SECTION - No parameters
ENDSECTION - No parameters
SETVIEW and INTVIEW use the following parameters:

<CHANGE> [<Tx Ty Tz> <Ox Oy Oz> <Hx Hy Hz>]

The <CHANGE> parameter is a number which indicates which parameters follow
on the same line. The <CHANGE> parameter is the sum of the following
numbers:
    1 - indicates that the T (view position) parameter follows.
    2 - indicates that the O (view orientation) parameter follows.
    4 - indicates that the H (HMD orientation) parameter follows.

    For example, a <CHANGE> value of 7 indicates that all three parameter
    types follow. A value of 5 indicates that only the T and H parameters
    follow, and 3 indicates that only the T and O parameters follow.

    Examples of valid parameter lists for the SETVIEW and INTVIEW commands are:
    7   0 0 0   0 0 0   0 0 0
    7   100 0 0     0 45 45     12.1 34.2 5.68
    1   100.12 50 50.456
    2   45.1 315 0
    5   10 20 30    12.3 14.4 123

    Note that in the last example, above, the last three numbers are the HMD info.


An MSR file is made up of 1 or more sections. Each section can be thought
of as a scene in a movie. Each section must start with a SECTION command
and terminate with an ENDSECTION command.
    In general, it is good practice to follow the SECTION command with
a SETVIEW command with a change parameter of 7 (ie. specify all of the
initial position, orientation and HMD information).

Examples of simple MSR files:

Example 1 - This moves the user in a square-shaped walkthrough alternating
    between moving and turning. Each moving or turning movement is
    smoothly interpolated and takes 15 seconds.

00:00:00.00 SECTION
00:00:00.00 SETVIEW 7   0 0 0   0 0 0   0 0 0
00:00:15.00 INTVIEW 1   0 0 100
00:00:30.00 INTVIEW 2   0 90 0
00:00:45.00 INTVIEW 1   -100 0 100
00:01:00.00 INTVIEW 2   0 180 0
00:01:15.00 INTVIEW 1   -100 0 -100
00:01:30.00 INTVIEW 2   0 270 0
00:01:45.00 INTVIEW 1   100 0 -100
00:02:00.00 INTVIEW 2   0 0 0
00:02:15.00 INTVIEW 1   0 0 0
00:02:15.00 ENDSECTION


Example 2 - This also moves the user in a square-shaped walkthrough but
    this time the movement and turning motions are performed at the same
    time (until the last side of the square which is movement only).

00:00:00.00 SECTION
00:00:00.00 SETVIEW 7   0 0 0   0 0 0   0 0 0
00:00:15.00 INTVIEW 3   0 0 100         0 90 0
00:00:30.00 INTVIEW 3   -100 0 100      0 180 0
00:00:45.00 INTVIEW 3  -100 0 -100     0 270 0
00:01:00.00 INTVIEW 3   100 0 -100      0 0 0
00:01:15.00 INTVIEW 1   0 0 0         
00:01:15.00 ENDSECTION


(2) Update to reflect the changes in MindSetter (see the MindSetter release
    notes for more information).


********************
V2.4 27th August 1997
********************
(1) The purpose of this release is primarily to provide full
    SpaceOrb 360 support. This low-cost device, from SpaceTec Inc. allows
    6 degrees of freedom when navigating. More details on the device
    are available from http://www.spacetec.com

    To run MindSetter with SpaceOrb support, type:
    MSORB [scenename]
    To run MindViewer with SpaceOrb support, type:
    MVORB [scenename]

    The buttons on the SpaceOrb have been configured as:
    A: Standard left mouse button.
    B: Standard right mouse button.
    C: Hold down to increase speed by a factor of 5.
    D: Press once to enter 'full' control navigation mode allowing
       complete control over orientation and movement.
    E: Hold down to decrease speed by a factor of 5.
    F: Press once to enter 'normal' control navigation mode allowing
       only 'yaw' orientation changes (rather like using the mouse to navigate).
       Press again to zero your 'roll'.
    Reset Button (located on back of SpaceOrb):
       This button will level your view (set to zero for pitch, yaw and roll).

    You may also use the SpaceOrb when moving, rotating and scaling
    objects in a scene.

(2) Update to reflect the changes in MindSetter (see the MindSetter release
    notes for more information).

*********************
V2.3 11th August 1997
*********************
(1) Updated to reflect the changes in MindSetter (see the MindSetter release
    notes for more information).


*****************
V2.2 23rd June 1997
*****************
(1) Updated to reflect the changes in MindSetter (see the MindSetter release
    notes for more information).


*****************
V2.1 1st May 1997
*****************
Released as part of the MindRender VR Explorer Kit (VREK).