Installation & Verification - Java - OS X

General installation information

Toolkit Installation

Environment variables

Install as Java extension (optional)

Documentation installation (optional)


General installation information

In order to install Open Inventor Java see requirements on page System Requirements. The Java™ Runtime Environment (JRE) 1.7 or 1.8 or Java™ Development Toolkit (JDK) 1.7 or 1.8 is required for building and running examples.

This page describes how to install Open Inventor Java on OS X platform. The Java classes are cross-platform but the native runtimes must be installed for each platform.

The URL links to download Open Inventor installers are delivered by the upgrade e-mail. If you select the link: "Download Open Inventor Java", a download page is opened and you can select the requested package "for OS X" platform: TAR.GZ 64-bit.

Toolkit Installation

The Open Inventor Toolkit for OS X is distributed as a compressed TAR archive (.tar.gz.). The toolkit package name is:

OpenInventorJava<product release>-MacOSX-x86_64.tar.gz

This package contains the include JAR files, native shared libraries, example programs, data files, and Java reference manual.

The Open Inventor Java Toolkit requires a license. Please read the Licensing page for details.

To install Open Inventor Java, copy the file to your Open Inventor home folder (OIVJHOME, see Environment variables section for details) then uncompress the package. For instance from the Terminal application, type:

cd /usr/local/${OIVJHOME} 
tar -xzvf OpenInventorJava950-MacOSX-x86_64.tar.gz

Environment variables

To set a variable in a local window running the bash shell (the OS X default), use the "export" command:

export VARIABLE_NAME="value"

When using the csh or tcsh shells, use "setenv":

setenv VARIABLE_NAME "value"

Here is the list of Open Inventor environment variables:

  • OIVJHOME must be set to the Open Inventor Java home installation directory,
  • The library path DYLD_LIBRARY_PATH must contain the path to the native libraries of Open Inventor Java: ${OIVJHOME}/jre/lib/x86_64.
  • OIV_LICENSE_FILE: this is necessary if the default license file ${OIVJHOME}/license/password.dat is not used. This variable must contain the absolute path to the license file password.dat. Please read the Licensing page for details.

If Open Inventor Java is not installed as a Java extension, your CLASSPATH and library path must be set:

  • CLASSPATH must contain the path to the following JAR files: 


and when using MeshViz XLM extension: 

  • CLASSPATH can also contain the Open Inventor Java resource file.

This file is delivered in the toolkit package and it is located in ${OIVJHOME}/properties. The name of the resource file is and it can be used to override environment variables. The file contains some comments explaining how to do this. 

Each property defined in this file overrides the environment variable of the same name during the execution of your program. For instance, if a property OIVJHOME is defined, it overrides the environment variable ${OIVJHOME}.

Installation as Java Extension (optional)

Open Inventor Java can be installed as a Java extension: the Open Inventor runtime files (JAR files and native shared libraries) should be copied into the JRE or JDK.

Installing the runtime files inside Java causes Open Inventor Java to be considered a standard Java extension, with the following benefits:

  • Open Inventor Java has privileged permission (despite Open Inventor JAR files not being signed),
  • Open Inventor JAR files are automatically found by the JVM, so you do not need to add them to the CLASSPATH environment variable,
  • the shared libraries lib*.dylib are automatically found by the JVM, so you do not need to add them to the library path LD_LIBRARY_PATH.

See the Java Extension Mechanism or the Java Tutorial for additional information about Java extensions.

Documentation installation (optional)

The Open Inventor Developer Zone contains the complete Open Inventor documentation. If no internet access is available, the offline documentation can be used. It is distributed in a separate package:

OpenInventorJava<product release>-Documentation.tar.gz
The archive contains a set of HTML pages extracted from the Open Inventor Developer Zone. Note that in the offline version, some features, like searching and the list of fixed bugs per version, are not available. 
To install the documentation uncompress the archive in the installation directory of Open Inventor Java:


tar -xzvf <path>/OpenInventorJava950-Documentation.tar.gz