
   TDM - various "Three D Mice" implementations for GNU Maverik

                     Advanced Interfaces Group
                 The University of Manchester (UK)
                      http://aig.cs.man.ac.uk
                       tdm@aig.cs.man.ac.uk



Introduction
============

GNU Maverik's generic support for 6 DOF input devices/tracking
technology, collectively called "Three D Mice", relies on a separate
library to provide the basic interface to the device (see
src/extras/README in the Maverik distribution).

This software implements that library for Polhemus FASTRAK and ISOTRAK
II six degree of freedom trackers (optionally coupled to Division 3D
mice); Ascension Flock of birds (ERC only); Spacetec SpaceBalls and
SpaceOrb360s; Magellan Space Mouse; InterSense InterTrax 30 gyroscopic
trackers; 5DT data gloves; and a serial Logitech Marble Mouse.

N.B. This code is designed to work for a particular setup -- you will
need to modify it for your site setup even if you have the same
equipment, e.g. serial port and baud rates, transmitter orientation,
number of receivers etc... Further, since we at the University of
Manchester do not have access to each of these device, the drivers
cannot be guaranteed to run error-free.

Also included in this distribution is a bare bones "skeleton"
implementation of the functions which the library needs to provide and
an implementation which allows you to control a device's position,
orientation and event generation via the keyboard.

See the README in the src directory for more information about each of
the implementations and what you will need to modify for different
site setups.



License
=======

This software is distributed under the terms of the GNU General Public
License, see the COPYING file for details.



Obtaining the software
======================

TDM is available for download from http://aig.cs.man.ac.uk/maverik/download-tdm.php
and is distributed as a single gzipped tar file.



Building and testing the system
===============================

See INSTALL file.



Contact
=======

Comments, questions and feedback are actively encouraged and should be
addressed to us personally at tdm@aig.cs.man.ac.uk, or to the TDM
user's mailing list (see http://aig.cs.man.ac.uk/contact.php for
details).



Reporting bugs
==============

Before reporting a bug make sure that you are using the latest version
of TDM and Maverik and that you have checked the list of known bugs
(see below).

If, after this, you are still experiencing the problem then report the
bug to tdm@aig.cs.man.ac.uk, or to the TDM user's mailing list (see
above).



Known bugs/features/limitations/work-arounds
============================================

1) One person has reported that CEOF is undefined when compiling the
Polhemus code. Not sure if this is a genuine bug or a setup problem on
their machine.
