Git Product home page Git Product logo

caliko's Introduction

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 is a Maven multi-module project with the following modules:

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

The caliko-visualisation module contains 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 module contains 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

To build yourself:

git clone https://github.com/FedUni/caliko

mvn clean package or mvn clean install

Alternatively, download a release from: https://github.com/FedUni/caliko/releases

Usage

To use the library in your own Maven project, declare the following dependencies:

  1. If you only need the IK algorithm and do not need any visualisation:
    <dependency>
      <groupId>au.edu.federation.caliko</groupId>
      <artifactId>caliko</artifactId>
      <version>1.3.2</version>
    </dependency> 
  1. If you need the IK algorithm and the visualisation:
    <dependency>
      <groupId>au.edu.federation.caliko.visualisation</groupId>
      <artifactId>caliko-visualisation</artifactId>
      <version>1.3.2</version>
    </dependency> 

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.

caliko's People

Contributors

alansley avatar jmsjr avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.