Cyclone Cyclone: Cyclone Reference

Cyclone Reference

Version 2.0.5

Cyclone is a general purpose and robust system for real-time simulation of rigid bodies. The library was designed to be used in computer games, but may be applicable to other areas of simulation or research.

About This Document

This documentation contains detailed reference to every aspect of the Cyclone library.

Contents

Use the navigation system on the left side of the page to view the documentation. The navigation tool uses JavaScript, and requires a version 4 browser or above.

All the publically accessible functions and classes of Cyclone are provided in a set of header files. These, and their contents, can be browsed from the File List section.

Cyclone is contained in a single namespace, cyclone. Its contents can be viewed in the Compound List section. The Class Hierarchy section provides an alternative way to navigate these classes. The Graphical Class Hierarchy provides an overview of class inheritance.

The Compound List section gives an alphabetic list of all symbols in the library, including method names and functions.

Graphs

Most of the documentation contains detailed graphical representations of the file and class dependencies. These diagrams are clickable, and provide the fastest mechanism for browsing the documentation. Each diagram is followed by a link to a help file giving a legend.

Using Cyclone

To set up:

Then each frame:

Legal

This documentation is distributed under license. Use of this documentation implies agreement with all terms and conditions of the accompanying software and documentation license.