Windows - Linux - MacOS


Windows

Administrator privileges
Verify adequate disk space
Details on installers
Load Open Inventor from your installation media
Toolkit installation process
Using example programs
Essential MSVC++ settings
Configuring MSVC++
Uninstalling Open Inventor

Administrator privileges
Administrator privileges are required to install Open Inventor. If you do not have Administrator privileges on the machine where you are installing, Setup will not be able to create the Open Inventor program group or set up the Open Inventor environment variables at the System (all users) level.

User privileges are modified using the User Accounts.

Verify adequate disk space
See the System Requirements Overview topic for disk space requirements.

We recommend installing on an NTFS partition in order to take advantage of long file names. The Open Inventor libraries and DLLs have short names to facilitate redistribution, but the Open Inventor include files and example programs have long file names to convey extra information.

Details on installers
The complete installation contains Open Inventor Toolkit package named OpenInventorC++-Windows-Visual-.exe

This package contains the include files, libraries, utilities, example programs, data files, and C++ reference manual in Windows help format.
Example: OpenInventorC++940-Windows-Visual2012-x86_64.exe

Load Open Inventor from your installation media

To install the Open Inventor SDK from downloaded files:

  1. Exe files : are installation programs that can be run directly. So
    • Download the file on the target system.
    • Double-click on the file from the Windows Explorer.
    • Follow the installation instructions.

    Note that with these .exe files, environment variables are automatically set. These variables are:

    • OIVHOME : points to the root installation folder given during step "Choose Install Location". By default this folder is set to something like C:\Open Inventor\ C++ Visual2015 x<86|64>
    • OIVARCH : is automatically set to arch-Windows--msvc-Release
    • PATH : %OIVHOME%/%OIVARCH%/bin is added to the PATH variable
    • OIV_LICENSE_FILE : points to the password.dat file given during installation. If none was given the variable is set to %OIVHOME%/License/password.dat
  2. With Zip files installation has to be done manually. So
    • Download the file on the target system
    • Extract the package to the folder of your choice

    Once package is extracted, you have to define following environment variables:

    • OIVHOME : points to the folder where you decompressed archive (complete path)
    • OIVARCH : must be defined to arch-Windows-***-Release where *** matches the compiler you choose to use. The folder can be found directly under OIVHOME to be sure to use the good folder name. Please be sure to set only the name of this folder, not the complete path to this folder
    • PATH : must add %OIVHOME%/%OIVARCH%/bin to the existing PATH variable
    • OIV_LICENSE_FILE : should contains the full path to the password.dat (filename included)

Toolkit installation process

  1. Welcome dialog
  2. License Agreement dialog
  3. Components selection dialog
    You can choose to install or not the SDK, the runtime environment (debug or PDB files, release is mandatory), example programs (source code or binaries), and reference manual.
  4. Installation location dialog
    Setup will suggest a default location for the installation, e.g., C:\OpenInventor\9.4.0 C++ Visual2012 x64, and allows you to select a different location if desired. We recommend using a directory name that includes the version number.
    Avoid using the Windows operating systems C:\Program Files directory because it protects its content and you will not be able to edit and build example programs.
  5. Start Menu Folder dialog
    You can choose the Windows Start Menu folder. The default is to use the same name as for the installation folder.
  6. Install
    All Open Inventor files will be installed into the selected installation directory. With one exception (see MSVC++ below), the installer does not put any files in system directories, only in the selected installation directory.
  7. Copy License dialog
    At this step, the installer asks to locate the file containing the license strings necessary to unlock the product that you should have received from our licensing team. The environment variable OIV_LICENSE_FILE is set to the path of this file in the user's environment.
  8. Environment Variables
    Setup will set the following environment variables for all users (added to the System environment variables): OIVHOME, OIVARCH, OIV_LICENSE_FILE, and add to the PATH variable the path to the Open Inventor DLLs. If you downloaded the zip archive: please be sure to set these variables manually in you environment. OIVHOME must be set to the path to your Open Inventor installation and OIVARCH to the (something like arch-Windows-x86_64-msvc12-release). Then in your PATH variable add the %OIVHOME%/%OIVARCH%/bin directory. OIV_LICENSE_FILE must, of course, point to the complete path of valid license file.NOTE: Environment variable changes do not affect running programs. To ensure that changes are applied, you may need to (one of the proposition):

    • Log out and log in again
    • Open the Control Panel, open the System applet, click on Advanced, click on Environment Variables, and click on OK.
  9. MSVC++ Customization
    The IVF AppWizard is an application similar to MSVC++'s MFC AppWizard for creating MFC-based Open Inventor applications. The IVF AppWizard can create an application with a simple drawing area, a basic viewer (e.g., Examiner Viewer), or a fully functional SceneViewer with the ability to select and edit objects.
    In versions prior to V9.1, the IVF Wizard was added to Visual Studio during the installation process. Now, the IVF application wizard is no longer installed during the installation process. It must be installed manually following the instructions given in the Configuring MSVC++ for Use with Open Inventor chapter.
  10. Program Group
    Setup will create the following icons in the Open Inventor group.
  • IvTune viewer: an application for viewing Open Inventor files.
  • Online documentation: a link to the Open Inventor Developer Zone containing the full documentation.
  • Samples browser: a program to browse and run the Open Inventor example programs.
  1. Completing the installation

The last installation dialog allows you to launch the Open Inventor Samples browser, to read the Readme file, and to access the online documentation.
To validate the installation, run the Samples browser and try to run some demonstration programs. See the Using example programs chapter for validation of the development environment.

Using example programs

The Open Inventor toolkit comes with hundreds of example programs showing how to use the various features. The source code of these programs is located in the %OIVHOME%/examples/source directory.

All example programs are already built and ready to be run after installation as soon as the environment variables are set. The Samples Browser program can be used to browse these example programs, to run them, and to read their documentation (if it is available) and to access the source code directory.

Visual Studio projects are also available in each subdirectory for building and testing them. Each project can be reused or modified freely for experimenting. If you wish to generate your own Makefiles or project using CMake, please read the Build Examples section for more details.

Essential MSVC++ settings for an Open Inventor project

There are numerous ways to create an Open Inventor project in Visual C++. You can use the IVF AppWizard to create a new project complete with skeleton source files and project or makefile ready to build. You can also modify one of the provided Open Inventor make files or project files for your own project. You can also create simple projects from scratch or add Open Inventor support to an existing project. Here are some guidelines for Open Inventor projects.

  • Run-Time Library
    Open Inventor is compiled with (and absolutely requires) the runtime library option Multithreaded DLL (or Debug Multithreaded DLL). The IVF AppWizard selects this setting automatically.
    You must select this setting manually if your project was not created with the IVF AppWizard.Visual Studio

    1. In the Project menu, select Properties.
    2. In the left pane of the Property Pages dialog, open the C/C++ folder.
    3. In the left pane, click on Code Generation.
    4. In the right pane, click on Runtime Library, and from the list box, select Multi-threaded DLL (or Multi-threaded Debug DLL for the debug target).
  • Open Inventor Libraries
    The Open Inventor header files contain #pragma statements that automatically request the linker to search the necessary libraries.One exception is "UNIX style" programs (i.e., programs that have a main function), that are Windows applications, not console applications. These applications must include InventorU(D).LIB in the link string because they require a WinMain function, which is supplied by the InventorU library. Generally we recommend using a console application for this type of project.NOTE: For UNIX style programs that do have a main and that are Windows apps, we now recommend using SoWinApp.h in your application to simplify some of the housekeeping details. It has pragma statements to include the current version of InventorU.LIB and InventorUD.LIB. It also has the following statements so you no longer need to insert them directly in your code:

    		#ifdef _WIN32
    		#  define main ivMain
    		#endif

Configuring MSVC++ for use with Open Inventor

  1. Add include files and library files using Microsoft Visual Studio 2008.
    Pull down the Tools menu, and select Options...
    In the left pane, click on the Projects and Solutions folder, then select VC++ Directories.
    In the right pane, in the "Show Directories for" scrolling region, select Include files.
    Click the New button and enter the directory path of the Open Inventor include directory (e.g., %OIVHOME%\include).In "Show Directories for", select Library files.
    Click the New button and enter the directory path of the Open Inventor lib directory. You can add both release and debug paths (e.g., %OIVHOME%\arch-...-release\lib and %OIVHOME%\arch-...-debug\lib).Click OK to dismiss the Options... window.
  2. Add include files and library files using Microsoft Visual Studio 2010 and 2012.
    You can use property sheets to create project configurations that can be applied to multiple projects since project settings that are defined in .props files are inheritable, unlike project settings defined in Project Files (.vcxproj files). Therefore, a project configuration defined in a .vcxproj file can inherit project settings from one or more property sheets (.props files). For more information, see MSDN.
    In this file you can specify include path for Open Inventor include directory (e.g.,%OIVHOME%\include) and library path for libraries directories (e.g., %OIVHOME%\arch-...-release\lib and %OIVHOME%\arch-...-debug\lib).
  3. Installing the IVF AppWizard:
    1. Go to IvfWizard in the Open Inventor directory.
      For example, %OIVHOME%\tools\IvfWizard\
    2. Copy the contents of the vcprojects folder to the vcprojects folder in the directory where Visual Studio is installed. For example, C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\vcprojects\ or
      C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\vcprojects\ or C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\vcprojects\
    3. Copy the contents of the VCWizards folder to the VCWizards folder in the directory where Visual Studio is installed. For example, C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\VCWizards\ or
      C:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\VCWizards\ or C:\Program Files (x86)\Microsoft Visual Studio 11.0\VC\VCWizards\

    The wizard will be available the next time that you select File, New Project in Visual C++ Projects, IVF AppWizard.

    NOTE: This wizard was installed by the product installer in versions prior to V9.1. This is no longer the case.

Uninstalling Open Inventor
According to Operating System you have different procedure to uninstall Open Inventor. For example for Windows 7, it can be removed with the Programs and Features in the Control Panel. Select Open Inventor C++ 9.9.xx from the list and uninstall it.


Linux

Root privileges
Verify adequate disk space
Select an installation directory
Load Open Inventor from your installation media
Set up the License Key
Set the environment variables
Check the installation
Using sample programs
Generate sample makefile
Un-installing Open Inventor

Root privileges
In order to install Open Inventor, you must be allowed to write into the installation directory. If the location you have chosen (e.g., /usr/local) requires root privileges, then you must have root privileges to do the installation (and subsequent upgrades or uninstallation).

Verify adequate disk space
See the System Requirements Overview topic for disk space requirements.

Select an installation directory
You can install the Open Inventor SDK anywhere on your system. It is highly recommended that you use an empty directory for your new Open Inventor installation. The directory may have any name you like. We suggest you choose the name "OpenInventor" with the current version number appended. For example, "OpenInventor900".

The default installation directory is /usr/local/OpenInventorCpp. To install in this directory, you will need root privileges.

Load Open Inventor from your installation media
The Open Inventor Toolkit is distributed as a RPM package and a compressed archive.

RPM package (for RPM-based Linux Platforms)
The RPM package name is OpenInventorC++--Linux--.rpm

Installation Instructions
1. Become root by running su and entering the super-user password.

2. Download and install the cmake RPM package (required).

3. Install Extra Packages for Enterprise Linux (EPEL) to satisfy the CMake (cmake3) dependency.

  yum install epel-release  

4. Install the Open Inventor RPM package

  yum localinstall OpenInventorC++--Linux--.rpm 

This command will install Open Inventor C++ package and all dependencies (except for cmake).

You can change the default installation directory by using the following command:

   rpm -ivh --prefix  OpenInventorC++--Linux--.rpm 

Compressed archive (for Linux Platforms)

The archive package name is OpenInventorC++--Linux--.tar.gz

Installation Instructions
1. Copy the archive to your Open Inventor home folder

2. Uncompress the Open Inventor package in the destination directory

  cd /usr/local/  
  tar -xzvf OpenInventorC++-Linux-.tar.gz

Set up the License key
Your Open Inventor software is computer ID locked. Please read the Licensing section for more details.

Set the environment variables

Open Inventor environment variables
To use Open Inventor, all users must initialize Open Inventor environment variables. Set the following environment variable to compile, link, and run programs:

  • OIVHOME to
    For example,
    setenv OIVHOME /usr/local/OpenInventor
  • OIVARCH to
    For example,
    setenv OIVARCH arch-Linux-x86_64-gcc41-releaseOIVARCH is useful to switch between Release and Debug libraries.

Other optional environment variables specific to Open Inventor and its extensions can be set. Please refer to SoPreferences in the Reference Manual for more information.

System environment variables

  • The shared library path (LD_LIBRARY_PATH) must be specified. The library path contains the list of directories to search for the shared libraries.
    • For example, to set the library path:
      setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:${OIVHOME}/${OIVARCH}/lib
  • MOTIFHOME should be set to specify where to find the Motif directory (contains include and lib directories for Motif).
    • For example:
      setenv MOTIFHOME /usr
  • OGLHOME should be set to specify where to find the OpenGL directory (contains include and lib directories for OpenGL).
    • For example:
      setenv OGLHOME /usr/local/OpenGL
  • XAPPLRESDIR must be set to $OIVHOME/app-defaults to use the localized resource files (see the X11 documentation). To use a specific language, you will need to create a link to the desired localized file (English is the default). For example,
    1. cd $OIVHOME/app-defaults
    2. rm Inventor
    3. ln -s Inventor.french Inventor

    NOTE: If you see that "Iv" is prepended to the labels and menu items in your Open Inventor viewer, it most likely means that you did not set XAPPLRESDIR.

Check the installation
The $OIVHOME/$OIVARCH/bin directory contains a test program. To check that the installation is correct, do the following:

  1. cd $OIVHOME/$OIVARCH/bin
  2. ./IvTuneViewer

The program opens a window and displays a scene graph.

NOTE: We assume here that all the required environment variables are set correctly. All required libraries for this executable are included with the Open Inventor installation, however it may be necessary to manually give the file execute permission (e.g. ‘chmod u+x IvTuneViewer’).

Using sample programs
The Open Inventor toolkit comes with hundreds of sample programs showing how to use the various features. The source code of these programs is located in the $(OIVHOME)/examples directory.

All sample programs are already built and ready to be run after installation as soon as the environment variables are set. NOTE: Most of the sample programs will not run unless the Motif runtime libraries are installed.

Also it may be necessary to manually give the files execute permission
The Samples Browser program ($OIVHOME/$OIVARCH/bin/ivBrowser) can be used to browse these sample programs, to run them and to read their documentation it it exists.

Generate sample makefile
Binaries of Open Inventor samples are provided in the package, but if you wish rebuild your own binaries you have to generate makefiles from provided cmakefile .

Please read the Build samples instructions section for more details.

Un-installing Open Inventor

RPM package (for RPM-based Linux Platforms)

To uninstall Open Inventor, use the RPM manager:

 rpm -e OpenInventorC++ 

To find the version number of the installed package you can type:

 yum list | grep OpenInventor 

Compressed archive (for Linux Platforms)

To uninstall Open Inventor, remove the installation folder.

 rm -rf /usr/local/OpenInventor 

MacOS

General requirements
Installation details
Set environment variables
Set up the License key
Check the installation
Building and Using sample programs
Un-installing Open Inventor

General requirements
In order to install Open Inventor C++ verify:

  • Root privileges: you must be allowed to write into the installation directory. If the location you have chosen (e.g., /usr/local) requires root privileges, then you must have root privileges to do the installation (and subsequent upgrades or uninstallation) or use the sudo command.
  • Verify adequate disk space: see the System Requirements Overview topic for disk space requirements.
  • Qt installation: Install Qt libraries in order to have Qt environment variables and headers files for building Open Inventor samples (Using sample programs). Note that you must use Qt 5.6.0.

Installation details
Open Inventor uses a standard OS X installer for the C++ package. The directory where is installed the package cannot be changed, but you can select a different drive in case your OS X system contains more than one disk. The installation directory is /Applications/OpenInventor.app/. Under this directory you'll find the subdirectories Contents/ because each version of Open Inventor will install in its own subdirectory allowing to manage different versions on the same system.

Once installed, Open Inventor will be available to develop your application as it used to be. In addition in the Applications menu you'll find an entry dedicated to Open Inventor. From here you can launch IvTuneViewer or access the documentation. To do so simply CTRL Click on the Open Inventor menu, select Show Package Content. Then browser into Contents//doc directory and then open the CPP_ReferenceManual.html or OpenInventorDeveloperZone.html to access the wanted documentation.

Set environment variables

Open Inventor environment variables

in order to use Open Inventor, all users must initialize several environment variables that are neecssary to compile, link, and run programs. 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"

Note: these commands set the local variables in the user's .bashrc or .cshrc files, this means that if you want to run a sample or an Open Inventor program you have to run it form the shell where you set the variables.

The Open Inventor variables are:
  • OIVHOME to
    For example: setenv OIVHOME /Applications/OpenInventor.app/Contents/9.8.0
  • OIVARCH to
    For example: setenv OIVARCH arch-MacOSX-x86_64-clang60-release

OIVARCH is used to switch between differents architectures or configuration (Release/Debug) libraries.

Other optional environment variables specific to Open Inventor and its extensions can be set. Please refer to SoPreferences in the Reference Manual for more details.

Set up the License key

Your Open Inventor software is computer ID locked. Please read the Licensing/Setting up a node-locked license section for more details.

If you want to use a password.dat file outside the OIVHOME folder you have to add the environment variable:

OIV_LICENSE_FILE="/password.dat"

Check the installation
The $OIVHOME/$OIVARCH/bin directory contains a test program. To check that the installation is correct, type following commands:

cd $OIVHOME/$OIVARCH/bin then ./IvTuneViewer

The program opens a window and displays a scene graph. Run $OIVHOME/$OIVARCH/bin/IVBrowser to run all the demos and verify the related code.

If you are not able to run the programs you can try using chmod to change the access permission to execute the file: chmod +x  or chmod -R +x * to make the modification for all files

Using sample programs
The Open Inventor toolkit comes with hundreds of sample programs that demonstrate its features. The source code for these programs is located in the $(OIVHOME)/examples directory.

All sample programs come built in the release version and can be run after installation when the Open Inventor environment variables are properly set.
The Samples Browser program ($OIVHOME/$OIVARCH/bin/IvBrowser) can be used to browse these programs, show the source code, run them and read their documentation if available. While pre-built binaries of the Open Inventor samples are provided, you may freely reuse or modify their source code for experimentation.

For this You will need to generate xcode project using the CMake file (CMakeLists.txt) provided in each directory. Please read the Build samples instructions to get the complete procedure.

Note: for OS X, Qt is not optional. You can check the compatibility version of Qt for the latest Open Inventor release and download Qt library.

Un-installing Open Inventor
To uninstall Open Inventor, remove the installation folder if you used .zip package, or simply use the Application manager if you installed the OSX package.

For Qt library, if you want to remove it, check on the official site or use /Developers/Tools/unistall-qt.py with administrative privileges.

Windows - Linux - OS X


Windows

General installation information
Toolkit installation
Environment variables
Run Examples
Install as Java extension (optional)

General installation information
In order to install Open Inventor Java see requirements on page System Requirements.

This page describes how to install Open Inventor Java on Windows 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 delivred by the upgrade e-mail. If you select the link: "Download Open Inventor Java", a download page is opened and you can select the desired package "for Windows" platform: executable (.exe) or compressed (.zip) version for 64-bit or 32-bit.

Administrator privileges are required to install the executable package Open Inventor. If you do not have administrator privileges on the machine, please use the compressed version (.zp) and set the Open Inventor environment variables, see Environment variables for details.

Toolkit installation
Open Inventor toolkit package is available as executable installer (.exe) or compressed zip file (.zip):

OpenInventorJava-Windows.exe/.zip

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

For compressed package .zip, create your own home directoty and unzip the folder. For instance open Command Prompt (note that unzip.exe should be installed) and type:

mkdir JavaHome
cd JavaHome
unzip \OpenInventorJava980-Windowsx86_64.zip

Then the environment should be set: see Environment variables section for more details.

For the executable installer .exe, see below the steps of the installation procedure:

  1. Welcome dialog
  2. License Agreement dialog

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

  1. Components selection dialog
    You can select to install or not the example programs or reference manual.
  2. Installation location dialog
    Setup will suggest a default location for the installation, e.g., C:\OpenInventor\9.8.0 Java x64, and allows you to select a different location if desired. We recommend using a directory name that includes the version number.
    Avoid using the Windows operating systems C:\Program Files directory because it protects its contents and you will not be able to edit and build example programs.
  3. Start Menu Folder dialog
    You can choose the Windows Start Menu folder. The default is to use the same name as for the installation folder.
  4. Install
    All Open Inventor files will be installed into the selected directory. The installation procedure sets all necessary environment variable. See Environment variables for more details.
  5. Copy License dialog
    At this step, the installer asks you to locate the file containing the license strings necessary to unlock the product. You should have received this file from our licensing team. Please refer to the Licensing page for details. The environment variable OIV_LICENSE_FILE is set to the path of this file in the user's environment. The file name is usually password.dat.
  6. Complete installation dialog: it is possible to select to run "Open inventor samples browser".

Environment variables
Once the installation is done, you may need to define some environment variables. Note that the installation package configures the environment itself, so you only need to define following variables if you used the compressed archive of Open Inventor Java:

  • OIVJHOME: the Open Inventor Java home installation directory. 
  • The library path PATH: it must contain the path to the native libraries of Open Inventor Java: %OIVJHOME%\jre\bin.
  • 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.

Run examples
Each demo can be executed by using the delivered JAR files:

cd %OIVJHOME%\examples\inventor\mentor\examiner
java -jar Main.jar

A browser of all demos, called Demos launcher is delivered in the package. To run it, type:

cd %OIVJHOME%\examples\launcher
java -jar Main.jar

Or you can use the launch.bat script available in %OIVJHOME%\examples

See below a screenshot of the application:

To run a demo, double-click the item or select te auto-launch feature.

If you are not able to run demos, please check if Java Runtime Environment is installed (i.e. type java -version in Command Prompt) and if the version is compatible with the Open Inventor packages selected. If Java is not available, download the right version from the official site, install it, then re-run the Open Inventor examples.

Check the license using the property (or environment variable) OIV_LICENSE_DEBUG. If OIV_LICENSE_DEBUG is equal to 1, when starting any Java application that needs Open Inventor for Java, licensing details are printed (if OIV_LICENSE_DEBUG is equal to , the messages will be printed in the log file).

Otherwise check the System requirements page for more details.

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 *.dll are automatically found by the JVM, so you do not need to add them to the library path PATH.

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


Linux

General installation information
Toolkit installation
Environment variables
Run Examples
Install as Java extension (optional)

General installation information
In order to install Open Inventor Java, see the requirements on page System Requirements.

This page describes how to install Open Inventor Java on Linux 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 delivred by the upgrade e-mail. If you select the link: "Download Open Inventor Java", a download page is opend and you can select the desiderd package "for Red Hat Enterprise Linux" platform: .TAR.GZ for 64-bit.

The Open Inventor 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.

Toolkit installation
The Open Inventor Toolkit for Linux is distributed as a RPM package and a compressed archive.

The default installation directory is /usr/local. To install in this directory, you will need root privileges.

RPM package (for RPM-based Linux Platforms)

The toolkit package name is:

OpenInventorJava-Linux-.rpm

Installation Instructions

1. Become root by running su and entering the super-user password.

2. Download and install the Java JDK RPM package (required): http://www.oracle.com/technetwork/java/javase/downloads/index.html

3. Install the Open Inventor RPM package

  yum localinstall OpenInventorJava--Linux--.rpm 

This command will install Open Inventor Java package and all dependencies (except for Java JDK).

You can change the default installation directory by using the following command:

   rpm -ivh --prefix  OpenInventorJava--Linux--.rpm 

Compressed archive (for Linux Platforms)

The toolkit package name is:

OpenInventorJava-Linux-.tar.gz

Installation Instructions

1. Copy the archive to your Open Inventor home folder

2. Uncompress the Open Inventor package in the destination directory

   cd /usr/local/  
  tar -xzvf OpenInventorJava-Linux-.tar.gz 

Environment variables

  • OIVJHOME must be set to the Open Inventor Java home installation directory,
  • The library path LD_LIBRARY_PATH must contain the path to the native libraries of Open Inventor Java:
    • Linux 32-bit: ${OIVJHOME}/jre/lib/i386
    • Linux 64-bit: ${OIVJHOME}/jre/lib/amd64
  • 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.

Run Examples
The installed package contains a folder $OIVJHOME/examples for the Java examples. It contains many examples to show how to use Open Inventor features using the Java API.

You can run the Open Inventor Java examples by using the delivered JAR files:

cd ${OIVJHOME}/examples/inventor/mentor/examiner
java -jar Main.jar

A browser of all examples "Demos launcher" is delivered in the package. To run it type:

cd ${OIVJHOME}/examples/launcher 
java -jar Main.jar

Or you can use the launch.sh script available in %OIVJHOME%\examples

See below a screenshot of the application:

To run an example, double-click the item or select the auto-launch feature.

If you are not able to run the examples, please check if the Java Runtime Environment is installed (i.e. type java -version in Terminal) and if the version is compatible with the Open Inventor packages selected. If Java is not available, download the right version from the official site, install it, then re-run the Open Inventor examples.

Check the license using the property (or environment variable) OIV_LICENSE_DEBUG. If OIV_LICENSE_DEBUG is equal to 1, when starting any Java application that needs Open Inventor for Java, licensing details are printed (if OIV_LICENSE_DEBUG is equal to the messages will be printed in the log file).

Otherwise check the System requirements page for more details.

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*.so 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.


OS X

General installation information
Toolkit Installation
Environment variables

General installation information
In order to install Open Inventor Java see requirements on page System Requirements.

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 Java 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.

Toolkit Installation
Open Inventor uses an installer for the Java package. The directory where is installed the package cannot be changed, but you can select a different drive in case your OS X system contains more than one disk. The installation directory is /Applications/OpenInventorJava.app/. Under this directory you'll find the subdirectories Contents/ because each version of Open Inventor Java will install in its own subdirectory allowing to manage different versions on the same system.

Once installed, Open Inventor Java will be available to develop your application as it used to be. In addition in the Applications menu you'll find an entry dedicated to Open Inventor Java. From here you can launch IvTuneViewer or access the documentation. To do so simply CTRL Click on the Open Inventor Java menu, select Show Package Content. Then browse into Contents//doc directory and then open the Java_ReferenceManual.html or OpenInventorDeveloperZone.html to access the wanted documentation. The Open Inventor Java Toolkit requires a license. Please read the Licensing page for details.

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
  • 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.

This page describes how to install Open Inventor .NET on the supported platforms. The current version of Open Inventor .NET is available for the following platforms:

  • Windows 7 (32-bit or 64-bit)
  • Windows 10 (32-bit or 64-bit)

Use the installer provided with the product to automatically install Open Inventor .NET. Be sure to install the version of Open Inventor .NET that is appropriate for your platform (32-bit or 64-bit). Toolkit installation process Setup the license key Generate projects of demonstration programs     Toolkit installation process Open Inventor .NET is provided on Windows with an InstallShield™ installer. below the main steps:

  1. Information dialog
  2. License Agreement dialog
  3. Components selection dialog You can choose to install or not the SDK, the runtime environment (debug or PDB files, the release is mandatory), examples programs (source code or binaries) and reference manual.
  4. Installation location dialog Setup will suggest a default location for the installation, e.g., C:\OpenInventor\9.4.0 .NET Visual2012 x64, and allows you to select a different location if desired. We recommend using a directory name that includes the version number. Avoid using the Windows operating systems C:\Program Files directory because it protects its content and you will not be able to edit and build example programs.
  5. Start Menu Folder dialog You can choose the Windows Start Menu folder. The default is to use the same name as for the installation folder.
  6. Install process All Open Inventor files will be installed into the selected installation directory.
  7. Copy License dialog At this step, the installer asks to locate the file containing the license strings necessary to unlock the product that you should have received from our licensing team. The environment variable OIV_LICENSE_FILE is set to the path of this file in the user's environment.
  8. Environment variables Setup will set the following environment variables for all users (added to the System environment variables): OIVNETHOMEOIVARCHOIV_LICENSE_FILE. Note OIVARCH is necessary only to run the delivered example programs.
  9. Completing the installation The last installation dialog allows access to the online documentation.

Setup the license key Your Open Inventor .NET software requires a license key. Please read the License section for more details. Generate projects of demonstration programs the Premake tool can be used to generate the Visual Studio projects of the Open Inventor example programs. It uses one premake5.lua file for each example program.

premake5 vs2015|vs2013|vs2012

The premake4 executable is available in the %OIVNETHOME%\tools directory. See https://premake.github.io/ for details about the Premake tool. Example1: rebuild one demonstration project

  1. cd %OIVNETHOME%\src\Inventor\examples\Mentor\CSharp\_02_1_HelloCone
  2. premake5 vs2012

Build or rebuild _02_1_HelloCone.csproj and _02_1_HelloCone.sln for Visual Studio 2012. Example2: rebuild several demonstration projects at once, and one solution for all of them

  1. cd %OIVNETHOME%\src\Inventor\examples\Mentor\CSharp
  2. premake5 vs2012

Build or rebuild a list of csproj and one InventorMentor.sln solution for Visual Studio 2012. Note: All of these projects are created by referencing to Open Inventor assemblies using OIVNETHOME and OIVARCH environment variables in the HintPath. For instance, OIV.Inventor assembly is defined by the following line in the generated project:

 $(OIVNETHOME)\assemblies\$(OIVARCH)\OIV.Inventor.dll   

If you prefer to generate csproj files that do not use HintPath you can use the --ignoreHintPath option:

   premake5 --ignoreHintPath vs2015|vs2013|vs2012 

General help is available using the following command:

   premake5 --help

In any case, please note that it's recommended to use the option --platform=x64 (or x86) to be compatible with the OIV assemblies you are using. Examples:

  • premake5 --platform=x64 vs2012 (for 64 bits version of Visual Studio 2012)
  • premake5 --platform=x86 vs2012 (for 32 bits version of Visual Studio 2012)
0