Installation and Verification

Windows - Linux - Linux Headless

Windows

• Administrator privileges
• Verify adequate disk space
• Details on installers
• 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. Details on installers Open Inventor Toolkit The package contains the include files, libraries, utilities, example programs, data files, and C++ reference manual in Windows help format. Example: OpenInventorC++1000-Windows-Visual2012-x86_64.exe 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\10.0.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 QT_QPA_PLATFORM_PLUGIN_PATH . Installer will also 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: • Log out and log in again, -OR- • Open the Control Panel, open the System applet, click on Advanced, click on Environment Variables, and click on OK.
9. 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.

   For a complete list of installed files, see Open Inventor files.

10. 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 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).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
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).

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++ 10.0.0 Visual2012 x64 from the list and uninstall it.

Linux

• Root privileges
• Verify adequate disk space
• Select an installation directory
• Set up the License Key
• Set the environment variables
• 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.

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, "OpenInventor1000". The default installation directory is /usr/local/OpenInventorCpp. To install in this directory, you will need root privileges.

Installation Instructions

• RPM package (for RPM-based Linux Platforms)
  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.
  4. Install the Open Inventor RPM package:

     yum install epel-release

     yum localinstall [PACKAGE_NAME]

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

     rpm -ivh --prefix [PACKAGE_NAME]

• DEB package (for Ubuntu and DEB-based Linux Platforms)
  1. Become administrator by running su and entering the administrator password
  2. sudo dpkg -i [PACKAGE_NAME] and follow instructions
     Please note that some dependancies may have to be installed manually during the process (dpkg will display needed information).
• Compressed archive (for Linux Platforms)
  1. Copy the archive in the folder where you want to install it
  2. Uncompress the Open Inventor package in the destination directory

       cd /usr/local/  
       tar -xzvf [PACKAGE_NAME]

Set up the License key
Please read the Licensing section for more details.

Set the 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 the folder where is installed Open Inventor. For example setenv OIVHOME /usr/local/OpenInventor
• OIVARCH to define Release or Debug. For example, setenv OIVARCH arch-Linux-x86_64-gcc44-release

OIVARCH 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. Some System environment variables must also be set or updated

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

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)/src directory. All sample programs are already built and ready to be run after installation as soon as the environment variables are set. 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

• DEB package (for DEB-based Linux Platforms)
  • To uninstall Open Inventor, use the DEB manager:

    dpkg --remove OpenInventorC++

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

    dpkg -l | grep OpenInventor

• Compressed archive (for Linux Platforms)
  • To uninstall Open Inventor, remove the installation folder:

    rm -rf /usr/local/OpenInventor

Linux Headless

• Root privileges
• Verify adequate disk space
• Select an installation directory
• Install Open Inventor
• Set up the License Key
• Set the environment variables
• 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

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, "OpenInventor1000". The default installation directory is /usr/local/OpenInventorCpp. To install in this directory, you will need root privileges.

Install Open Inventor Headless from compressed archive

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 [PACKAGE_NAME]

Install Open Inventor from .DEB package

1. Become administrator by running su and entering the administrator password
2. Enter following command

   sudo dpkg -i [PACKAGE_NAME]

   and follow instructions

Please note that some dependancies may have to be installed manually during the process (dpkg will display needed information).

Set up the License key
Please read the Licensing section for more details.

Set the 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 where is installed Open Inventor Headless. For example, setenv OIVHOME /usr/local/OpenInventor
• OIVARCH to select Release or Debug libs. For example, setenv OIVARCH arch-Linux-x86_64-gcc44-release

OIVARCH 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. Set or update also following system 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.

Un-installing Open Inventor
To uninstall Open Inventor remove the installation folder if installed from tar.gz package

rm -rf /usr/local/OpenInventor

or use the DEB manager if installed from .DEB package

dpkg --remove OpenInventorC++