Compiling and Installing Visualization Library

Installing the License Signature

Before compiling and installing Visualization Library you are required to specify a license signature that identifies the license that has been granted to you, and thus, the conditions under which you are allowed to use Visualization Library.

By default Visualization Library is distributed with a license certificate and license signature that allows you to use Visualization Library under the GNU GPL version 3.0 license. If you would like to develop proprietary and commercial applications you need a Professional Edition License.

You can find the default license certificate (license_certificate_gpl3.vlc) and license signature (license_signature.vls) in the root directory of Visualization Library distribution.

If you own a Professional Edition License locate the LicenseSignatures field at the end of your license certificate and substitute with it the default license signature "VLLS:A85397342177565495" contained in the license_signature.vls file. This way you will be able to develop and distribute your programs according to the Visualization Library Professional Edition License terms. Please read carefully the comments included in the license_signature.vls file.

You are now ready to compile and use Visualization Library!

Compilation and Installation

Visualization Library uses the CMake building system to target several platforms and compilers. At the moment Visualization Library supports the following development platforms:

• Windows: Visual Studio 2005-2008 32-64 bits
• Windows: MinGW
• Linux: GNU make/gcc 32-64 bits
• Mac OS X: Xcode

Note that CMake supports many other platforms and operating systems as well, in which you can probably also run Visualization Library.

Please visit http://www.cmake.org to download the latest 2.6.x CMake distribution for your operating system.

In order to compile Visualization Library with CMake you have to understand a few simple concepts that remain valid for all the platforms. When building Visualization Library you will need 3 directories:

• a source directory: the directory where Visualization Library sources are located (containing the main CMakeLists.txt)
• a build directory: the directory used to keep the temporary object and project files generated for and during the building process.
• an install directory: the directory in which Visualization Libary's executables, libraries and header files will be installed.

Run CMake, select the source directory and the build directory, then press the Configure button:

Select your building environment and press the Finish button:

The basic build environment is ready:

Variables overview:

• CMAKE_BUID_TYPE: set it to Release if you want to compile VL for maximum performance or to Debug if you want to compile VL with debugging symbols. Note that this variable is not available under Visual Studio since you can manage the Release and Debug configurations directly from the Visual Studio gui.

• CMAKE_INSTALL_PREFIX: this is the location where Visualization Library will be installed. In order to install visualization library you can either call make install under Unix-like environments or build the INSTALL project under Visual Studio.

• GUI_*_SUPPORT and GUI_*_EXAMPLES: check the appropriate variable if you would like to build the binding classes for a particular GUI framework. Note that after selecting this variable and pressing the Configure button CMake might require more information to locate the required libraries and include files (like the location of the SDL library, of the GLUT header files etc.).

• IO_MODULE_*: check the resource file formats that you want to be natively supported by VL. Selecting less modules will make Visualization Library smaller. Note that if you select modules like IO_MODULE_JPG or IO_MODULE_PNG CMake will require more information to locate the libpng and libjpeg libraries and include files.

Press the Configure button, you should see something similar to:

If you would like to reset your configuration go to the menu File -> Delete Cache.

To finalize and generate the building environment press Generate. Now you can close CMake and go to the specified build directory. If you are using a Unix-like environment you can simply type make then make install. If you are using Visual Studio you just need to double click on the VisualizationLibrarySDK.sln file and build the BUILD_ALL project and then the INSTALL project.

You are now ready to use Visualization Library!

Third Party Libraries

This is a convenience list of third party libraries used by Visualization Library:

• FreeType - http://www.freetype.org [required, included with VL]
• zlib - http://www.zlib.net [required, included with VL]
• IJG's libjpeg - http://www.ijg.org [required, included with VL]
• libpng - http://www.libpng.org [required, included with VL]
• libtiff - http://www.libtiff.org [required, included with VL]
• Qt - http://www.qtsoftware.com
• wxWidgets - http://www.wxwidgets.org
• SDL - http://www.libsdl.org
• GLUT - http://www.opengl.org/resources/libraries/glut
• FreeGLUT - http://freeglut.sourceforge.net
• GnuWin32: http://gnuwin32.sourceforge.net/packages.html (provides Win32-versions of tools and libraries with GNU or similar open source licences)