---------------------------------------------------------------------------
CoreData API 
Copyright Seeing Machines 2009
---------------------------------------------------------------------------


Introduction
------------

The Seeing Machines CoreData API is a set of libraries and tools for 
interpreting and manipulating data produced by Seeing Machines products.

Features:

* Open source

* Multi-language: C++, C#, Python

* Multi-platform: Windows, Mac OS X, Linux


Summary of Improvements Version 1.1.3
----------------------------------------------------------

* Update documentation on how to compile the CoreData C++ API and examples
  for Linux and Mac.

* Fix udpclient and tcpclient examples not handling missing world and head
  output data.

* Remove QMake specific targets from generated makefiles.

* Fix missing format specification string passed to printf in logconverter
  example.

* Fix behaviour of SerializableFactory::newObject(std::vector<uint8>,int&).
  When the object in the buffer is unknown, the read_pos is correctly updated
  to refer to the location of the next object in the buffer. This would 
  cause an infinite loop in deserializing code.

* Fix bug where calling SerializableFactory::registerObjectType before calling
  SerializableFactory::newObject skips registration of CoreData object types.

* Comment out printing to std::cout by DatagramSocket, SerialPort, TcpSocket
  classes.


Summary of Improvements Version 1.1.2
----------------------------------------------------------

* Fix compile problem with template function EngineOutputBase::attachIfMissing.

* Move sm::eod::SerialPortError to namespace sm::eod::io.

* Delete unnecessary header tstring.h

* Move stringfuns.h functions under sm::eod::io namespace.

* Move pitch, axis and direction enumerations from sm::eod to sm::eod::utils 
  namespace.

* Move mathematical vector functions from sm::eod to sm::eod::utils 
  namespace.

* Fixed a bug in SerialPort of not calling GetCommTimeouts to fill in the 
  COMMTIMEOUTS structure before updating and setting it back.

* Move EngineOutputDataFileError from sm::eod to sm::eod::io.

* Fix precondition checks on gazeVergencePoint, gazeVergenceAngle, 
  bestGazeRay, mergedGazeRay.

* Add templated addSubObject functions to SerializableComposite that creation
  of new object and adding in a single call.

* Add templated addIfMissing functions to SerializableComposite to create
  and add a new object if it doesn't already exist.


Summary of Improvements Version 1.1.1
----------------------------------------------------------

* Fix library names to match documented naming conventions.


Summary of Improvements Version 1.1.0
----------------------------------------------------------

* Support for build shared libraries

* Fix C# example project names in Visual Studio so that they do not conflict
  with the C++ examples.

* Fix access violation in SerializableComposite when deserializing and object
  with an incorrect header size.


Summary of Improvements Version 1.0.0 (over ClientToolsSDK)
----------------------------------------------------------

* Now supports Microsoft Visual Studio 2008, Visual Studio 2005, 
  Visual Studio .NET 2003, Linux/GCC, MacOSX/GCC.

* Shared pointers used to simplify memory management.

* Bindings for C# and Python.

* Memory pooling support.

* Extensibility - client defined output data classes can now be 
  serialized as part of engine output data.


Supported Compilers
-------------------
* Microsoft Visual Studio 2003 SP1
* Microsoft Visual Studio 2005 SP1
* Microsoft Visual Studio 2008 SP1
* Mac OS X gcc 4.0.1
* Linux gcc 4.2.0


Documentation
-------------

The CoreData API is documented:

* ./coredata/doc/html/index.html is the front page for the HTML documentation.

* ./coredata/doc/CoreData.chm is a searchable HTML Help binary containing
  the C++ HTML documentation(windows release only).


Bugs and Feature Requests
---------------------------
To report any bugs or feature requests, write to faceAPI@seeingmachines.com
with details.