How to install

Prior to start, be sure that SolAR and your working environment are correctly configured as explained in the following :

Install SolAR version 0.6.0 - Windows 7/10

A SolAR Framework Windows installer is provided in order to quickly install:

  • the SolARFramework library (debug and release modes) and interfaces (C++ header files)

  • SolAR modules libraries (debug and release modes) and interfaces (C++ header files)

  • the required third party libraries (debug and release modes) and third party interfaces (C++ header files)

  • the QT creator pre-requisites

  • SolAR samples (C++ sample code)

The installer can be downloaded here:

Using the installer is straightforward:

  1. download then launch the installer

  2. read then accept the license agreement, then press "Next"

Please close QT Creator, if running, on your computer, before executing the installer.
run installer
  1. select the destination installation folder (default is: C:\SolARFramework).

run installer
  1. select the components you want to install.

run installer

Regarding this last step, you have the choice between:

  • SolAR libraries: this will install SolAR Framework and SolAR modules libraries and interfaces only.

  • QT creator dependencies: this will install a windows version of pkg-config program, used by SolAR build scripts to generate Makefiles under QT creator

  • Third party libraries: this will install the following third party libraries and interfaces: fbow, freeglut, opencv, boost, eigen, spdlog and xpcf

  • Sources: this will install a sources folder containing SolAR Framework, Modules and Samples sources.

  • Sample code: this will create a Samples folder under your SolARFramework installation folder. This folder contains sample C++ projects that you can use to learn the basics of SolAR.

  • Build scripts: this will create a build-scripts folder containing bash scripts to manage git repositories and to compiles sources

  • Executable Samples: this will create a Samples folder containing 4 executable samples (fiducial marker, natural image marker, triangulation based on 2 images and a SLAM sample)

Please use the default values: it will install everything you need to use SolAR, especially if you want to first test a sample code.

Install SolAR version 0.6.0 - Ubuntu 18.04

  • download both files SolARFramework-0.6.0.tar.xz and SolARFrameworkInstall-0.6.0.sh at the following address:

  • open a terminal and go to the directory where you have saved SolARFramework-0.6.0.tar.xz and SolARFrameworkInstall-0.6.0.sh

  • run the following commands

    foo@bar:~$ chmod 755 SolARFrameworkInstall-0.6.0.sh
    foo@bar:~$ ./SolARFrameworkInstall-0.6.0.sh all
  • note that you can run the following command to get instructions on how to use the installer:

    foo@bar:~$ ./SolARFrameworkInstall-0.6.0.sh
  • as a result, a SolARFramework directory should now be present under your HOME directory. This directory should contain:

    foo@bar:~$ ls SolARFramework
    build-scripts  samples  sources SolARLibraries
  • in your terminal you can now run samples (executable) contained under the samples/ folder

  • you can also browse SolAR sources under the sources folder

  • you will be able to update your source tree, running the following command:

    foo@bar:~$ ./build-scripts/updateGit.sh develop
  • finally you will be able to compile the source code:

    foo@bar:~$ ./build-scripts/cmake-build.sh all
  • note that in order to run samples your LD_LIBRARY_PATH needs to contain current directory ("./"). This can be performed by running the following command:

    foo@bar:~$ export LD_LIBRARY_PATH=.:$LD_LIBRARY_PATH

Next Steps

In the context of SolAR, a pipeline is a set of connected actions that takes on one hand a camera frame. Actions are performed via C++ methods with dedicated input/output parameters. Generally output parameters of one action serve as input parameters for subsequent actions, hence the term pipeline.

The SolAR framework provides a comprehensive list of usable methods that are located in the API directory.

Also SolAR provides a set of modules that implement the said methods.

To build a pipeline, it is necessary to identify what are the required actions and which modules/components are available to perform them.

Section "Get Modules" explains this in detail.

Once it is done, due to the use of XPCF, the three main items to take care of are :

  • a configuration file

  • a dependencies description file

  • a build configuration file (.pro or cmake)