Development overview

Table 1. What you need
you want to Use SolAR framework Contribute to SolAR framework

SolAR module source code

no

yes

SolARFramework setup

yes

no

SolARFramework third parties

yes

yes

QT or Visual C++

yes

yes

SolARFramework source code

no

yes

SolarFramework Installer for windows

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 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, Samples and Unit Tests 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 image 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.

Please refer to the samples part to know how to use samples getting started linux..

SolarFramework Installer for linux (Ubuntu 18.04)

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

and

you must have a BCOMDEVROOT environment variable defined, and this variable must point to a directory where all binaries (built libraries and third parties libraries) will be copied
  • open a terminal and go to the directory where you have saved SolARFramework-0.5.tar.xz and SolARFrameworkInstall-0.5.sh

  • run the following commands

foo@bar:~$ chmod 755 SolARFrameworkInstall-0.5.sh
foo@bar:~$ ./SolARFrameworkInstall-0.5.sh all
  • note that you can run

foo@bar:~$ ./SolARFrameworkInstall-0.5.sh

to get instructions on how to use the installer.

  • as a result, a SolARFramework directory should now be present under the folder where you ran the installer script. This directory should contain

foo@bar:~$ ls SolARFramework
build-scripts  samples  sources
  • 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

Frequently Asked Questions

  1. When I run the installer, it asks me to update pkgconfig, do I need to accept?

    yes, please accpet it will uninstall the current version and replace by a new one.