README_ECLIPSE.TXT 6.7 KB
Newer Older
Pierre Kraemer's avatar
Pierre Kraemer committed
1
 *** english version below ***
Pierre Kraemer's avatar
Pierre Kraemer committed
2

Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
3
Pour utiliser Eclipse (testé avec la version Helios, Galileo, Indigo & Juno)
4 5 6
 * Configurer un projet dans Eclipse :
 - Faire un nouveau projet C++
 - Choisir Makefile project -> Empty Project
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
7
 - Choisir Comme "Location": la racine de CGoGN
8
 - Choisir Toolchains: Linux GCC
Pierre Kraemer's avatar
Pierre Kraemer committed
9

10
 * Compilation avec le petit marteau ;) (l'icone)
Pierre Kraemer's avatar
Pierre Kraemer committed
11 12 13 14 15 16 17
Dans les propriétés du projet: 
-> C/C++ Build:
	Dans la configuration Default | Active:
	ajouter au chemin de Build Directory /build
	
	on peut ensuite ajouter des configurations pour compiler ce que l'on veut
	en changeant juste le Build directory:
18 19 20
	CGoGNRelease:		build/Release		(compile la lib en release)
	CGoGNDebug:		build/Debug		(compile la lib en debug)
	Apps:			build/Apps		(compile les exemples et les tutos)
Pierre Kraemer's avatar
Pierre Kraemer committed
21 22 23 24 25
	Tuto:			build/Apps/Tuto		(compile les tutos)
	etc..

Ceci ajoute dans le repertoire de CGoGN un .project et un .cproject.

26 27 28 29 30 31 32 33
 * Dépendances inter-projets et autocomplétion
Si le projet X dépend d'un autre projet, alors :
Projet X -> Properties -> Project references : cocher le projet dont il dépend.

 * Dépendances de Qt :
Afin d'éviter qu'Eclipse ne rejette les syntaxes Qt (les includes de Qt, les Q_OBJECT, les callbacks) :
 - Télécharger le plugin Qt "eclipse-integration" http://qt.nokia.com/developer/eclipse-integration/
 - Décompresser l'archive et copier son contenu dans le répertoire d'installation d'Eclipse (plugins et features)
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
34 35
 - Relancer Eclipse au moins une fois avec l'option "-clean" (relecture des répertoires locaux)
Normalement, dans Window --> Preferences de Eclipse, Qt apparait dans le menu.
36 37 38 39 40 41 42 43 44 45 46 47
 - Y ajouter le répertoire de Qt (/usr/bin sur Debian/Ubuntu) et le répertoire d'include (/usr/include/qt4).
Ensuite, pour chaque projet, ajouter les includes suivants dans Properties -> C/C++ general -> Paths and Symbols
parmi les includes de C++ :
 - /usr/include/qt4
 - /usr/include/qt4/Qt
 - /usr/include/qt4/QtCore
 - /usr/include/qt4/QtGui
 - /usr/include/qt4/QtOpenGL
REMARQUE : en bas de cette fenêtre, le bouton "Export Settings" permet d'exporter en XML la configuration afin 
de l'importer dans les autres projets.
 - Pour finir, un petit clic-droit sur le projet -> Index -> Freshen all files et le tour est joué.

48 49 50 51 52 53 54 55
 * Coloration syntaxique des shaders
 - Télécharger et décompresser EclipseShaders : http://sourceforge.net/projects/glshaders/
 - Copier les répertoires plugins et features dans le répertoire d'installation eclipse
 - Relancer Eclipse au moins une fois avec l'option --clean (relecture des répertoires locaux)
Eclipse reconnaîtra désormais les fichiers .frag et .vert.
Pour associer d'autres fichiers au programme GLSLeditor :
 - Preferences -> General -> Editors -> File Associations
Dans Preferences -> Shaders Preferences, on peut désormais configurer certaines options liées au shaders.
56 57 58 59 60

 * Coloration syntaxique des fichiers CMake
 - Installer CMakeEditor pour Eclipse en ajoutant l'URL dans Help -> Install New Software ... : http://cmakeed.sourceforge.net/eclipse/
 - Installer et redémarrer
 - Dans Preferences -> General -> Editors -> File Associations il est possible d'associer les CMakeLists.txt à ce logiciel d'édition
Sylvain Thery's avatar
Sylvain Thery committed
61
 
62 63 64 65
 * Problème indexeur
 Si l'indexeur plante avec comme message "Out of memory" (c'est la cas par défaut sur Juno lors de l'indexation totale de CGoGN),
 relancer eclipse avec l'option "/opt/eclipse/eclipse -vmargs -Xms512m -Xmx1024M" avant de refaire une indexation globale.

Sylvain Thery's avatar
Sylvain Thery committed
66 67 68 69
=========================================================================================
                                ENGLISH VERSION
=========================================================================================

Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
70
To use Eclipse (tested with version Helios, Galileoi, Indigo & Juno)
Sylvain Thery's avatar
Sylvain Thery committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

 * Setting up a project in Eclipse:
 - Make a new C + + project
 - Select Makefile project -> Empty Project
 - Choose As "Location": root CGoGN
 - Select Toolchain: GCC Linux

 * Compilation with the small hammer (icon)
In the project properties:
	-> C / C + + Build:
	In the configuration Default | Active:
	add to Build Directory path /build

	you can then add configurations to compile what we want by just changing the Build directory:
	CGoGNRelease: build / Release (compile the lib release)
	CGoGNDebug: build / Debug (compiles in debug lib)
	Apps: build / Apps (compile the examples and tutorials)
	Tutorial: Build / Apps / Tutorial (compiles tutorials)
	etc. ..

Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
91
This adds a .project. and .cproject files to the CGoGN directory.
Sylvain Thery's avatar
Sylvain Thery committed
92

Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
93 94
 * Project inter-dependencies and autocompletion
If project X depends on another project, then:
Sylvain Thery's avatar
Sylvain Thery committed
95 96 97
Project X -> Properties -> Project references: check the project which it depends.

 * Qt dependencies:
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
98
To avoid Eclipse rejecting the Qt syntax (includes, Q_OBJECT, callbacks):
Sylvain Thery's avatar
Sylvain Thery committed
99 100
 - Download the Qt plugin "eclipse-integration" http://qt.nokia.com/developer/eclipse-integration/
 - Unzip the archive and copy its contents into the installation directory of Eclipse (plugins and features)
Kenneth Vanhoey's avatar
Kenneth Vanhoey committed
101 102
 - Restart Eclipse at least once with the "-clean" (proofreading local directories)
Normally in Window --> Preferences of Eclipse, Qt appears in the menu.
Sylvain Thery's avatar
Sylvain Thery committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
 - Add the Qt directory (/ usr / bin on Debian / Ubuntu) and the directory include (/ usr/include/qt4).
Then, for each project, add the following includes in Properties -> C / C + + general -> Paths and Symbols
among the C + + includes:
 - / Usr/include/qt4
 - / Usr/include/qt4/Qt
 - / Usr/include/qt4/QtCore
 - / Usr/include/qt4/QtGui
 - / Usr/include/qt4/QtOpenGL
NOTE: at the bottom of this window, the button "Export Settings" allows you to export the configuration to XML
import it into other projects.
 - Finally, a small right-click the project -> Index -> Freshen all files and go.

 * Syntax of shaders
 - Download and unzip EclipseShaders: http://sourceforge.net/projects/glshaders/
 - Copy the directories features and plugins in the eclipse installation directory
 - Restart Eclipse at least once with the - clean (proofreading local directories)
Eclipse will now recognize the files. And frag. Green.
To assign other files in the program GLSLeditor:
 - Preferences -> General -> Editors -> File Associations
In Preferences -> Shaders Preferences, you can now configure some options related to the shader.

 * Syntax highlighting for CMake files
 - Install CMakeEditor for Eclipse by adding the URL in Help -> Install New Software ... : Http://cmakeed.sourceforge.net/eclipse/
 - Install and restart
 - In Preferences -> General -> Editors -> File Associations You can associate the CMakeLists.txt to editing software
 
129 130 131 132
 * Indexer problem
 If the indexer fails with an "Out of Memory" error (this is the case when indexing CGoGN fully on eclipse Juno for instance),
 then relaunch eclipse using some options to use a bigger heap "/opt/eclipse/eclipse -vmargs -Xms512m -Xmx1024M" before indexing
 CGoGN globally.