OSGART: ARToolKit for OpenSceneGraph

Installation

This section describes how to download and build OSGART and its dependencies.

Dependencies

Minimum requirements for OSGART:

OpenSceneGraph 1.2
ARToolKit 2.72

The Windows installer package ships with prebuilt binaries for ARToolkit but is only usable with Visual Studio .NET 2003 and the binary package by Mike Weiblen.

Download

Download OpenSceneGraph. If you working on Windows the recommended combination is to use the OpenSceneGraph Windows installer and the OSGART Windows installer. The installer package will detect the OpenSceneGraph package and will add the files needed to run OSGART.

Download ARToolKit.

Build Instructions

OSGART is supported on Windows, Mac OSX and Linux platforms. Please make sure your development environment matches our minimum requirements. Ensure ARToolKit is installed and running correctly. Follow these instructions if you need assistance. The following sections will cover the respective operating systems. We also provide a meta build system for osgART using bakefile in case you need to regenerate some the make or project files.

Windows

You will find project files for Visual Studio .NET 2003 and Visual Studio 2005 in the /VisualStudio/osgART/ folder in the source package. We are not supporting Visual Studio 2005 actively due to known reasons and various SDK not yet ready to work with the compiler included.

Make sure Visual Studio .NET 2003 can find headers and libraries for OpenSceneGraph and ARToolKit

Build the libraries in the following order:

	osgART
	osgart_artoolkit
	osgart_artoolkit_tracker
	osgart_dummyimage
	osgart_example

For debugging purposes we also recommend to keep the OpenSceneGraph/bin directory in the $PATH variable.

Linux

unpack osgART into a local folder (e.g. /home/thatsme/Projects/)
```
	$> tar xfzj osgART-x.x.tar.bz2
	
```
you unpacked osgART into /home/thatsme/Projects/osgART
```
	$> cd /home/thatsme/Projects/osgART/bin
	
```

You need to know where artoolkit is installed and start make

	$> make -f GNUmakefile ARTOOLKIT_PATH="/home/thatsme/Projects/artoolkit"

Assure the ARTOOLKIT_CONFIG is set correctly for the videocapture you are using. For example using GStreamer with the TV testsignal simulator you can use:
```
	$> echo $ARTOOLKIT_CONFIG
	videotestsrc ! identity name=artoolkit ! fakesink
  
```
or for using Video4Linux it should read something like this:
```
	$> echo $ARTOOLKIT_CONFIG
	-dev=/dev/video0 -width=320 -height=240 -palette=YUV420P
   
```
Please consult the ARToolKit documentation for more information how to set up video capturing correctly.
To run the example the runtime linker need to be able to load the plugins. For example in a bash shell:
```
	$> export LD_LIBRARY_PATH=".:$LD_LIBRARY_PATH"
  
```
run the example
```
	$> ./osgart_example
```
For using the same build system as osgART you need bakefile. You can copy the original bakefile to a new one and add another target for your application.
```
	$> cd /home/thatsme/Projects/osgART/bin
	$> cp osgART.bkl MyosgART.bkl
```
You need to edit the bakefile for making changes to the source and include directories of your project. Additionally you need to regenerate the makefile from the bakefile.
```
	$> bakefile -f gnu MyosgART.bkl
```

Mac OSX

Prerequisites:

Apple's Xcode Tools, version 2.4 or later. Available free with registration with ADC at http://developer.apple.com.
ARToolKit version 2.72 or later. ARToolKit may have additional dependencies listed in its readme file.
OpenSceneGraph 1.1 or later in Mac OS X binary format. (version 1.2 recommended.)

Setting up the necessary directory structure:

osgART must be able to find its dependencies during the build process. The XCode project file comes setup for a folder structure like this:

someDirectory/   (top-level development directory)
	ARToolKit/
		bin
		examples
		include
		lib
	OpenSceneGraph/
		Examples/
		Frameworks/
		Plugins/
	OSGART/
		bin/
		docs/
		etc/
		include/
		src/
		VisualStudio/
		XCode/

If you wish to change this structure, you must edit the search path settings inside the build settings inspector for every one of the targets.

Building using the XCode IDE:

Unpack the archive to a convenient location, and open the file XCode/osgART.xcodeproj.
Make sure that ARToolKit 2.72 builds and that you can run the simpleLite ARToolKit example without errors.
Build osgART.

Running the built application:

The osgARTTest example is built as a bundled application, and can be moved from its original location to anywhere on the system. It can be run double clicked from the Finder (debug output will appear in Console) or from within XCode.

OSGART