The Caliko library is an implementation of the FABRIK inverse kinematics algorithm in Java.
Java

README.md

Caliko

The Caliko library is an implementation of the FABRIK inverse kinematics (IK) algorithm in the Java programming language, and is released under the MIT software license. See LICENSE.txt for further details.

The FABRIK algorithm is explained in the following research paper: Aristidou, A., & Lasenby, J. (2011). FABRIK: a fast, iterative solver for the inverse kinematics problem. Graphical Models, 73(5), 243-260.

You can watch a short video outlining the setup and functionality of the Caliko library here: https://www.youtube.com/watch?v=wEtp4P2ucYk

Structure

The library itself can be built into two separate .JAR files (one mandatory, one optional) suitable for inclusion in your IK projects:

  • caliko.jar, and
  • caliko-visualisation.jar.

The caliko folder contains source code for core IK portion of the library and is capable of running without any visualisation or external dependencies.

The caliko-visualisation folder contains source code for the optional visualisation component of the library which provides the ability to draw various IK structures/chains/bones and depends on the core caliko functionality as well as the LWJGL3 library.

The caliko-demo folder contains source code for a demonstration of the library utilising both 2D and 3D IK chains in various configurations. It requires the caliko, caliko-visualisation and LWJGL3 libraries.

Build and Setup

You do not need to build the Caliko library yourself to use it, and may instead simply download a release from: https://github.com/FedUni/caliko/releases

Then, it's simply a matter of creating a new project, linking in the library .jars (and optionally the source code and javadoc archives) and using the library functionality. If you're using the visualisation component, then the LWJGL3 library must also be configured for your project.

Alternatively, rather than using the caliko / caliko-visualisation .jar files, you could just copy the au.edu.federation.* source files into your project, but you may then need to replace them with newer versions as changes/fixes are applied to Caliko - so using the latest .jar versions is a cleaner and more hassle-free solution.

If you wish to build the Caliko library yourself, then it's configured to use maven for project / dependency management and the entire library can be built by calling: mvn package

This will create a file called caliko.zip in the top level directory, the contents of which are those from the created RELEASE folder.

Demo controls

  • Left mouse button sets target in 2D mode and enables mouse-look in 3D mode.
  • Up/Down cursors - Toggle 2D/3D mode.
  • Left/Right cursors - Prev/Next demo.
  • Space - Pause/Resume target movement (3D).
  • L - Toggle display lines.
  • M - Toggle display models (3D).
  • X - Toggle display axes (3D).
  • F - Toggle fixed base mode.
  • P - Toggle perspective / orthographic projection (3D)
  • R - Toggle rotating base locations (3D)
  • Esc - Quit.

TODO

High priority

  • Nil.

Medium priority

  • Nil.

Low priority

  • Refactor entire library to use quaternions.
  • Add parabolic constraint types.
  • Streamline Model class object copying.