OpenSceneGraph git repository
C++ C CMake HTML Objective-C++ Objective-C
Latest commit 27c86a4 Mar 28, 2017 @robertosfield robertosfield Updated date
Permalink
Failed to load latest commit information.
CMakeModules as preparation for the upcoming 3rdParty package for Visual Studio 20… Mar 22, 2017
PlatformSpecifics From Adrian Clark, build fix for recent Android NDK using the old And… Dec 18, 2014
applications Update ChangeLog and AUTHORS file for 3.5.5 dev release Oct 7, 2016
debian_scripts Improved cpack configuration for building debian packages: Mar 20, 2017
doc/Doxyfiles Removed no longer supported doxygen settings Jun 1, 2016
examples Fixed warnings Mar 28, 2017
include Fixed typo Mar 28, 2017
packaging Removed Qt dependency examples, osgQt NodeKit and qfont plugin as the… Sep 26, 2016
src Fixed ac plugin's handling of rot primitive in .ac files Mar 27, 2017
.codedocs Reduced public documentation generation to just the public headers Nov 15, 2016
.gitignore Added conditionals for GLES3, added correct gl headers for GLES3 on i… Mar 20, 2017
.travis.yml Update travis-ci to use the new more flexible BUILD_OSG_PLUGINS_BY_DE… Feb 28, 2017
AUTHORS.txt Updated AUTHORS for 3.5.5 Oct 7, 2016
CMakeLists.txt Fixed ac plugin's handling of rot primitive in .ac files Mar 27, 2017
CTestConfig.cmake From Jean-Sebastien Guay, updated CTestConfig to point to new cdash.o… Jul 24, 2009
ChangeLog Updated ChangeLog Oct 7, 2016
LICENSE.txt From J.P. Delport, tweak to fix spelling and grammer Apr 10, 2009
NEWS.txt Added 3.4 press release to NEWS.txt May 6, 2016
README.md Updated date Mar 28, 2017
runexamples.bat Removed old examples that relied upon deprecated functionality Jun 17, 2016

README.md

Build Status Coverity Status Documentation

Introduction

Welcome to the OpenSceneGraph (OSG).

For up-to-date information on the project, in-depth details on how to compile and run libraries and examples, see the documentation on the OpenSceneGraph website:

http://www.openscenegraph.org/index.php/documentation

For support subscribe to our public mailing list or forum, details at:

http://www.openscenegraph.org/index.php/support

For the impatient, we've included quick build instructions below, these are are broken down is three parts:

  1. General notes on building the OpenSceneGraph
  2. OSX release notes
  3. iOS release notes

If details below are not sufficient then head over to the openscenegraph.org to the Documentation/GettingStarted and Documentation/PlatformSpecifics sections for more indepth instructions.

Robert Osfield. Project Lead. 28th March 2017.

--

Section 1. How to build the OpenSceneGraph

The OpenSceneGraph uses the CMake build system to generate a platform-specific build environment. CMake reads the CMakeLists.txt files that you'll find throughout the OpenSceneGraph directories, checks for installed dependenciesand then generates the appropriate build system.

If you don't already have CMake installed on your system you can grab it from http://www.cmake.org, use version 2.8.0 or later. Details on the OpenSceneGraph's CMake build can be found at:

http://www.openscenegraph.org/projects/osg/wiki/Build/CMake

Under unices (i.e. Linux, IRIX, Solaris, Free-BSD, HP-Ux, AIX, OSX) use the cmake or ccmake command-line utils. Note that cmake . defaults to building Release to ensure that you get the best performance from your final libraries/applications.

cd OpenSceneGraph
cmake .
make
sudo make install

Alternatively, you can create an out-of-source build directory and run cmake or ccmake from there. The advantage to this approach is that the temporary files created by CMake won't clutter the OpenSceneGraph source directory, and also makes it possible to have multiple independent build targets by creating multiple build directories. In a directory alongside the OpenSceneGraph use:

mkdir build
cd build
cmake ../OpenSceneGraph
make
sudo make install

Under Windows use the GUI tool CMakeSetup to build your VisualStudio files. The following page on our wiki dedicated to the CMake build system should help guide you through the process:

http://www.openscenegraph.org/index.php/documentation/platform-specifics/windows

Under OSX you can either use the CMake build system above, or use the Xcode projects that you will find in the OpenSceneGraph/Xcode directory. See release notes on OSX CMake build below.

For further details on compilation, installation and platform-specific information read "Getting Started" guide:

http://www.openscenegraph.org/index.php/documentation/10-getting-started

Section 2. Release notes on OSX build, by Eric Sokolowsky, August 5, 2008

There are several ways to compile OpenSceneGraph under OSX. The recommended way is to use CMake 2.6 to generate Xcode projects, then use Xcode to build the library. The default project will be able to build Debug or Release libraries, examples, and sample applications. Here are some key settings to consider when using CMake:

BUILD_OSG_EXAMPLES - By default this is turned off. Turn this setting on to compile many great example programs.

CMAKE_OSX_ARCHITECTURES - Xcode can create applications, executables, libraries, and frameworks that can be run on more than one architecture. Use this setting to indicate the architectures on which to build OSG. Possibilities include ppc, ppc64, i386, and x86_64. Building OSG using either of the 64-bit options (ppc64 and x86_64) has its own caveats below.

OSG_BUILD_APPLICATION_BUNDLES - Normally only executable binaries are created for the examples and sample applications. Turn this option on if you want to create real OSX .app bundles. There are caveats to creating .app bundles, see below.

OSG_WINDOWING_SYSTEM - You have the choice to use Carbon or X11 when building applications on OSX. Under Leopard and later, X11 applications, when started, will automatically launch X11 when needed. However, full-screen X11 applications will still show the menu bar at the top of the screen. Since many parts of the Carbon user interface are not 64-bit, X11 is the only supported option for OSX applications compiled for ppc64 or x86_64.

There is an Xcode directory in the base of the OSG software distribution, but its future is limited, and will be discontinued once the CMake project generator completely implements its functionality.

APPLICATION BUNDLES (.app bundles)

The example programs when built as application bundles only contain the executable file. They do not contain the dependent libraries as would a normal bundle, so they are not generally portable to other machines. They also do not know where to find plugins. An environmental variable OSG_LIBRARY_PATH may be set to point to the location where the plugin .so files are located. OSG_FILE_PATH may be set to point to the location where data files are located. Setting OSG_FILE_PATH to the OpenSceneGraph-Data directory is very useful when testing OSG by running the example programs.

Many of the example programs use command-line arguments. When double-clicking on an application (or using the equivalent "open" command on the command line) only those examples and applications that do not require command-line arguments will successfully run. The executable file within the .app bundle can be run from the command-line if command-line arguments are needed.

64-BIT APPLICATION SUPPORT

OpenSceneGraph will not compile successfully when OSG_WINDOWING_SYSTEM is Carbon and either x86_64 or ppc64 is selected under CMAKE_OSX_ARCHITECTURES, as Carbon is a 32bit only API. A version of the osgviewer library written in Cocoa is needed. However, OSG may be compiled under 64-bits if the X11 windowing system is selected. However, Two parts of the OSG default distribution will not work with 64-bit X11: the osgviewerWX example program and the osgdb_qt (Quicktime) plugin. These must be removed from the Xcode project after Cmake generates it in order to compile with 64-bit architectures. The lack of the latter means that images such as jpeg, tiff, png, and gif will not work, nor will animations dependent on Quicktime. A new ImageIO-based plugin is being developed to handle the still images, and a QTKit plugin will need to be developed to handle animations.

Section 3. Release notes on iOS build, by Thomas Hogarth

With CMake, XCode and the iOS sdk installed you can generate an iOS XCode project using the following command line

export THIRDPARTY_PATH=/path/to/my/3rdParty cmake ./ -G Xcode -DOSG_BUILD_PLATFORM_IPHONE:BOOL=ON
-DIPHONE_SDKVER="10.2"
-DIPHONE_VERSION_MIN="8.0"
-DOPENGL_PROFILE:STRING=GLES2
-DBUILD_OSG_APPLICATIONS:BOOL=OFF
-DBUILD_OSG_EXAMPLES:BOOL=ON
-DOSG_WINDOWING_SYSTEM:STRING=IOS
-DOSG_DEFAULT_IMAGE_PLUGIN_FOR_OSX="imageio"
-DDYNAMIC_OPENSCENEGRAPH:BOOL=OFF
-DDYNAMIC_OPENTHREADS:BOOL=OFF
-DCURL_INCLUDE_DIR:PATH="$THIRDPARTY_PATH/curl-ios-device/include"
-DCURL_LIBRARY:PATH="$THIRDPARTY_PATH/curl-ios-device/lib/libcurl.a"
-DFREETYPE_INCLUDE_DIR_freetype2:PATH="$THIRDPARTY_PATH/freetype-ios-universal/include/freetype"
-DFREETYPE_INCLUDE_DIR_ft2build:PATH="$THIRDPARTY_PATH/freetype-ios-universal/include"
-DFREETYPE_LIBRARY:PATH="$THIRDPARTY_PATH/freetype-ios-universal/lib/libFreeType_iphone_universal.a"
-DTIFF_INCLUDE_DIR:PATH="$THIRDPARTY_PATH/tiff-ios-device/include"
-DTIFF_LIBRARY:PATH="$THIRDPARTY_PATH/tiff-ios-device/lib/libtiff.a"
-DGDAL_INCLUDE_DIR:PATH="$THIRDPARTY_PATH/gdal-ios-device/include"
-DGDAL_LIBRARY:PATH="$THIRDPARTY_PATH/gdal-ios-device/lib/libgdal.a"

Be sure to set the THIRDPARTY_PATH to the path containing your thirdparty dependancies. Set IPHONE_SDKVER to the version of the iOS sdk you have installed, in this instance 10.2. IPHONE_VERSION_MIN controls the base sdk used by xcode, and lastly set OPENGL_PROFILE to the version of GLES you want to use.

Once this completes an XCode project will have been generated in the osg root folder. Open the generated Xcode project, select the example_osgViewerIPhone target. In 'General' tab set a development team. In the 'Build Settings' tab search for 'Other Linker Flags', then for each target type (debug, release etc) that you want to use open the list of arguments and delete the 'OpenGL' line and the '-framework' line above it. This is because cmake has tried to add the desktop OpenGL library which we don't want.

Once this is done you should be able to build and deploy the example_osgViewerIPhone target on your device.