Math Library - magic-lantern-android-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

The Math Library API documentation can be found in the form of Javadoc HTML pages.

API for Java Packages

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

  1. In the core-math project, select Tools->Generate JavaDoc... in the main toolbar.
  2. In the pop-up dialog, specify the directory where the documentation will be generated. We suggest ~/MagicLantern/core-math/doc.
  3. The Javadoc HTML will be generated in the doc directory.