H3D.org - Recent changes [en]

Advanced H3DAPI programming

Xo.Markus — Tue, 28 May 2013 09:50:06 GMT

/* H3DViewer plugin */

Revision as of 09:50, 28 May 2013		Current revision
Line 136:		Line 136:
	===Creating a new field===		===Creating a new field===
	There is an excellent guide in the [http://www.h3dapi.org/modules/judoc/ H3DAPI manual] on how to create new fields. For a list of useful field templates see [http://www.h3dapi.org/uploads/api/H3DAPI_20_beta/docs/H3DAPI/html/group__FieldTemplateModifiers.html this link].		There is an excellent guide in the [http://www.h3dapi.org/modules/judoc/ H3DAPI manual] on how to create new fields. For a list of useful field templates see [http://www.h3dapi.org/uploads/api/H3DAPI_20_beta/docs/H3DAPI/html/group__FieldTemplateModifiers.html this link].
		+
		+
		+	==H3DViewer plugin==
		+	This section basically explains what is needed for H3DViewer to register a library as a plugin which will be loaded at startup. Let us call our new library Foo
		+	Somewhere in your system include H3D/LibraryInfo and then declare the following function <pre>#include <H3D/LibraryInfo.h>
		+
		+	// Function to extract information about the library.
		+	extern "C" Foo_API H3D::LibraryInfo getLibraryInfo();</pre>
		+
		+	Then somewhere else define the function as <pre>H3D::LibraryInfo getLibraryInfo() {
		+	H3D::LibraryInfo r = H3D::LibraryInfo::createEmptyInfo();
		+	std::stringstream s;
		+	s << Foo_MAJOR_VERSION << "."
		+	<< Foo_MINOR_VERSION << " (build "
		+	<< Foo_BUILD_VERSION << ")";
		+
		+	strcpy( r.name, "Foo" );
		+	strcpy( r.version, s.str().c_str() );
		+	strcpy( r.web, "url_to_Foo_homepage" );
		+	strcpy( r.developer, "FooDeveloperName" );
		+	strcpy( r.developer_web, "FooDeveloperWeb" );
		+	strcpy( r.info, "Foo is for some reason used when writing templates to explain programming." );
		+	return r;
		+	}</pre>

HAPI Installation

Xo.Markus — Tue, 28 May 2013 09:39:48 GMT

/* Installation from Source */

Revision as of 09:39, 28 May 2013		Current revision
Line 4:		Line 4:
	===Installation===		===Installation===
	To install HAPI on Windows follow these steps.		To install HAPI on Windows follow these steps.
-	# Register at http://www.h3d.org and download Windows installation file. (Currently you need to use the installation file for H3DAPI to install HAPI, if H3DAPI is not desired then just ignore it.)	+	# Register at http://www.h3d.org and download the Windows installation file. (Currently you need to use the installation file for H3D to install HAPI, if H3DAPI is not desired then just do deselect it before installing.)
	# Install HAPI using that file.		# Install HAPI using that file.
	# Run examples through start menu.		# Run examples through start menu.
Line 12:		Line 12:
	# Obtain the source code. Preferrably by installing HAPI as in the step above. If the development source is desired follow the instructions in the [[HAPI_Installation#Source_Repositories \| Source Repositories ]] section.		# Obtain the source code. Preferrably by installing HAPI as in the step above. If the development source is desired follow the instructions in the [[HAPI_Installation#Source_Repositories \| Source Repositories ]] section.
	# Install version 2.6.0 or later of [http://www.cmake.org CMake]. Go to the cmake homepage to download and install that program.		# Install version 2.6.0 or later of [http://www.cmake.org CMake]. Go to the cmake homepage to download and install that program.
-	# 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\HAPI\build. Put the search path to where the generate projects will be build in the second text box, for example C:\H3D\HAPI\build\vc7. Press the Configure button and choose the compiler for which CMake will generate build files. Then wait while CMake tries to detect what libraries are installed on your system. It might be so that the Configure button will have to be pressed again after the first configure run. If everything went fine then the "OK" button should light up and when it is pressed the project files will be generated.<br><br>Alternatively the CMake command line could be used to generate the project files. In that case navigate (in the command line) to the HAPI\build folder and on a standard installation of CMake 2.6 write:<pre>C:\Program Files\CMake 2.6\bin\cmake.exe</pre>The project files will then be generated in HAPI\build folder.	+	# 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\HAPI\build. Put the search path to where the generate projects will be build in the second text box, for example C:\H3D\HAPI\build\vc10. Press the Configure button and choose the compiler for which CMake will generate build files. Then wait while CMake tries to detect what libraries are installed on your system. It might be so that the Configure button will have to be pressed again after the first configure run. If everything went fine then the "OK" button should light up and when it is pressed the project files will be generated.<br><br>Alternatively the CMake command line could be used to generate the project files. In that case navigate (in the command line) to the HAPI\build folder and on a standard installation of CMake 2.6 write:<pre>C:\Program Files\CMake 2.6\bin\cmake.exe</pre>The project files will then be generated in HAPI\build folder.
	# Open the projects and start building. When generating for Microsoft Visual Studio the project file to open is the solution file generated.		# Open the projects and start building. When generating for Microsoft Visual Studio the project file to open is the solution file generated.
	# When the HAPI ( and H3DUtil) library(ies) finished building build the INSTALL project once. This will copy needed files to a location in which other CMakeLists.txt distributed with HAPI can find them.		# When the HAPI ( and H3DUtil) library(ies) finished building build the INSTALL project once. This will copy needed files to a location in which other CMakeLists.txt distributed with HAPI can find them.
-	# To generate examples use the GUI again but use (on a standard installation) the CMakeLists.txt in the directory C:\H3D\HAPI\examples instead. When projects are generated and the examples are built run any of them to test HAPI on your system.	+	# To generate examples use the CMAKE GUI again and enable HAPI_EXAMPLE_PROJECTS before configuring again. Then open solution and build as before.

	==Installation on GNU/Linux==		==Installation on GNU/Linux==
-	Currently you need to build HAPI on Linux yourself. To build HAPI on Linux follow these steps.	+
		+	===Using debian package===
		+	It is quite easy to use debian packages to install HAPI and obtain its source code.
		+	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 libhapi</pre>
		+	# Select Yes for all questions about "not known debian package".
		+
		+
		+	Sadly we can not distribute HAPI with prebuilt OpenHaptics support for linux. Therefore it might be useful to get source of HAPI. Then do the following.
		+	# In terminal cd to a directory in which you want to download the source.
		+	# Write <pre>apt-get source libhapi libh3dutil</pre>
		+	# After download is finished you will have tar.gz files in your directory which contains all the source code for h3d. 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 follow these steps.

	# Install version 2.4.7 or later of [http://www.cmake.org CMake]. To do this on Ubuntu open a terminal and write:<pre> sudo apt-get install cmake </pre>		# Install version 2.4.7 or later of [http://www.cmake.org CMake]. To do this on Ubuntu open a terminal and write:<pre> sudo apt-get install cmake </pre>
	# Register at http://www.h3d.org and download the source for HAPI.		# Register at http://www.h3d.org and download the source for HAPI.
-	# HAPI depends on other libraries. The build system used by HAPI will detect which libraries are installed on the system and only enable the features that the system can support. If more features are desired the corresponding library has to be installed. Note that some libraries are required for HAPI to compile. See the list of [[Dependencies#HAPI \| external libraries]].<br><br> If DHD-API is obtained then libusb needs to be installed. PCISCAN_LIBRARY should also be set if the library is not found in default location.<br><br>	+	# HAPI depends on other libraries. If you installed hapi from debian and then want to build it from source you should not need to use apt-get to install any new libraries. The build system used by HAPI will detect which libraries are installed on the system and only enable the features that the system can support. If more features are desired the corresponding library has to be installed. Note that some libraries are required for HAPI to compile. See the list of [[Dependencies#HAPI \| external libraries]].<br><br> If DHD-API is obtained then libusb needs to be installed. PCISCAN_LIBRARY should also be set if the library is not found in default location.<br><br>
	#*If using Ubuntu 7.10 or later, several of these libraries can be obtained by using the apt-get feature. The first two packages installed below are the C++ compilers needed to compile HAPI. In a terminal write: <pre>sudo apt-get update</pre><pre>sudo apt-get install gcc g++ libglew-dev libglut libglut3-dev</pre><br>Freeglut can be obtained using the following commands:<pre>wget http://ovh.dl.sourceforge.net/sourceforge/freeglut/freeglut-2.4.0.tar.gz</pre><pre>tar -xzvf freeglut-2.4.0.tar.gz</pre><pre>cd freeglut-2.4.0</pre><pre>sudo ./configure CFLAGS="-fexceptions" CXXFLAGS="-fexceptions"</pre><pre>sudo make</pre><pre>sudo make install</pre><br>To install libusb required by DHD-api from ForceDimension on Ubuntu do the following:<pre>sudo apt-get install libusb++-dev</pre><br>In version 8.04 of Ubuntu another library might need to be installed: <pre>sudo apt-get install libxi-dev libxmu-dev</pre>		#*If using Ubuntu 7.10 or later, several of these libraries can be obtained by using the apt-get feature. The first two packages installed below are the C++ compilers needed to compile HAPI. In a terminal write: <pre>sudo apt-get update</pre><pre>sudo apt-get install gcc g++ libglew-dev libglut libglut3-dev</pre><br>Freeglut can be obtained using the following commands:<pre>wget http://ovh.dl.sourceforge.net/sourceforge/freeglut/freeglut-2.4.0.tar.gz</pre><pre>tar -xzvf freeglut-2.4.0.tar.gz</pre><pre>cd freeglut-2.4.0</pre><pre>sudo ./configure CFLAGS="-fexceptions" CXXFLAGS="-fexceptions"</pre><pre>sudo make</pre><pre>sudo make install</pre><br>To install libusb required by DHD-api from ForceDimension on Ubuntu do the following:<pre>sudo apt-get install libusb++-dev</pre><br>In version 8.04 of Ubuntu another library might need to be installed: <pre>sudo apt-get install libxi-dev libxmu-dev</pre>
	# In the terminal change folder to the HAPI/build folder and generate a makefile by writing:<pre>mkdir linux</pre>The reason for creating a new directory called 'linux' is to easily remove all the cmake generated files in the future in case this is needed. Now change directory to the new 'linux' directory. Then write:<pre>cmake ../</pre><br> To build HAPI using the makefile write:<pre>make</pre><br>When the make finished all that is left is to install HAPI. This can be done by writing:<pre>sudo make install</pre><br>HAPI libraries are now installed on your system. But there is no application installed that use HAPI libraries. The second last step could be skipped if one want to build and install right away.		# In the terminal change folder to the HAPI/build folder and generate a makefile by writing:<pre>mkdir linux</pre>The reason for creating a new directory called 'linux' is to easily remove all the cmake generated files in the future in case this is needed. Now change directory to the new 'linux' directory. Then write:<pre>cmake ../</pre><br> To build HAPI using the makefile write:<pre>make</pre><br>When the make finished all that is left is to install HAPI. This can be done by writing:<pre>sudo make install</pre><br>HAPI libraries are now installed on your system. But there is no application installed that use HAPI libraries. The second last step could be skipped if one want to build and install right away.

UI

Xo.Markus — Tue, 28 May 2013 09:28:39 GMT

/* Installation on GNU/Linux */

Revision as of 09:28, 28 May 2013		Current revision
Line 15:		Line 15:

	==Installation on Windows==		==Installation on Windows==
-	UI binaries are included with an installation of H3DAPI 2.1 or H3DViewer 2.1 and will load as a plugin in H3DViewer.	+	UI binaries are included with an installation of H3DAPI 2.2 or H3DViewer 2.2 and will load as a plugin in H3DViewer.

	===Building from source===		===Building from source===
	To build UI on Windows follow these steps.		To build UI on Windows follow these steps.
-	# Obtain the source code.	+	# Obtain the source code. For example through te full H3D package.
	# Install version 2.6.0 or later of [http://www.cmake.org CMake]. Go to the cmake homepage to download and install that program.		# Install version 2.6.0 or later of [http://www.cmake.org CMake]. Go to the cmake homepage to download and install that program.
-	# Start CMake GUI. Put the search path to CMakeLists.txt (UI\build) in the first text box in this GUI. Put the search path to where the generate projects will be build in the second text box, for example UI\build\vc7 (if visual studio 7 should be used). Press the Configure button and choose the compiler for which CMake will generate build files. Then wait while CMake tries to detect what libraries are installed on your system. It might be so that the Configure button will have to be pressed again after the first configure run. If everything went fine then the "OK" button should light up and when it is pressed the project files will be generated. If CMake could not find all libraries then these paths can be manually specified. All such paths are advanced variables so the "show advanced" checkbox must be active.<br><br>All libraries needed for building UI with support loading image data from DICOM files are included in the H3DAPI distribution. <br><br>If a user dislikes GUIs the CMake command line could be used to generate the project files. In that case create a subfolder to UI\build folder and navigate to that folder on a standard installation of CMake 2.6 write:<pre>cmake ../</pre>The project files will then be generated in UI\build\subfolder folder.	+	# Start CMake GUI. Put the search path to CMakeLists.txt (UI\build) in the first text box in this GUI. Put the search path to where the generate projects will be build in the second text box, for example UI\build\vc10 (if visual studio 10 should be used). Press the Configure button and choose the compiler for which CMake will generate build files. Then wait while CMake tries to detect what libraries are installed on your system. It might be so that the Configure button will have to be pressed again after the first configure run. If everything went fine then the "OK" button should light up and when it is pressed the project files will be generated. If CMake could not find all libraries then these paths can be manually specified. All such paths are advanced variables so the "show advanced" checkbox must be active.
	# Open the projects and start building. When generating project files for Microsoft Visual Studio the project file to open is the solution file generated.		# Open the projects and start building. When generating project files for Microsoft Visual Studio the project file to open is the solution file generated.
	# When the UI library finished building build the INSTALL project once. This will copy library files and binary files to a bin and lib folder in the location set by CMAKE_INSTALL_PREFIX. The value of this variable can be seen in the CMake GUI. On a default installation this will be UI\bin. This default location is the location in which the provided examples will look for the binaries for UI. Note that the ImportLibrary statement in the examples are commented out and the examples needs to be modified when testing with H3DLoad. When testing with H3DViewer simply add the UI as a plugin to H3DViewer and then run the examples.		# When the UI library finished building build the INSTALL project once. This will copy library files and binary files to a bin and lib folder in the location set by CMAKE_INSTALL_PREFIX. The value of this variable can be seen in the CMake GUI. On a default installation this will be UI\bin. This default location is the location in which the provided examples will look for the binaries for UI. Note that the ImportLibrary statement in the examples are commented out and the examples needs to be modified when testing with H3DLoad. When testing with H3DViewer simply add the UI as a plugin to H3DViewer and then run the examples.
Line 29:		Line 29:

	# [[H3DAPI_Installation#Installation_on_GNU.2FLinux \| Build and install H3DAPI]].		# [[H3DAPI_Installation#Installation_on_GNU.2FLinux \| Build and install H3DAPI]].
-	# Download the source for UI.	+	# If you did not install UI as a debian package then download the source for UI.
	# To generate the make files use the terminal and change folder to the UI/build folder. Create a new folder and navigate to that folder then write:<pre>cmake ../</pre><br>To build UI write: (tip: write "make -j3" if you have a core duo, and "make -j5" for quads: faster)<pre>make</pre><br>To install UI write:<pre>sudo make install</pre><br>UI header and libraries are now installed on your system.		# To generate the make files use the terminal and change folder to the UI/build folder. Create a new folder and navigate to that folder then write:<pre>cmake ../</pre><br>To build UI write: (tip: write "make -j3" if you have a core duo, and "make -j5" for quads: faster)<pre>make</pre><br>To install UI write:<pre>sudo make install</pre><br>UI header and libraries are now installed on your system.
	# To test the examples with H3DViewer by adding the UI as a plugin to H3DViewer and then load examples.		# To test the examples with H3DViewer by adding the UI as a plugin to H3DViewer and then load examples.

MedX3D

Xo.Markus — Tue, 28 May 2013 09:26:15 GMT

/* Installation on GNU/Linux */

Revision as of 09:26, 28 May 2013		Current revision
Line 50:		Line 50:

	==Installation on GNU/Linux==		==Installation on GNU/Linux==
-	Currently you need to build MedX3D on Linux yourself. To build MedX3D on Linux follow these steps.	+	Currently you might need to build MedX3D on Linux yourself. To build MedX3D on Linux follow these steps.

	# [[H3DAPI_Installation#Installation_on_GNU.2FLinux \| Build and install H3DAPI]].		# [[H3DAPI_Installation#Installation_on_GNU.2FLinux \| Build and install H3DAPI]].

H3DPhysics (RigidBodyPhysics)

Xo.Markus — Tue, 28 May 2013 09:25:54 GMT

Revision as of 09:25, 28 May 2013		Current revision
Line 23:		Line 23:
	==Developers Notes==		==Developers Notes==
	*[[RigidBodyPhysics TODO]]		*[[RigidBodyPhysics TODO]]
		+
		+
		+	==Installation on Windows==
		+	To install H3DPhysics on Windows simply download H3DViewer from http://www.h3dapi.org/modules/PDdownloads/viewcat.php?cid=28 H3DPhysics is included in this installation as a plugin binary to H3DViewer.
		+	If x3d example files are desired then use the full H3D installation package instead http://www.h3dapi.org/modules/PDdownloads/viewcat.php?cid=14
		+
		+	===Building from source===
		+	To build H3DPhysics on Windows follow these steps.
		+	# Obtain the source code by using the full H3D installation package as in instructions above.
		+	# 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\H3DPhysics\build. Put the search path to where the generate projects will be build in the second text box, for example C:\H3D\H3DPhysics\build\vc10. Press the Configure button and choose the compiler for which CMake will generate build files. Then wait while CMake tries to detect what libraries are installed on your system. It might be so that the Configure button will have to be pressed again after the first configure run. If everything went fine then the "OK" button should light up and when it is pressed the project files will be generated. If CMake could not find all libraries then these paths can be manually specified. All such paths are advanced variables so the "show advanced" checkbox must be active.<br><br>All libraries needed for building H3DPhysics with support for ODE and bullet are included in the distribution, note that the libraries might only link against Visual Studio 2010.
		+	# Open the projects and start building. When generating project files for Microsoft Visual Studio the project file to open is the solution file generated.
		+	# When the H3DPhysics library finished building build the INSTALL project once. This will copy library files and binary files to a bin and lib folder in the location set by CMAKE_INSTALL_PREFIX. The value of this variable can be seen in the CMake GUI. On a default installation this will be C:\H3D\H3DPhysics\bin32. This default location is the location in which the provided examples and the CMakeLists.txt for other project depending on H3DPhysics will look for the binaries for H3DPhysics.
		+
		+	==Installation on GNU/Linux==
		+	You might need to build H3DPhysics on Linux yourself. To build H3DPhysics on Linux follow these steps.
		+
		+	# [[H3DAPI_Installation#Installation_on_GNU.2FLinux \| Build and install H3DAPI]].
		+	# If you did not use the debian packages then download the source for H3DPhysics.
		+	# To generate the make files use the terminal and change folder to the H3DPhysics/build folder and write:<pre>cmake .</pre><br>To build H3DPhysics write: (tip: write "make -j3" if you have a core duo, and "make -j5" for quads: faster)<pre>make</pre><br>To install H3DPhysics write:<pre>sudo make install</pre><br>MedX3D header and libraries are now installed on your system. But there is no application installed that use H3DPhysics libraries. However, if you load any of the H3DPhysics x3d examples they should load the binary and work just fine.
		+
		+	==Installation on Mac OS==
		+	NOTE: I am not sure that this is true anymore. Please test H3DViewer bundle or build it yourself and test. Perhaps H3DPhysics is in the bundle

MedX3D

Xo.Markus — Tue, 28 May 2013 09:23:40 GMT

Revision as of 09:23, 28 May 2013		Current revision
Line 47:		Line 47:
	# Open the projects and start building. When generating project files for Microsoft Visual Studio the project file to open is the solution file generated.		# Open the projects and start building. When generating project files for Microsoft Visual Studio the project file to open is the solution file generated.
	# When the MedX3D library finished building build the INSTALL project once. This will copy library files and binary files to a bin and lib folder in the location set by CMAKE_INSTALL_PREFIX. The value of this variable can be seen in the CMake GUI. On a default installation this will be C:\H3D\MedX3D\bin. This default location is the location in which the provided examples and the CMakeLists.txt for other project depending on MedX3D will look for the binaries for MedX3D.		# When the MedX3D library finished building build the INSTALL project once. This will copy library files and binary files to a bin and lib folder in the location set by CMAKE_INSTALL_PREFIX. The value of this variable can be seen in the CMake GUI. On a default installation this will be C:\H3D\MedX3D\bin. This default location is the location in which the provided examples and the CMakeLists.txt for other project depending on MedX3D will look for the binaries for MedX3D.
-	# To generate MedX3DDemo use the GUI again but use (on a standard installation) the CMakeLists.txt in the directories C:\H3D\MedX3D\demo\build. When projects are generated and the binaries are built and install then run the file to test your build of MedX3D. If it is preferred to run MedX3DDemo without running the INSTALL project first (for example when developing and changing MedX3DDemo) add the default location of the MedX3D dll to the PATH environment variable or move that dll to a folder which is already in PATH.	+	# To generate MedX3DDemo use the CMake GUI again and check the option named MedX3D_Demo_PROJECT

	==Installation on GNU/Linux==		==Installation on GNU/Linux==
Line 53:		Line 53:

	# [[H3DAPI_Installation#Installation_on_GNU.2FLinux \| Build and install H3DAPI]].		# [[H3DAPI_Installation#Installation_on_GNU.2FLinux \| Build and install H3DAPI]].
-	# Download the source for MedX3D.	+	# If you did not use the debian packages then download the source for MedX3D.
	# To generate the make files use the terminal and change folder to the MedX3D/build folder and write:<pre>cmake .</pre><br>To build MedX3D write: (tip: write "make -j3" if you have a core duo, and "make -j5" for quads: faster)<pre>make</pre><br>To install MedX3D write:<pre>sudo make install</pre><br>MedX3D header and libraries are now installed on your system. But there is no application installed that use MedX3D libraries.		# To generate the make files use the terminal and change folder to the MedX3D/build folder and write:<pre>cmake .</pre><br>To build MedX3D write: (tip: write "make -j3" if you have a core duo, and "make -j5" for quads: faster)<pre>make</pre><br>To install MedX3D write:<pre>sudo make install</pre><br>MedX3D header and libraries are now installed on your system. But there is no application installed that use MedX3D libraries.
	# There is one application provided that depends on MedX3D. This application is called MedX3DDemo. To use MedX3DDemo do the following.		# There is one application provided that depends on MedX3D. This application is called MedX3DDemo. To use MedX3DDemo do the following.
Line 61:		Line 61:
	==Installation on Mac OS==		==Installation on Mac OS==
	MedX3D builds and MedX3Demo builds and runs on Mac OS however, there seem to be something odd with the drivers for the glsl shading language so there will be no good visual output. Therefore there are no explicit build instructions for Mac OS. If a build on Mac OS is desired a similar procedure as for GNU/Linux can be used provided that the gnu compiler is used.		MedX3D builds and MedX3Demo builds and runs on Mac OS however, there seem to be something odd with the drivers for the glsl shading language so there will be no good visual output. Therefore there are no explicit build instructions for Mac OS. If a build on Mac OS is desired a similar procedure as for GNU/Linux can be used provided that the gnu compiler is used.
		+	NOTE: I am not sure that this is true anymore. Please test H3DViewer bundle or build it yourself and test.

	==Using MedX3D==		==Using MedX3D==

H3DAPI Installation

Xo.Markus — Tue, 28 May 2013 07:56:57 GMT

/* Using debian package */

Revision as of 07:56, 28 May 2013		Current revision
Line 40:		Line 40:
	# Select Yes for all questions about "not known debian package".		# Select Yes for all questions about "not known debian package".
	# When installation finished write H3DViewer and H3DViewer will start.		# When installation finished write H3DViewer and H3DViewer will start.
		+	# If any of the H3D toolkits is desired then write <pre>sudo apt-get install libh3dmedx3d libh3dphysics libh3dui<pre>

Main Page

Xo.Markus — Tue, 28 May 2013 07:52:29 GMT

Revision as of 07:52, 28 May 2013		Current revision
Line 36:		Line 36:
	* [[Various useful nodes]]		* [[Various useful nodes]]
	* [[MedX3D]]		* [[MedX3D]]
-	* [[RigidBodyPhysics]]	+	* [[H3DPhysics (RigidBodyPhysics)]]
	* [[UI]]		* [[UI]]
	* [[H3DNetworkUtils]]		* [[H3DNetworkUtils]]

H3DPhysics (RigidBodyPhysics)

Xo.Markus — Tue, 28 May 2013 07:50:25 GMT

Revision as of 07:50, 28 May 2013		Current revision
Line 1:		Line 1:
-	RigidBodyPhysics (RBP) is an H3DAPI implementation of current widely-used physics engines. It add simulations for rigid body dynamics.	+	H3DPhysics is an H3DAPI implementation of current widely-used physics engines. It add simulations for rigid body and soft body dynamics.

-	Currently RBP supports Open Dynamic Engines (ODE). The development team hopes to add support to these engines soon: Bullet Physics, PhysX. If you are interested in implementing any of these, please contact us.	+	Currently H3DPhysics supports Open Dynamic Engines (ODE), Bullet Physics, PhysX and in development is PhysX3 and SOFA. Notice however that the soft body implementations might not be completely finished for all physics engined. If you are interested in implementing support for any other physics engines, please contact us.

	If you have any question/suggestion/discussion regarding this section, please post to the [http://www.h3dapi.org/modules/newbb/ forum]		If you have any question/suggestion/discussion regarding this section, please post to the [http://www.h3dapi.org/modules/newbb/ forum]

Special:Log/move

Xo.Markus — Tue, 28 May 2013 07:46:50 GMT

[[RigidBodyPhysics]] moved to [[H3DPhysics (RigidBodyPhysics)]]: RigidBodyPhysics is now outdated.

MedX3D

Xo.Markus — Tue, 28 May 2013 07:45:43 GMT

/* Installation on Windows */

Revision as of 07:45, 28 May 2013		Current revision
Line 38:		Line 38:

	==Installation on Windows==		==Installation on Windows==
-		+	To install MedX3D on Windows simply download H3DViewer from http://www.h3dapi.org/modules/PDdownloads/viewcat.php?cid=28 MedX3D is included in this installation as a plugin binary to H3DViewer.
		+	If x3d example files are desired then use the full H3D installation package instead http://www.h3dapi.org/modules/PDdownloads/viewcat.php?cid=14

	===Building from source===		===Building from source===
	To build MedX3D on Windows follow these steps.		To build MedX3D on Windows follow these steps.
-	# Obtain the source code. Preferrably by installing MedX3D as in the installation instructions above.	+	# Obtain the source code by using the full H3D installation package as in instructions above.
-	# Install version 2.6.0 or later of [http://www.cmake.org CMake]. Go to the cmake homepage to download and install that program.	+	# 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\MedX3D\build. Put the search path to where the generate projects will be build in the second text box, for example C:\H3D\MedX3D\build\vc10. Press the Configure button and choose the compiler for which CMake will generate build files. Then wait while CMake tries to detect what libraries are installed on your system. It might be so that the Configure button will have to be pressed again after the first configure run. If everything went fine then the "OK" button should light up and when it is pressed the project files will be generated. If CMake could not find all libraries then these paths can be manually specified. All such paths are advanced variables so the "show advanced" checkbox must be active.<br><br>All libraries needed for building MedX3D with support loading image data from DICOM files are included in the distribution, note that the libraries might only link against Visual Studio 2010. If DICOM is wanted for other versions of Visual Studio the only CMake variable needed to be set is DCMTK_DIR, the other DCMTK_-variables will be filled in with the correct location if they were empty prior to setting DCMTK_DIR.<br><br>If a user dislikes GUIs the CMake command line could be used to generate the project files. In that case navigate (in the command line) to the MedX3D\build folder and on a standard installation of CMake 2.6 write:<pre>C:\Program Files\CMake 2.6\bin\cmake.exe</pre>The project files will then be generated in MedX3D\build folder.
-	# 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\MedX3D\build. Put the search path to where the generate projects will be build in the second text box, for example C:\H3D\MedX3D\build\vc7. Press the Configure button and choose the compiler for which CMake will generate build files. Then wait while CMake tries to detect what libraries are installed on your system. It might be so that the Configure button will have to be pressed again after the first configure run. If everything went fine then the "OK" button should light up and when it is pressed the project files will be generated. If CMake could not find all libraries then these paths can be manually specified. All such paths are advanced variables so the "show advanced" checkbox must be active.<br><br>All libraries needed for building MedX3D with support loading image data from DICOM files are included in the distribution, note that the libraries will only link against Visual Studio 2003. It is however needed to set the DCMTK_DIR variable in the CMake GUI to point to the top folder containing the DICOM header and libraries. In the distribution the default location of this folder is C:\H3D\MedX3D\dmtk. If DICOM is wanted for other versions of Visual Studio the only CMake variable needed to be set is DCMTK_DIR, the other DCMTK_-variables will be filled in with the correct location if they were empty prior to setting DCMTK_DIR.<br><br>If a user dislikes GUIs the CMake command line could be used to generate the project files. In that case navigate (in the command line) to the MedX3D\build folder and on a standard installation of CMake 2.6 write:<pre>C:\Program Files\CMake 2.6\bin\cmake.exe</pre>The project files will then be generated in MedX3D\build folder.	+
	# Open the projects and start building. When generating project files for Microsoft Visual Studio the project file to open is the solution file generated.		# Open the projects and start building. When generating project files for Microsoft Visual Studio the project file to open is the solution file generated.
	# When the MedX3D library finished building build the INSTALL project once. This will copy library files and binary files to a bin and lib folder in the location set by CMAKE_INSTALL_PREFIX. The value of this variable can be seen in the CMake GUI. On a default installation this will be C:\H3D\MedX3D\bin. This default location is the location in which the provided examples and the CMakeLists.txt for other project depending on MedX3D will look for the binaries for MedX3D.		# When the MedX3D library finished building build the INSTALL project once. This will copy library files and binary files to a bin and lib folder in the location set by CMAKE_INSTALL_PREFIX. The value of this variable can be seen in the CMake GUI. On a default installation this will be C:\H3D\MedX3D\bin. This default location is the location in which the provided examples and the CMakeLists.txt for other project depending on MedX3D will look for the binaries for MedX3D.