Difference between revisions of "GEF3D Installation"

From Eclipsepedia

Jump to: navigation, search
m (Test GEF3D)
(replaced SVN with Git)
 
(5 intermediate revisions by one user not shown)
Line 1: Line 1:
{{incubation}}
+
{{incubation}}  
  
== Requirements ==
+
== Requirements ==
  
[[GEF3D]] requires [http://www.eclipse.org/platform Eclipse Platform] 3.5 (Galileo), with [http://www.eclipse.org/gef GEF 3.5] and an OpenGL graphics card. For a list of (in-) compatible graphics cards, see [[GEF3D List of Graphics Card]]. Most of all you need an OpenGL card with VBO extension.
+
[[GEF3D]] requires at least [http://www.eclipse.org/platform Eclipse Platform] 3.5 (Galileo), with [http://www.eclipse.org/gef GEF 3.5] and an OpenGL graphics card. For a list of (in-) compatible graphics cards, see [[GEF3D List of Graphics Card]]. Most of all you need an OpenGL card with VBO extension.  
  
GEF3D now depends on GEF 3.5 and is not backwards compatible. Since June 25 2009 (revision 168), you need Eclipse 3.5 to run GEF3D.
+
GEF3D now depends on GEF 3.5 and is not backwards compatible. Since June 25 2009 (revision 168), you need at least Eclipse 3.5 / GEF 3.5 to run GEF3D.  
  
Note: Since GEF3D uses an SVN based repository, you probably want to install an Eclipse subversion client, e.g., [http://subclipse.tigris.org/ Subclipse] (which is also required for installing the sources from the project file set, see next section).
+
Note: Since GEF3D uses a Git based repository, you probably want to install [http://www.eclipse.org/egit EGit], if it is not installed yet.
  
At this moment, GEF3D is not compatible with GEF 3.6, that is it will not work on Eclipse 3.6 (Helios). Besides, the UML Tools are missing in Eclipse 3.6, so the UML2 tools example will not work on 3.6 anyway.
+
As of revision 561, GEF3D also works with Eclipse 3.6 (Helios, containing GEF 3.6) and Eclipse 3.7 (Indigo, containing GEF 3.7). However, the UML Tools are missing in Eclipse 3.6/3.7, so the 3D-fied UML2 tools example will not work on 3.6/3.7.  
  
==Installing GEF3D==
+
== Installing GEF3D ==
  
There is no official version available yet, see [http://www.eclipse.org/projects/project-plan.php?projectid=technology.gef3d GEF3D project plan]. Currently you have to checkout the sources from the GEF3D code repository (a Subversion repository) and install a render engine separately.
+
There is no official version available yet, see [http://www.eclipse.org/projects/project-plan.php?projectid=technology.gef3d GEF3D project plan]. Currently you have to checkout the sources from the GEF3D code repository (a Subversion repository) and install a render engine separately.  
  
=== Check Out Sources ===
+
=== Check Out Sources ===
  
 
The easiest way to get all the GEF3D sources is to simply import the team project set  
 
The easiest way to get all the GEF3D sources is to simply import the team project set  
  
[http://eclipse.org/gef3d/resources/GEF3D.psf http://eclipse.org/gef3d/resources/GEF3D.psf]
+
[http://eclipse.org/gef3d/resources/GEF3D.psf http://eclipse.org/gef3d/resources/GEF3D.psf]  
  
This project set includes all necessary plugins and all examples as listed below. Download the psf file and then import it using the "Team Project Set" wizard (File / Import.. / Team / Team Project Set). (Screenshots and further explanation are provided at [http://eclipsesource.com/blogs/2009/11/13/wheres-your-project-set-getting-eclipse-sources-easily/ EclipseSource Blog], showing how to import the RAP project set).
+
This project set includes all necessary plugins and all examples as listed below. Download the psf file and then import it using the "Team Project Set" wizard (File / Import.. / Team / Team Project Set). (Screenshots and further explanation are provided at [http://eclipsesource.com/blogs/2009/11/13/wheres-your-project-set-getting-eclipse-sources-easily/ EclipseSource Blog], showing how to import the RAP project set -- importing the GEF3D project set is similar).  
  
 
Alternatively you can check out GEF3D's sources from  
 
Alternatively you can check out GEF3D's sources from  
  
svn://dev.eclipse.org/svnroot/technology/org.eclipse.gef3d
+
git://git.eclipse.org/gitroot/gef3d/org.eclipse.gef3d.git
 +
(or http://git.eclipse.org/gitroot/gef3d/org.eclipse.gef3d.git)
  
In order to test GEF3D, you'll need the following projects (please add org.eclipse to the name):
+
In order to test GEF3D, you'll need the following projects (please add org.eclipse to the name):  
* draw3d
+
* draw3d.geometry
+
* draw3d.graphics3d
+
* draw3d.ui
+
* gef3d
+
* gef3d.ext
+
* gef3d.ext.emf
+
* gef3d.gmf
+
  
The following packages contain the examples:
+
*draw3d
* gef3d.examples.graph -- simple graph editor
+
*draw3d.geometry
* gef3d.examples.ecore -- 3d-fied version of the Ecore diagram editor (from the Ecore Tools)
+
*draw3d.graphics3d
* gef3d.examples.uml2 -- 3d-fied version of the UML2 diagram editor (from the UML2 Tools)
+
*draw3d.ui
 +
*gef3d
 +
*gef3d.ext
 +
*gef3d.ext.emf
 +
*gef3d.gmf
  
Optionally you can check out the test and documentation projects, however there are currently not much tests and documentation available (but you can use the ant script in doc in order to generate the JavaDoc). Test and documentation projects are not included in the project set.
+
The following packages contain the examples:
  
=== Install a Renderer ===
+
*gef3d.examples.graph -- simple graph editor
Draw3D, the 3D version of Draw2D, needs a renderer module in order to produce any output. The renderer uses the extension point defined in org.eclipse.draw3d.graphics3d.
+
*gef3d.examples.ecore -- 3d-fied version of the Ecore diagram editor (from the Ecore Tools)
Currently, only LWJGL is supported, that is you have to checkout
+
* org.eclipse.draw3d.lwjgl
+
from the repository. This module only contains the Draw3D specific code, additionally you will need the LWJGL libraries. These libraries are available as an Eclipse plugin via the LWJGL update site at [http://lwjgl.org/update http://lwjgl.org/update].
+
A description can be found at the
+
[http://www.fernuni-hagen.de/se/personen/pilgrim/gef3d/lwjgl.html FernUni Hagen GEF3D project site].
+
  
Note: GEF3D revision 438 (and later) requires LWJGL 2.2.1. If you have installed an elder version of LWJGL, you can use the update manager to get the latest version.
+
The UML2 example is not part of the team set, as it only works with Eclipse 3.5 and the UML2 tools installed:
  
==Test GEF3D==
+
*gef3d.examples.uml2 -- 3d-fied version of the UML2 diagram editor (from the UML2 Tools)
  
You can test GEF3D by opening some diagrams with GEF3D. In case of ecore or UML2 (class, use case, activity diagram) the 3D-fied versions can open the very same files as the original 2D versions, that is simply open any existing diagram (Open With) with a 3D editor. If you open an UML diagram with the multi-editor, other diagrams can be simply drag-and-dropped on the editor to be opened in the very same 3D scene. GEF3D does not provide any concrete ecore or UML diagram files. You will have to simply create a new diagram using the original 2D ecore diagram editor or UML activity, use case, or class diagram editor respectively. After saving the newly created diagrams, you should be able to open these diagrams with the 3D versions ("Open With"..."). If you open an ecore or UML diagram with the multi editor 3D, you can simply drag an drop another diagram onto the 3D scene in order to open it as well.
+
Optionally you can check out the test and documentation projects, however there are currently not much tests and documentation available (but you can use the ant script in doc in order to generate the JavaDoc). Test and documentation projects are not included in the project set.  
  
As of revision 157 (June 7th 2009), the graph example comes with a wizard for creating graphs with a given number of nodes. Simply create a new example and choose GEF3D Examples / GEF3D Graph Example Model.
+
=== Install a Renderer  ===
  
While adding more features to GEF3D, we try to keep the examples updated. Creating nodes or connections should work in most cases, although the location of newly created elements might be not at the position expected; the same is true for direct edit.
+
Draw3D, the 3D version of Draw2D, needs a renderer module in order to produce any output. The renderer uses the extension point defined in org.eclipse.draw3d.graphics3d. Currently, only LWJGL is supported, that is you have to checkout
  
Note: The old extensions of the graph example (*.graphSample etc.) are not working anymore!
+
*org.eclipse.draw3d.lwjgl
  
==Additional Hints==
+
from the repository. This module only contains the Draw3D specific code, additionally you will need the LWJGL libraries. These libraries are available as an Eclipse plugin via the LWJGL update site at [http://lwjgl.org/update http://lwjgl.org/update], (see [[LWJGL Plugin]] for further information).
 +
 
 +
Note: GEF3D revision 438 (and later) requires LWJGL 2.2.1. If you have installed an elder version of LWJGL, you can use the update manager to get the latest version.
 +
 
 +
== Test GEF3D ==
 +
 
 +
''This is only a brief description, a longer one (including screen shots) can be found at '''[[GEF3D Run Examples]]'''''.
 +
 
 +
You can test GEF3D by opening some diagrams with GEF3D. In case of ecore or UML2 (class, use case, activity diagram) the 3D-fied versions can open the very same files as the original 2D versions, that is simply open any existing diagram (Open With) with a 3D editor. If you open an UML diagram with the multi-editor, other diagrams can be simply drag-and-dropped on the editor to be opened in the very same 3D scene. GEF3D does not provide any concrete ecore or UML diagram files. You will have to simply create a new diagram using the original 2D ecore diagram editor or UML activity, use case, or class diagram editor respectively. After saving the newly created diagrams, you should be able to open these diagrams with the 3D versions ("Open With"..."). If you open an ecore or UML diagram with the multi editor 3D, you can simply drag an drop another diagram onto the 3D scene in order to open it as well.
 +
 
 +
As of revision 157 (June 7th 2009), the graph example comes with a wizard for creating graphs with a given number of nodes. Simply create a new example and choose GEF3D Examples / GEF3D Graph Example Model.
 +
 
 +
While adding more features to GEF3D, we try to keep the examples updated. Creating nodes or connections should work in most cases, although the location of newly created elements might be not at the position expected; the same is true for direct edit.
 +
 
 +
Note: The old extensions of the graph example (*.graphSample etc.) are not working anymore!
 +
 
 +
== Additional Hints ==
 +
 
 +
If you run an GMF-GEF3D application, e.g., the UML2-3D editor, you'll maybe have a problem with the "pergen space". That is, you will probably see this exception message:
  
If you run an GMF-GEF3D application, e.g., the UML2-3D editor, you'll maybe have a problem with the "pergen space". That is, you will probably see this exception message:
 
 
<code><pre> This is the java.lang.OutOfMemoryError: PermGen space
 
<code><pre> This is the java.lang.OutOfMemoryError: PermGen space
 
at java.lang.ClassLoader.defineClass1(Native Method)
 
at java.lang.ClassLoader.defineClass1(Native Method)
Line 73: Line 82:
 
In order to solve that problem, you'll have to increase the size of the "pergen space". This can be done with the VM argument "-XX:PerSize", e.g.,  
 
In order to solve that problem, you'll have to increase the size of the "pergen space". This can be done with the VM argument "-XX:PerSize", e.g.,  
  
<code><pre>-XX:PermSize=128m -XX:MaxPermSize=512m</pre></code>.
+
<code><pre>-XX:PermSize=128m -XX:MaxPermSize=512m</pre></code>. [[Category:GEF3D]]
 
+
 
+
[[Category:GEF3D]]
+

Latest revision as of 07:57, 3 February 2012

Incubation Phase

Contents

[edit] Requirements

GEF3D requires at least Eclipse Platform 3.5 (Galileo), with GEF 3.5 and an OpenGL graphics card. For a list of (in-) compatible graphics cards, see GEF3D List of Graphics Card. Most of all you need an OpenGL card with VBO extension.

GEF3D now depends on GEF 3.5 and is not backwards compatible. Since June 25 2009 (revision 168), you need at least Eclipse 3.5 / GEF 3.5 to run GEF3D.

Note: Since GEF3D uses a Git based repository, you probably want to install EGit, if it is not installed yet.

As of revision 561, GEF3D also works with Eclipse 3.6 (Helios, containing GEF 3.6) and Eclipse 3.7 (Indigo, containing GEF 3.7). However, the UML Tools are missing in Eclipse 3.6/3.7, so the 3D-fied UML2 tools example will not work on 3.6/3.7.

[edit] Installing GEF3D

There is no official version available yet, see GEF3D project plan. Currently you have to checkout the sources from the GEF3D code repository (a Subversion repository) and install a render engine separately.

[edit] Check Out Sources

The easiest way to get all the GEF3D sources is to simply import the team project set

http://eclipse.org/gef3d/resources/GEF3D.psf

This project set includes all necessary plugins and all examples as listed below. Download the psf file and then import it using the "Team Project Set" wizard (File / Import.. / Team / Team Project Set). (Screenshots and further explanation are provided at EclipseSource Blog, showing how to import the RAP project set -- importing the GEF3D project set is similar).

Alternatively you can check out GEF3D's sources from

git://git.eclipse.org/gitroot/gef3d/org.eclipse.gef3d.git (or http://git.eclipse.org/gitroot/gef3d/org.eclipse.gef3d.git)

In order to test GEF3D, you'll need the following projects (please add org.eclipse to the name):

  • draw3d
  • draw3d.geometry
  • draw3d.graphics3d
  • draw3d.ui
  • gef3d
  • gef3d.ext
  • gef3d.ext.emf
  • gef3d.gmf

The following packages contain the examples:

  • gef3d.examples.graph -- simple graph editor
  • gef3d.examples.ecore -- 3d-fied version of the Ecore diagram editor (from the Ecore Tools)

The UML2 example is not part of the team set, as it only works with Eclipse 3.5 and the UML2 tools installed:

  • gef3d.examples.uml2 -- 3d-fied version of the UML2 diagram editor (from the UML2 Tools)

Optionally you can check out the test and documentation projects, however there are currently not much tests and documentation available (but you can use the ant script in doc in order to generate the JavaDoc). Test and documentation projects are not included in the project set.

[edit] Install a Renderer

Draw3D, the 3D version of Draw2D, needs a renderer module in order to produce any output. The renderer uses the extension point defined in org.eclipse.draw3d.graphics3d. Currently, only LWJGL is supported, that is you have to checkout

  • org.eclipse.draw3d.lwjgl

from the repository. This module only contains the Draw3D specific code, additionally you will need the LWJGL libraries. These libraries are available as an Eclipse plugin via the LWJGL update site at http://lwjgl.org/update, (see LWJGL Plugin for further information).

Note: GEF3D revision 438 (and later) requires LWJGL 2.2.1. If you have installed an elder version of LWJGL, you can use the update manager to get the latest version.

[edit] Test GEF3D

This is only a brief description, a longer one (including screen shots) can be found at GEF3D Run Examples.

You can test GEF3D by opening some diagrams with GEF3D. In case of ecore or UML2 (class, use case, activity diagram) the 3D-fied versions can open the very same files as the original 2D versions, that is simply open any existing diagram (Open With) with a 3D editor. If you open an UML diagram with the multi-editor, other diagrams can be simply drag-and-dropped on the editor to be opened in the very same 3D scene. GEF3D does not provide any concrete ecore or UML diagram files. You will have to simply create a new diagram using the original 2D ecore diagram editor or UML activity, use case, or class diagram editor respectively. After saving the newly created diagrams, you should be able to open these diagrams with the 3D versions ("Open With"..."). If you open an ecore or UML diagram with the multi editor 3D, you can simply drag an drop another diagram onto the 3D scene in order to open it as well.

As of revision 157 (June 7th 2009), the graph example comes with a wizard for creating graphs with a given number of nodes. Simply create a new example and choose GEF3D Examples / GEF3D Graph Example Model.

While adding more features to GEF3D, we try to keep the examples updated. Creating nodes or connections should work in most cases, although the location of newly created elements might be not at the position expected; the same is true for direct edit.

Note: The old extensions of the graph example (*.graphSample etc.) are not working anymore!

[edit] Additional Hints

If you run an GMF-GEF3D application, e.g., the UML2-3D editor, you'll maybe have a problem with the "pergen space". That is, you will probably see this exception message:

 This is the java.lang.OutOfMemoryError: PermGen space
	at java.lang.ClassLoader.defineClass1(Native Method)
	at java.lang.ClassLoader.defineClass(Unknown Source)

In order to solve that problem, you'll have to increase the size of the "pergen space". This can be done with the VM argument "-XX:PerSize", e.g.,

-XX:PermSize=128m -XX:MaxPermSize=512m
.