Math Library - magic-lantern-studio/mle-documentation GitHub Wiki

The Magic Lantern Software Development Kit provides a library of math utilities to facilitate title development. The math library contains classes for vectors with 2, 3 and 4 floating-point elements. The library also provides a 4x3 affine matrix of floating-point elements. The Math Library from the Magic Lantern project provides both floating-point and fixed-point utility.

Table of Contents

• Documentation
• API for Java Packages
• API for C++ Libraries

Documentation

The Math Library API documentation can be found in the form of Javadoc and Doxygen HTML pages. The Javadoc pages correlate to the Java version of the API while the C++ version of the documentation is generated using Doxygen.

API for Java Packages

API documentation for the Java packages are not currently available online. To generate the Javadoc using the Eclipse project for the Math Utility Library, simply follow these instructions:

1. In the com.wizzer.mle.math project, select javadoc.xml in the Package Explorer view.
2. Right-click the resource and select Open Javadoc Wizard... from the context menu. This action will bring up the Javadoc Generation dialog.
3. Make sure the Javadoc command: field points to the javadoc.exe executable in your environment.
4. Select the Next>, button, accepting the the default configuration.
5. Again, select the Next>, button, accepting the the default configuration.
6. Finally select the Finish button.
7. The Javadoc HTML will be generated in the doc directory.

API for C++ Libraries

API documentation for the C++ libraries can be found on the project web site.

This documentation is generated by using Doxygen. If you wish to generate the library API documentation on your host development machine, follow these instructions:

1. cd $MLE_HOME/Core/math/common/doc
2. doxywizard MleDoxyfile
3. Select the "Run" tab.
4. Select the "Run doxygen" button.

A local copy of the API documentation will be generated under the $MLE_HOME/Core/math/common/doc/html directory.

:information_source: Note

You may need to edit the "MleDoxyfile" to use paths local to your development environment. Also, the "MleDoxyfile.linux" configuration should be used on linux host development platforms since the "MleDoxyfile" was developed for the Windows platform.