Guide du développeur du Projet Looking Glass


Ce document fournit une introduction à la version pour développeurs du Projet Looking Glass, le projet open source sur java.net de bureau 3D par Sun. Il explique comment configurer un environnement de développement et comment compiler le Projet Looking Glass et les applications 3D.

1. Pour commencer
2. Configurer votre environnement de développement
3. Télécharger la version pour développeurs du Projet Looking Glass
4. Compiler le Projet Looking Glass
5. Lancer le Projet Looking Glass
6. Obtenir le dernier code source du Projet Looking Glass
7. Un tour rapide des sources du Projet Looking Glass
8. Contribuer au Projet Looking Glass
9. Apprendre comment écrire des applications 3D pour le Projet Looking Glass

1. Pour commencer

Si vous n'avez pas encore configuré votre environnement d'éxécution, veuillez consulter le Guide d'installation de la version de développement du Projet Looking Glass pour obtenir des informations. Vérifiez que votre système a au moins la configuration requise pour lancer le Projet Looking Glass.

Pour développer des applications et des améliorations du Projet Looking Glass vous devrez installer certains composants et télécharger le code source du Projet Looking Glass.

2. Configurer votre environnement de développement

Télécharger et installer les outils de développement

Le Projet Looking Glass utilise l'outil de compilation d'Apache ANT pour gérer le processus de compilation. Si vous n'avez pas encore installé ANT, téléchargez la version binaire depuis le site web d'apache.org :

http://ant.apache.org/

Note : Les instructions ci-dessous supposent que vous avez téléchargé la version binaire d'ANT dans /tmp.

Après avoir téléchargé ANT, installez le :
  1. Tout d'abord passez en root :

    % su root
    Password:
    donnez le mot de passe root
    #

  2. Installez Apache ANT :

    # cd /usr/local
    # tar -xzf /tmp/apache-ant-1.6.1-bin.tar.gz

  3. Quittez le shell root :

    # exit
    %

  4. De nombreuses variables d'environnement doivent maintenant être règlées. Voici la syntaxe pour bash(1) :

    ANT_HOME=/usr/local/apache-ant-1.6.1
    PATH=$ANT_HOME/bin:$PATH

3. Télécharger la version pour développeurs du Projet Looking Glass

Le code source de la version pour développeurs du Projet Looking Glass est disponible sur le projet open source LG3D sur java.net.

Enregistrez vous sur le site web java.net

Si vous ne vous êtes pas enregistré précedemment sur java.net alors vous devrez vous créer un compte avant de pouvoir télécharger le code source :

  1. Allez sur http://www.java.net et cliquez sur le lien Register en haut de la page.
  2. Entrez votre nom d'utilisateur et votre adresse mail préférés et cliquez ensuite sur le bouton [Register].
  3. Vous recevrez un mail avec les instructions afin de donner un mot de passe à votre compte. Une fois que vous aurez entré votre mot de passe et accepté le contrat de participation du site java.net, vous serez connecté.
  4. Maintenant allez sur le Site web du projet LG3D.
Pour naviguer dans le code source du coeur du Projet Looking Glass, cliquez sur lg3d-core dans la section Subprojects du site web du projet LG3D Cliquez ensuite sur Version control dans la section Project  tools de la barre latérale. Sur le côté droit vous verrez la représentation de l'arborescence du code source sous forme de liens. Vous pouvez cliquer dessus pour naviguer dans l'arborescence et télécharger individuellement des fichiers pour les lire.

Télécharger le code source de Projet Looking Glass

La prochaine étape est de télécharger le code source du Projet Looking Glass dans le système de développement que vous avez configuré.

  1. Tout d'abord créez un dossier pour le Projet Looking Glass, par exemple :

    % mkdir -p ~/projects/lg3d
    % cd ~/projects/lg3d


  2. Ensuite, connectez vous au serveur CVS cvs.dev.java.net :

    % cvs -d :pserver:username@cvs.dev.java.net:/cvs login
    CVS password:
    password

    Remplacez username et password avec les informations de votre compte java.net.

  3. Téléchargez le code source de lg3d-core :

    % cvs -d :pserver:username@cvs.dev.java.net:/cvs checkout lg3d-core

  4. Le projet lg3d-demo-apps contient plusieurs applications 3D, dont l'afficheur de CD et quelques tutoriels. Le bureau du Projet Looking Glass a besoin de ces fichiers, donc téléchargez les :

    % cvs -d :pserver:username@cvs.dev.java.net:/cvs checkout lg3d-demo-apps
Félicitations ! Vous avez fini de configurer votre environnement de compilation et vous pouvez maintenant compiler le Projet Looking Glass.

4. Compiler le Projet Looking Glass

La compilation du Projet Looking Glass est assurée par un fichier de compilation d'ANT (build.xml) qui se trouve dans votre dossier lg3d-core. Allez dans ce dossier et lancez la commande ant pour compiler le Projet Looking Glass :

% cd ~/projects/lg3d/lg3d-core
% ant

Vous devriez voir un résultat proche de ceci :
Buildfile: build.xml
 
init:
    [mkdir] Created dir: /home/username/projects/lg3d/lg3d-core/build/classes
 
unpack-x:
    [untar] Expanding: /home/username/projects/lg3d/lg3d-core/ext/lg3d-x11.tar.gz into /home/username/projects/lg3d/lg3d-core/ext
 
compile:
    [javac] Compiling 1 source file to /home/username/projects/lg3d/lg3d-core/build-tools
    [javac] Compiling 626 source files to /home/username/projects/lg3d/lg3d-core/build/classes
 
compile-x11:
 
check-escher:
    [javac] Compiling 25 source files to /home/username/projects/lg3d/lg3d-core/build/classes
 
init:
 
unpack-x:

native-x11:
     [exec] .:/home/username/projects/lg3d/lg3d-core/src/../build/classes
 
junit-tests:
 
no-junit-tests:
     [echo] Skipping junit tests because junit.jar is not installed in ext-unbundeled
 
compile-demo-apps:
    [javac] Compiling 5 source files to /home/username/projects/lg3d/lg3d-core/build/classes
     [copy] Copying 4 files to /home/username/projects/lg3d/lg3d-core/build/classes/org/jdesktop/lg3d/apps/cdviewer/resources
     [copy] Copying 1 file to /home/username/projects/lg3d/lg3d-core/build/classes/org/jdesktop/lg3d/apps/tutorial/resources
     [copy] Copying 1 file to /home/username/projects/lg3d/lg3d-core/build/classes/org/jdesktop/lg3d/apps/help/resources
 
jar:
    [mkdir] Created dir: /home/username/projects/lg3d/lg3d-core/build/lib
      [jar] Building jar: /home/username/projects/lg3d/lg3d-core/build/lib/lg3d-core.jar
 
all:
 
BUILD SUCCESSFUL
Total time: 32 seconds

5. Lancer le Projet Looking Glass

Il y a deux façons pour lancer le Projet Looking Glass : dans une fenêtre dans un environnement existant et comme un bureau en plein écran. Ces modes sont décrits dans la section Lancer le Projet Looking Glass du Guide d'installation du Projet Looking Glass.

Si vous avez des problèmes pour lancer le Projet Looking Glass, consultez la section Problèmes du Guide d'installation du Projet Looking Glass.

6. Obtenir le dernier code source du Projet Looking Glass

Pour resté à jour des derniers développements du Projet Looking Glass, connectez vous régulièrement au serveur CVS java.net et mettez à jour votre espace de travail CVS :

  1. Allez dans votre dossier ~/projects/lg/lg3d-core :

    % cd ~/projects/lg/lg3d-core

  2. Supprimez les fichiers d'une compilation précédente :

    % ant clean

  3. Allez dans le dossier :

    % cd ~/projects/lg

  4. Maintenant mettez à jour votre espace de travail avec le dernier code source du Projet Looking Glass :

    % cvs -d :pserver:username@cvs.dev.java.net:/cvs update -Pd lg3d-core

    et mettez à jour les applications de démonstration :

    % cvs -d :pserver:username@cvs.dev.java.net:/cvs update -Pd lg3d-demo-apps

    Remplacez username par votre nom d'utilisateur de java.net.

Maintenant que vous avez compilé avec succès le Projet Looking Glass, pourquoi ne pas continuer à lire et faire un rapide tour du dossier lg3d-core/ pour vous familiariser avec le code source ?

7. Un tour rapide des sources du Projet Looking Glass

Le code source du Projet Looking Glass se trouve dans le dossier lg3d-core/src. Voici un aperçu global des différents fichiers du repository CVS de lg3d-core.

Dossier Description
build/ Les fichiers compilés sont stockés dans ce dossier.
build-tools/ Les outils pour compiler le Projet Looking Glass.
build.xml Le fichier de contrôle de la compilation pour Ant.
ext/ Plusieurs composants fournis avec le Projet Looking Glass, notamment escher (des bindings Java pour X11) et une compilation stable de lg3d-x11.
ext-unbundled/ Un dossier où vous pouvez mettre les composants qui ne sont pas prévus pour la distribution avec le Projet Looking Glass (par exemple junit, les chargeurs de Java3D...). Vous pouvez installer là votre propre compilation de lg3d-x11 au lieu d'utiliser $LGX11HOME.
src/ La racine de l'arborescence du code source de lg3d-core.
    classes/ Tous les fichiers .java sont là.
Consultez les javadocs du paquet binaire dans docs/javadoc/api pour plus d'informations.
    devscripts/ Le code source pour divers scripts de développement du Projet Looking Glass. Ils utilisent des classes dans le dossier build/.
        HelloUniverse Lance la démonstration Java3D montrant un cube tournant dans une session du Projet Looking Glass.
        README Documentation pour certains des scripts de ce dossier.
        Xtest
Un script pour tester les classes Java X11 sans le support de X11.
        displayserver Lance le serveur d'affichage.
        lg3d-dev Lance une session du Projet Looking Glass dans une fenêtre (c'est le mode "dévelopeur" ou "pas de X").
        lg3d-session
Lance une session du Projet Looking Glass en plein écran, avec le support de X11.
        setup Un script assistant les autres scripts.
    etc/ Contient divers fichiers de configuration.
        jz/ Un dossier obsolète.
        lg3d/
            README Documentation pour les divers fichiers lgconfig*.
            lgconfig* Scripts de configuration pour les différents modes dans lesquels le Projet Looking Glass peut être lancé.
            logging.properties Fichier de configuration qui contrôle la verbosité du journal d'exécution du serveur d'affichage, /var/tmp/lgserver.log
                  displayconfig/ Pour les aventureux, ce dossier contient des fichiers qui vous permettent de lancer le Projet Looking Glass dans des environnements d'affichage plus complexes, comme un multi-écrans ou des murs stéréos. Le choix de la configuration est contrôlé par lgconfig.xml.

ATTENTION ! Les configurations d'affichage alternatives n'ont pas encore été testées extensivement !
    native/org/jdesktop/lg3d/displayserver/fws/x11/ Le code en C pour l'intégration de X11.
    resources/images/ Une série d'images utilisées par le Projet Looking Glass.
    scripts/ Scripts pour lancer le Projet Looking Glass. Ils utilisent les classes des fichiers jar.
        displayserver Lance le serveur d'affichage (les utilisateurs ne devraient pas le lancer directement).
        lg3d-dev Lance une session du Projet Looking Glass dans une fenêtre (c'est le mode "dévelopeur" ou "pas de X").
        lg3d-session Lance une session du Projet Looking Glass en plein écran, avec le support de X11.
        setup Un script assistant les autres scripts. (Les utilisateurs ne devraient pas le lancer directement).
tests/ Contiendra éventuellement la suite de tests pour le Projet Looking Glass.
www/ Les pages du site java.net et diverses documentations.

8. Contribuer au Projet Looking Glass

Apprenez ce que signifie contribuer

Lisez s'il vous plaît le guide Comment contribuer au projet Looking Glass pour plus d'informations sur ce que signifie contribuer, et si cela vous intéresse demandez un compte pour accéder au projet LG3D.

Demandez l'accès au projet LG3D

Pour demander l'accès au projet LG3D :

  1. Si vous n'êtes pas connecté sur java.net, allez sur http://www.java.net et connectez vous en entrant votre nom d'utilisateur et votre mot de passe dans les champs en haut de la page puis en cliquant sur le bouton [Login].
  2. Allez sur https://lg3d.dev.java.net et ajoutez la page à vos marque-pages pour y revenir plus facilement. Vous y retournerez souvent !
  3. Cliquez sur le lien Request project membership/role.
  4. Choisissez le rôle approprié :
    - Choisissez Observer si vous voulez juste compiler le Projet Looking Glass.
    - Choisissez Developer si vous comptez développer du code pour le Projet Looking Glass et que vous comptez contribuer au projet.
  5. Après avoir envoyé votre requête, vous recevrez un mail contenant les instructions sur comment accéder au projet.
Maintenant, quand vous allez sur le site web du projet LG3D vous devrez vous connecter pour accéder aux documents du projet.

9. Apprendre comment écrire des applications 3D pour le Projet Looking Glass

Le Projet Looking Glass inclue quelques exemples d'applications 3D que vous pouvez utiliser pour apprendre comment écrire des applications exploitant la nature 3D de l'environnement de bureau du Projet Looking Glass. Vous pouvez trouver ces exemples dans le projet lg3d-demo-apps.

Voir aussi :

Compiler et lancer le Projet Looking Glass avec NetBeans
Comment installer la version de développement du Projet Looking Glass
Notes de version pour développeurs du Projet Looking Glass
Contribuer au Projet Looking Glass


$Revision: 1.1 $ $Date: 2005/04/10 12:44:53 $