Développement d'applications 3D avec JOGL et l'environnement de développement Eclipse

Veuillez ouvrir le menu Windows->Preferences, et filtrer les préférences en commençant à taper user libraries dans le champ de recherche. Veuillez alors sélectionner ce menu.

Veuillez alors cliquer sur le bouton new pour créer une nouvelle bibliothèque personnalisée.

Veuillez alors saisir le nom de la nouvelle bibliothèque (jogl_core) et vérifier que la case à cocher System Library est décochée.

Votre bibliothèque vient d'être ajoutée : mais elle est vide. Cliquez sur le bouton Add Jars (après vous être assuré que la bibliothèque est sélectionnée).

Veuillez, avec l'explorer qui vous est alors soumis, vous rendre dans le dossier de l'archive jogamp-all-platforms.7z décompressée précédemment. Veuillez entrer dans le sous-dossier jars, et sélectionner les deux fichiers suivants (avec la touche CTRL en même temps que le clic, au besoin) :

• jogl-all.jar ;
• gluegen-rt.jar.

Vous verrez donc que des « liens » ont été ajoutés sur vos jars. Pour chacun d'eux, on peut alors distinguer quatre nœuds enfants :

• le lien vers les sources du jar : il est possible de les télécharger sur la page de jogamp que je vous ai déjà donnée, mais je n'ai pas choisi de m'en préoccuper dans l'article. Cela dit, la procédure n'a rien de compliqué ;
• le lien vers la javadoc du jar ;
• le lien vers les fichiers natifs (codés en C/C++) du jar ;
• la définition des fichiers à exclure de la bibliothèque : nous n'aurons pas besoin de cette fonctionnalité.

Ici, nous ne remplirons que le nœud javadoc des deux jars : en effet, même si la bibliothèque JOGL est basée sur l'utilisation de fichiers natifs, comme ils sont déjà fournis dans des jars on n'aura pas besoin de renseigner le nœud natives library. Il suffira donc d'ajouter des liens sur les différents jars contenant ces fameux fichiers. Ce que nous ferons ultérieurement dans cet article.

Renseigner le nœud javadoc permet notamment à Eclipse de bien nommer les arguments des méthodes de JOGL implémentées ou redéfinies. Par exemple avoir

draw(int widht, int height)

(la méthode draw est factice), au lieu de

draw(int arg0, int arg1)

Ce qui déjà nous facilite bien le travail : on n'est plus forcé d'aller regarder sur la documentation de JOGL pour savoir comment s'en servir.

Veuillez double-cliquer sur le nœud du jar glugen-rt. Veuillez alors sélectionner l'option Javadoc URL et cliquer sur le bouton Browse.

Veuillez alors sélectionner le chemin où vous avez décompressé la javadoc de gluegen, et sélectionner le sous-dossier javadoc. Le bouton Validate sert à certifier que le chemin est bien celui correspondant à une javadoc.

Veuillez faire de même avec le nœud javadoc du jar jogl-all : bien sûr en choisissant le sous-dossier javadoc de l'archive jogl-javadoc décompressée.

La bibliothèque jogl_core est maintenant définie : il ne manque plus que les différentes bibliothèques natives.

Nous allons d'abord créer la bibliothèque JOGL_natives_Windows_32. La procédure sera similaire pour toutes les bibliothèques.

1. Cliquez sur le bouton New, laissez le bouton System Library décoché, et nommez-la (jogl_natives_windows_32).
2. Sélectionnez cette nouvelle bibliothèque, cliquez sur Add Jars, et sélectionnez les jars (toujours dans le sous-dossier jars de l'archive jogamp-all-platforms décompressée) gluegen-rt-natives-windows-i586.jar et jogl-all-natives-windows-i586.jar.

Faites de même pour la bibliothèque jogl_natives_windows_64 : en choisissant les jars gluegen-rt-natives-windows-amd64.jar et jogl-all-natives-windows-amd64.jar.

Faites de même pour la bibliothèque jogl_natives_linux_32 : en choisissant les jars gluegen-rt-natives-linux-i586.jar et jogl-all-natives-linux-i586.jar.

Faites de même pour la bibliothèque jogl_natives_linux_64 : en choisissant les jars gluegen-rt-natives-linux-amd64.jar et jogl-all-natives-linux-amd64.jar.

Enfin, pour jogl_natives_mac_osx : choisissez les archives gluengen-rt-macosx-uniersal.jar et jogl-all-natives-macosx-universal.jar.

Veuillez enfin valider les préférences afin de ne pas perdre votre long travail.

Veuillez créer un nouveau projet Java. (Soit File->New->Java project si disponible. Ou sinon File->New Project puis dans la nouvelle fenêtre, choisir Java->Java project.) Veuillez ne pas valider tout de suite la création du projet.

Veuillez cliquer sur l'onglet Libraries puis sur le bouton Add Libraries.

Veuillez choisir l'option User Libraries (et cliquer sur le bouton Next). Veuillez alors choisir la bibliothèque jogl_core ainsi que la bibliothèque correspondant au couple votre os/votre architecture (par exemple, jogl_natives_windows_32 pour un Windows d'architecture 32 bits) : n'oubliez pas de cliquer sur Finish.

Veuillez copier les trois sources suivantes dans votre projet. Pour chaque source :

1. Copiez-la dans le presse-papiers ;
2. Sélectionnez le nœud src du projet dans la vue Project Explorer (au besoin, Window->Show View->Project Explorer pour la rendre visible) ;
3. Collez tout simplement : si le paquetage n'est pas encore créé, Eclipse le fera pour nous. Sinon, le fichier nouvellement créé sera placé dans le bon paquetage !

AppLauncher

Sélectionnez

1.
2.
3.
4.
5.
6.
7.
8.
9.

package com.gmail.bernabe.laurent.jogl.spinning_sphere; 

public class AppLauncher { 

    public static void main(String[] args) { 
        new MainFrame().setVisible(true); 
    } 

}

MainFrame

Cacher/Afficher le codeSélectionnez

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.

package com.gmail.bernabe.laurent.jogl.spinning_sphere; 

import java.awt.event.WindowAdapter; 
import java.awt.event.WindowEvent; 

import javax.media.opengl.GLCapabilities; 
import javax.media.opengl.GLProfile; 
import javax.media.opengl.awt.GLCanvas; 
import javax.swing.JFrame; 

import com.jogamp.opengl.util.FPSAnimator; 

public class MainFrame extends JFrame { 

    public MainFrame(){ 
        setTitle("Lit Sphere Demo, with JOGL"); 
        setSize(640, 480); 

        GLCapabilities glCapabilities = new GLCapabilities(GLProfile.getDefault()); 
        GLCanvas glCanvas = new GLCanvas(glCapabilities); 
        MyGLEventListener glListener = new MyGLEventListener(); 
        glCanvas.addGLEventListener(glListener); 
        add(glCanvas); 

        final FPSAnimator animator = new FPSAnimator(glCanvas, 60); 

        addWindowListener(new WindowAdapter() { 

            @Override 
            public void windowClosing(WindowEvent e) { 
                animator.stop(); 
                System.exit(0); 
            } 

        }); 

        animator.start(); 
    } 

    private static final long serialVersionUID = -1227038124975588633L; 

}

MyGLEventListener

Cacher/Afficher le codeSélectionnez

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
84.
85.
86.
87.
88.
89.

package com.gmail.bernabe.laurent.jogl.spinning_sphere; 

import javax.media.opengl.GL2; 
import javax.media.opengl.GLAutoDrawable; 
import javax.media.opengl.GLEventListener; 
import javax.media.opengl.glu.GLU; 

import com.jogamp.opengl.util.gl2.GLUT; 

public class MyGLEventListener implements GLEventListener { 

    @Override 
    public void init(GLAutoDrawable drawable) { 
        GL2 gl = drawable.getGL().getGL2(); 

        gl.glClearColor(0.8f, 0.5f, 0.0f, 1.0f); 

        gl.glEnable(GL2.GL_DEPTH_TEST); 
        gl.glClearDepth(1.0f); 

        gl.glShadeModel(GL2.GL_SMOOTH); 
        gl.glEnable(GL2.GL_LIGHTING); 

        gl.glEnable(GL2.GL_LIGHT0); 
        gl.glLightfv(GL2.GL_LIGHT0, GL2.GL_AMBIENT, light_0_ambient, 0); 
        gl.glLightfv(GL2.GL_LIGHT0, GL2.GL_DIFFUSE, light_0_diffuse, 0); 
        gl.glLightfv(GL2.GL_LIGHT0, GL2.GL_SPECULAR, light_0_specular, 0); 
        gl.glLightfv(GL2.GL_LIGHT0, GL2.GL_POSITION, light_0_position, 0); 

        gl.glEnable(GL2.GL_COLOR_MATERIAL); 
        gl.glColorMaterial(GL2.GL_FRONT_AND_BACK, GL2.GL_AMBIENT_AND_DIFFUSE); 
        gl.glMateriali(GL2.GL_FRONT_AND_BACK, GL2.GL_SHININESS, 90); 
        gl.glMaterialfv(GL2.GL_FRONT_AND_BACK, GL2.GL_SPECULAR, material_specular, 0); 
    } 

    @Override 
    public void dispose(GLAutoDrawable drawable) { 
        // TODO Auto-generated method stub 

    } 

    @Override 
    public void display(GLAutoDrawable drawable) { 
        GL2 gl = drawable.getGL().getGL2(); 
        gl.glClear(GL2.GL_COLOR_BUFFER_BIT | GL2.GL_DEPTH_BUFFER_BIT); 
        gl.glLoadIdentity(); 

        glu.gluLookAt( 
                camera[0], camera[1], camera[2], 
                0.0f, 0.0f, 0.0f, 
                0.0f, 1.0f, 0.0f 
        ); 

        gl.glRotatef(angle, 0f, 1f, 0f); 

        gl.glColor3f(1.0f, 0.0f, 0.0f); 
        glut.glutSolidSphere(1.0f, 20, 20); 

        angle += 0.1f; 
        angle %= 360f; 
    } 

    @Override 
    public void reshape(GLAutoDrawable drawable, int x, int y, int width, 
            int height) { 
        GL2 gl = drawable.getGL().getGL2(); 
        gl.glViewport(x, y, width, height); 

        gl.glMatrixMode(GL2.GL_PROJECTION); 
        gl.glLoadIdentity(); 
        glu.gluPerspective(60.0f, (float) width/height, 0.1f, 10.0f); 

        gl.glMatrixMode(GL2.GL_MODELVIEW); 
    } 

    private GLU glu = new GLU(); 
    private GLUT glut = new GLUT(); 

    private float camera [] = {0f, 0f, 5f}; 

    private float [] light_0_ambient = {0.01f, 0.01f, 0.01f, 0.01f}; 
    private float [] light_0_diffuse = {1.0f, 1.0f, 1.0f, 1.0f}; 
    private float [] light_0_specular = {1.0f,1.0f, 1.0f, 1.0f}; 
    private float [] light_0_position = {100f, 0f, 10f, 1f}; 

    private float [] material_specular = {1.0f, 1.0f, 1.0f, 1.0f}; 

    private float angle = 0f; 
}

Si vous lancez le projet (Run->Run As...-> Java Application et choix de la classe AppLauncher) : vous devriez voir apparaître une sphère rouge tournant sur elle-même.

Tout d'abord, il faut que vous sachiez repérer quelles bibliothèques sont intégrées au classpath de votre projet, et ce, directement depuis le Project Explorer. Ce sont ces nœuds dont l'icône est une pile de livres, sauf un : celui correspondant au JDK Java utilisé.

Sachez tout de même que si nous nous contentons ici d'ajouter des bibliothèques personnalisées, il est également possible d'importer un jar d'une bibliothèque existante dans le projet, puis de l'ajouter au classpath. Ce n'était pas possible pour JOGL, à cause des bibliothèques natives, mais de toute façon, cela dépasse le cadre de l'article.

La capture précédente montre que JoglCore et JoglLinux64 font partie du classpath. JRE System Library est bien sûr un artifice d'Eclipse, nous permettant d'un coup d'œil de voir quel est le JDK utilisé.

On veut donc remplacer JoglLinux64 par, mettons, JoglWindows32.

Veuillez, dans le project explorer, sélectionner le nœud racine du projet, et avec un clic droit, accéder au menu Build Path → Configure Build Path. Dans la fenêtre qui apparaît, cliquez sur l'onglet Libraries.

Pour retirer la bibliothèque « inadaptée » pour l'exportation, rien de plus simple. Il suffit de la sélectionner et de cliquer sur le bouton Remove. Ne vous inquiétez pas, elle sera juste supprimée du projet, pas de votre workspace Eclipse.

Pour ajouter la bibliothèque adéquate, la procédure ressemble beaucoup à celle que nous avons utilisée pour ajouter les bibliothèques lors de la création du projet.

1. Veuillez cliquer sur le bouton Add Library.
2. Veuillez choisir l'option User Libraries.
3. Veuillez cocher sur la bibliothèque à ajouter et valider : si vous avez un message d'erreur, normalement, c'est parce que la bibliothèque fait déjà partie de votre classpath.

Enfin, veuillez ne pas oublier de valider la fenêtre de configuration.

L'étape précédente, où nous n'avons retenu que la bibliothèque du système cible et la bibliothèque Jogl_core, est ultra importante : de cette manière Eclipse n'exportera dans le jar final que les bibliothèques natives du système cible. (On évite d'ajouter les bibliothèques natives de JOGL correspondant au système hôte, qui n'est pas celui pour lequel nos voulons déployer l'application.) Mais évidemment, pour tester à nouveau l'application, il faudra faire la manipulation inverse : enlever la bibliothèque JOGL du système cible et rétablir la bibliothèque JOGL du système hôte. Néanmoins, cette manipulation n'a rien de fastidieux, comme vous avez pu le remarquer.

Sélectionnez votre projet, et lancez le menu contextuel (par clic droit dessus) Export…
Dans la nouvelle fenêtre qui apparaît, sélectionnez l'option Java-> Runnable Jar File et cliquez sur Next.

L'option Launch Configuration correspond à la classe qui contient la méthode void main(String args[]) que l'on voudra utiliser comme point d'entrée (en effet, il peut y avoir plusieurs classes avec une telle méthode au sein du projet). Choisissez la classe AppLauncher du projet SpinningSphere3D (logique).
Inutile de vous précisez que l'option Export destination, avec le bouton Browse à sa droite, permet de sélectionnez le nom et l'emplacement du fichier à créer. Eclipse acceptant dans la boîte de dialogue les formats jar et zip : n'oubliez pas de préciser l'extension jar.
Enfin l'option Library Handing permet de choisir comment la bibliothèque sera intégrée au jar : choisissez « Extract required libraries into jar » afin que les différents fichiers de la bibliothèque JOGL fassent directement partie intégrante de l'archive générée.

Décochez si ce n'est déjà fait, l'option Save as ANT Script.

Cliquez sur Finish : le message d'avertissement qui apparaît veut vous sensibiliser aux problèmes éventuels de licences. Mais comme JOGL est Open Source, je pense que si votre projet n'est pas commercial, il n'y a pas de problème.
Vous pouvez répéter l'opération (changer le classpath puis exporter en jar autoexécutable) pour les différents systèmes d'exploitation et architectures voulus : cela ne devrait plus représenter trop de difficultés (cliquez donc sur OK si tout est bon pour vous, dans le cas contraire, c'est peut-être à vos risques et périls).

Voilà, c'est tout pour cet article.