Visual Servoing Platform  version 3.2.0 under development (2018-08-20)
Tutorial: Installing ViSP for Java

Introduction

This tutorial will help you to install ViSP for Java on your desktop.

Install Java JDK

Download the latest Java JDK from the Oracle website. Now you should be able to install the last Java JDK by opening the file just downloaded.

Note
If you download jdk-10.0.1_linux-x64_bin.tar.gz (case of linux), after extracting the files from the archive, you may set JAVA_HOME environment var to help cmake to detect JDK. This could be done like:
$ tar xvzf jdk-10.0.1_linux-x64_bin.tar.gz -C $HOME
$ echo "export JAVA_HOME=$HOME/jdk-10.0.1" >> ~/.bashrc
$ source ~/.bashrc

Install Prerequisites

As a prerequisite, download and install first CMake and Apache Ant, if you don’t have any of these.

  • On Ubuntu/Debian you may run:
    $ sudo apt-get install cmake-curses-gui ant
  • On Fedora/CentOS you may run:
    $ sudo yum install gcc-c++ cmake ant
  • On MacOS/OSX you may run:
    $ brew cask install java
    $ brew install cmake ant

Install ViSP from source code

Create a workspace

  • First create a workspace in $HOME/visp-ws that will contain ViSP source, build and dataset.
    $ export VISP_WS=$HOME/visp-ws
    $ mkdir -p $VISP_WS

Getting ViSP source code

There are different ways to get ViSP source code:

  • You can download the latest release as a zip or a tarball. Once downloaded, uncompress the file using either
    $ tar xvzf visp-x.y.z.tar.gz -C $VISP_WS
    or
    $ unzip visp-x.y.z.zip -d $VISP_WS
  • You can also download a daily snapshot. Once downloaded, uncompress the file using
    $ tar xvzf visp-snapshot-yyyy-mm-dd.tar.gz -C $VISP_WS
  • Or you get the cutting-edge ViSP from GitHub repository using the following command
    $ cd $VISP_WS
    $ git clone https://github.com/lagadic/visp.git

We suppose now that ViSP source is in the directory $VISP_WS/visp. The following should be adapted if you downloaded ViSP from a zip or tarball. In that case, the source is rather in something like $VISP_WS/visp-x.y.z.

Configuring ViSP from source

  • In the workspace, create first a directory named visp-build that will contain all the build material; generated Makefiles, object files, output libraries and binaries.
    $ mkdir $VISP_WS/visp-build
  • Enter the visp-build folder and configure the build:
    $ cd $VISP_WS/visp-build
    $ cmake ../visp
    A more versatile way to configure the build is to use ccmake, the CMake GUI:
    $ ccmake ../visp
    The following image shows that this command allows to configure (just by pressing [c] key) the build in a more advanced way where some options could be easily turned ON/OFF. It allows also to see which are the 3rd parties that will be used. To generate the makefiles, just press [g] key in the ccmake gui.
    img-tutorial-java-ccmake.jpeg
    Snapshot of the ccmake ../visp command used to configure ViSP.

Building ViSP libraries

  • To build ViSP libraries on Linux, proceed with:
    $ cd $VISP_WS/visp-build
    $ make -j$(nproc)
  • To build ViSP libraries on MacOS/OSX, proceed with:
    $ cd $VISP_WS/visp-build
    $ make -j$(sysctl -n hw.ncpu)

Setting Up ViSP Java in Eclipse

Install the latest Eclipse version

Download the latest Eclipse version at the Eclipse Download page choosing the Eclipse IDE for Java Developers version. You don’t need to install anything. Extract the downloaded compressed file and put the resulting folder wherever you want to.

Creating a user library

Open Eclipse and select a workspace of your choice. Create a User Library, ready to be used on all your next projects: go to "Window \> Preferences" menu:

img-tutorial-java-eclipse1.jpeg
Open Preferences panel in Eclipse

In the Preferences panel navigate under "Java \> Build Path \> User Libraries" and choose New. Enter a name for the library (e.g visp) and select the newly created user library.

img-tutorial-java-eclipse2.jpeg
Create a new User Library

Press "Add External JARs" button, browse to select $VISP_WS/visp-build/bin/visp-3yz.jar from your computer. After adding the jar, select "Native library location", press first "Edit", then press "External Folder" and finaly browse to select the folder $VISP-WS/visp_build/lib containing ViSP libraries. We recall that the libraries have the extension .so in linux, .dylib in MacOS and .dll in Windows).

img-tutorial-java-eclipse3.jpeg
Add jar and native libraries to User Library

Once done, press "Apply and Close" button.

Next tutorial

You are now ready to follow Tutorial: First java application with ViSP.