H3DAPI Installation

2013-04-16T08:54:16Z

/* Latest development version */

Revision as of 08:54, 16 April 2013		Current revision
Line 16:		Line 16:
	# Obtain the source code. Preferrably by installing H3DAPI as in the walkthrough above. If the development source is desired follow the instructions in the [[H3DAPI_Installation#Source_Repositories \| Source Repositories ]] section.		# Obtain the source code. Preferrably by installing H3DAPI as in the walkthrough above. If the development source is desired follow the instructions in the [[H3DAPI_Installation#Source_Repositories \| Source Repositories ]] section.
	# Download and install the latest cmake version from http://www.cmake.org/cmake/resources/software.html		# Download and install the latest cmake version from http://www.cmake.org/cmake/resources/software.html
-	# Download and install Visual C++ 2010 if you do not have one. An express version is available free of charge at http://www.microsoft.com/visualstudio/en-us/products/2010-editions/express	+	# Download and install Visual C++ 2010 if you do not have one. An express version is available free of charge at http://www.microsoft.com/visualstudio/eng/products/visual-studio-2010-express
-	# Start CMake GUI. Put the search path to CMakeLists.txt in the first text box in this GUI. On a standard installation the search path is C:\H3D\H3DAPI\build. Put the search path to where the generate projects will be build in the second text box, for example C:\H3D\H3DAPI\build\win32. Press the Configure button and choose the compiler is Visual Studio 10. If everything went fine then the "Generate" button should be enabled.	+	# Start CMake GUI. Put the search path to CMakeLists.txt in the first text box in this GUI. On a standard installation the search path is C:\H3D\build. Put the search path to where the generate projects will be build in the second text box, for example C:\H3D\build\win32. Press the Configure button and choose the compiler Visual Studio 10. If everything went fine then the "Generate" button should be enabled.
-	# After configuration is done, click on the box "show advanced". Search for "GENERATE_UNITY_BUILD" and tick on the box to enable it. After that click on "Configure" again	+	# Browse into where you build the projects file and open the H3DWithToolkitsWin.sln file with Visual Studio.
-	# After the second configuration, click "Generate", all project files will be generated	+	# Change configuration to "Release" instead of debug and right click the INSTALL project and "build".
-	# Browse into where you build the projects file and open the H3DAPI.sln file with Visual Studio.	+
-	# Change configuration to "Release" instead of debug and build the solution.	+
-	Wait for the project to be built.....	+
-	# After that, right click on INSTALL project and "build"	+
-	# Close Visual Studio, go back to cmake GUI, search for "H3DAPI_LOADER_PROJECT" and tick the box	+
-	# Configure and Generate the solution once more	+
-	# In the latest development version, the path added is different from the previous version. Change the system path from C:\H3D\External\bin to C:\H3D\External\bin32	+
-	# Open the solution file again and build it.	+
	# Testing: set H3DViewer as start up project in H3DAPI, and run it. The H3DViewer window is opened. Drag any of the .x3d files under C:\H3D\H3DAPI\examples\All to that window to check if it works		# Testing: set H3DViewer as start up project in H3DAPI, and run it. The H3DViewer window is opened. Drag any of the .x3d files under C:\H3D\H3DAPI\examples\All to that window to check if it works
		+
		+	If it is desired to build all the C++ examples that comes with H3D follow these steps.
		+	# Close Visual Studio.
		+	# Open CMake gui for your configuration (if not already opened).
		+	# Find H3DAPI_EXAMPLE_PROJECTS, HAPI_EXAMPLE_PROJECTS and MedX3D_DEMO_PROJECT in the CMake GUI and check their boxes. This assumes that you installed all source code.
		+	# Click "Configure" and then "Generate".
		+	# Open the solution file again and build solution again.

	==Installation on GNU/Linux==		==Installation on GNU/Linux==
-	Currently you need to build H3D API on Linux yourself. To build H3DAPI on Linux follow these steps.	+	===Using debian package===
		+	It is quite easy to use debian packages to install H3DViewer and obtain source code of H3DAPI.
		+	These steps are tested for Ubuntu 12.04 and 12.10. We assume it will work on other systems as well.
		+	# Open /etc/apt/sources.list as sudo. Use for example the terminal command <pre>sudo gedit /ets/apt/sources.list</pre>
		+	# At the end of that file add the following <pre>deb ftp://www.h3dapi.org/pub/releases/linux/debian/ distro sensegraphics</pre> Where "distro" is your linux distribution. For Ubuntu 12.04 this is "precise" and for Ubuntu 12.10 this is "quantal".
		+	# If you would like to make it easy to download source the also add <pre>deb-src ftp://www.h3dapi.org/pub/releases/linux/debian/ distro sensegraphics</pre>
		+	# Save file and exit.
		+	# In terminal write <pre>sudo apt-get update</pre> followed by <pre>sudo apt-get install h3dviewer</pre>
		+	# Select Yes for all questions about "not known debian package".
		+	# When installation finished write H3DViewer and H3DViewer will start.
		+
		+
		+	Sadly we can not distribute H3DViewer with prebuilt OpenHaptics support for linux. Therefore it might be useful to get source of H3DAPI. Then do the following.
		+	# In terminal cd to a directory in which you want to download the source.
		+	# Write <pre>apt-get source libh3dapi libhapi libh3dutil libh3dmedx3d libh3dui libh3dphysics</pre>
		+	# The last three libs listed are only required if you need their features.
		+	# After download is finished you will have tar.gz files in your directory which contains all the source code for h3d. The source package for libh3dapi contains source for H3DViewer and H3DLoad so no need to download libh3dviewer separately. Note that if you only want extra OpenHaptics support it should be enough to only custom build hapi and h3dapi. The rest can be installed using debian.
		+
		+	===Installation from source===
		+	If you want to build H3D API on Linux yourself follow these steps.

	# Install version 2.4.7 or later of CMake. (Development version of H3D needs 2.6(?)) To do this on Ubuntu open a terminal and write:		# Install version 2.4.7 or later of CMake. (Development version of H3D needs 2.6(?)) To do this on Ubuntu open a terminal and write:
Line 49:		Line 67:

	===Setting Up Runtime Environment===		===Setting Up Runtime Environment===
		+	If you used a debian package to install H3DAPI then libraries are not installed in /usr/local as shown below. This therefore is only important when building H3DAPI from source.
	The make file will only install the libraries and header files, so to set up a runtime environment for all users on your computers, for example in a University laboratory, you'll have to perform a few steps manually.		The make file will only install the libraries and header files, so to set up a runtime environment for all users on your computers, for example in a University laboratory, you'll have to perform a few steps manually.
	# Create a folder for H3D API at your preferred location, e.g. under /usr/local/share on the Ubuntu distribution <pre>sudo mkdir /usr/local/share/h3dapi</pre>		# Create a folder for H3D API at your preferred location, e.g. under /usr/local/share on the Ubuntu distribution <pre>sudo mkdir /usr/local/share/h3dapi</pre>
Line 58:		Line 77:

	==Installation on Mac OS==		==Installation on Mac OS==
		+	===H3DViewer installation only===
		+	If you want to install only H3DViewer then check out the [http://www.h3dapi.org/modules/PDdownloads/viewcat.php?cid=28 download] section of H3DAPI and hope that your version of OSX is supported.
		+	===Building from source===
	Currently you need to build H3DAPI on MacOS X yourself. To build H3DAPI on MacOS X follow these steps.		Currently you need to build H3DAPI on MacOS X yourself. To build H3DAPI on MacOS X follow these steps.
	# Install version 2.8.0 or later of CMake.		# Install version 2.8.0 or later of CMake.
Line 74:		Line 96:
	==Source Repositories==		==Source Repositories==
	===Latest development version===		===Latest development version===
-	Sometimes it is convenient to get the latest source of H3DAPI that is not yet in an official release. To obtain the source an internet connection and a subversion client is needed. Subversion can be obtained from [http://subversion.tigris.org subversion.tigris.org]. The following instructions assume that a subversion client is used.	+	Sometimes it is convenient to get the latest source of H3DAPI that is not yet in an official release. There are two ways to get the latest development version.
		+	====Obtain nightly build from ftp====
		+	Everyday a build of the latest trunk is generated and uploaded to this [ftp://www.h3dapi.org/pub/nightlybuilds/ public ftp]. Download H3D for your operating system from there.
		+
		+	====Download from SVN====
		+	To obtain the source an internet connection and a subversion client is needed. Subversion can be obtained from [http://subversion.tigris.org subversion.tigris.org]. The following instructions assume that a subversion client is used.

	For Windows:		For Windows:

H3D.org - Recent changes [en]

H3DAPI Installation