API DOCUMENTATION

The source code has been commented for auto-generation of class hierarchy documentation with Doxygen. This documentation can be generated by anyone who has the CHAI 3D source code and the Doxygen utility. Information about the CHAI 3D coding style can be found here.
The best way to learn about using CHAI 3D is to explore the various examples provided with the framework. Each example is labeled by a unique name and a two digit number that indicates its relative level of complexity. For instance, the foundations of CHAI 3D are mostly covered in examples 01-30, while the more advanced topics including rigid and deformable dynamic simulation are presented in examples 40‘s and higher.

API ORGANIZATION
Directory Name:

projects


src
modules
external
lib
examples

bin
doc

Description:

CHAI 3D Windows project files - Subdirectories include MSVC7, MSVC8, MSVC9 for Visual
Studio 2003, 2005, and 2008 respectively. For the Apple edition, please refer to the chai3d.xcodeproj project file. For the Linux Edition, please refer to the makefiles.
CHAI 3D source code.
CHAI 3D third party modules.
External resource libraries (Haptic Devices, BASS, ODE, OpenGL, etc.)
CHAI 3D libraries - Product from compiling the CHAI 3D source code.
CHAI 3D examples - Subdirectories include MSVC7, MSVC8, MSVC9 for Visual Studio 2003, 2005, and 2008 respectively.
Compiled executable and resource files for all examples.
CHAI 3D documentation.

HAPTIC DEVICES
Device Type:

Force Dimension
delta.x
omega.x

Novint Technologies
falcon


MPB Technologies
freedom.6

Sensable Technologies
phantom		 Remarks:


Supported on Windows, Linux and Max OS-X.
Resource files are included with CHAI 3D.


Supported on Windows [32-bit] edition.
Requires drivers 3.1 or higher.


Supported on Windows [32-bit] edition.


Supported on Windows [32/64-bit] editions.
Requires OpenHaptics 3.0 or higher.
copyright 2009