Skip to content

Commit

Permalink
[README] update text and links for version tagging
Browse files Browse the repository at this point in the history
  • Loading branch information
smokhov committed Mar 20, 2021
1 parent bef8dfc commit 8ecbff2
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
# OIGesture JNI Library using SWIG >= 4.0 and CMake >= 3.12.2
## Using SWIG 4.0 or higher, this repository contains interface files for OpenISS Getsure Framework related classes, a maintainable way to let SWIG generate wrapper classes for OpenISS gesture library in a target language.
# OpenISS SWIG Wrapper

### Currently, wrappers can be generated for Java only.
This project is used to generate wrappers for common classes and data structures of the [OpenISS](https://github.com/OpenISS/OpenISS) project to support bindings for Java (and other languages) based of the OpenISS C++ framework. It is used as an example for a JNI library in [Processing](https://processing.org) for Java-based projects like ISSv2, known as OIGesture JNI Library in OpenISS's examples directory.

This repo is currently based on [Jashanjot Singh](https://github.com/jashanj0tsingh)'s [master's thesis](https://spectrum.library.concordia.ca/986429/) that currently covers only the OpenISS Gesture Recognition specialization framework and wrappers for NiTE2 and [Nuitrack](https://github.com/3DiVi/nuitrack-sdk) middleware.


## Building

### Requirements

- [SWIG](http://swig.org/) >= 4.0
- [CMake](https://cmake.org/) >= 3.12.2
- JDK8+

The middleware also needs to be present if used:

- OpenNI2
- NiTE2
- Nuitrack

Otherwise, the particular modules can be commented out.

The project was built and tested on Ubuntu 18+ and macOS 10.11+.

### Overview

This repository contains SWIG interface files for **OpenISS Getsure Framework** related classes, a maintainable way to let SWIG generate wrapper classes for OpenISS gesture library in a target language.

**Currently, wrappers can be generated for Java only.**

1. `mkdir build && cd build`
2. `cmake .. -DOIGESTURE_SWIG_JNI:BOOL=ON -DBUILD_SHARED_LIBS=ON`
Expand All @@ -10,3 +36,7 @@
5. `ln -s lib{OpenNI2/NiTE2/Nuitrack/Middleware} swig/` (optional)
6. `cmake .. -DOIGESTURE_SWIG_TEST_JAR=ON`
7. `make -j4`

### References

- [Jashanjot Singh](https://github.com/jashanj0tsingh), [*Universal Gesture Tracking Framework in OpenISS and ROS and its Applications*](https://spectrum.library.concordia.ca/986429/), Master's thesis, January 2020, Concordia University, Montreal

0 comments on commit 8ecbff2

Please sign in to comment.