Installation des outils de d\u00e9veloppement<\/h2>\n\n
Si Sweet Home 3D cible un public g\u00e9n\u00e9ral, le d\u00e9veloppement de plug-ins n\u00e9cessite des comp\u00e9tences particuli\u00e8res, et vous devriez savoir comment programmer en Java<\/a> avec un IDE<\/a>, avant d’aller plus loin. Ce guide montre comment construire un plug-in avec Eclipse<\/a>, mais vous pouvez utiliser l’IDE de votre choix, ou pas d’IDE du tout. <\/p>\n\n T\u00e9l\u00e9chargez d’abord Eclipse depuis https:\/\/www.eclipse.org\/<\/a>. La version nomm\u00e9e Eclipse IDE for Java Developers<\/em> est suffisante pour d\u00e9velopper un plug-in, mais vous pouvez t\u00e9l\u00e9charger n’importe quelle version pour le d\u00e9veloppement Java. Le d\u00e9veloppement d’un plug-in est bas\u00e9 sur certaines classes de Sweet Home 3D qu’Eclipse doit conna\u00eetre pour pouvoir construire votre projet. La fa\u00e7on la plus simple d’ajouter des classes Sweet Home 3D \u00e0 Eclipse est de t\u00e9l\u00e9charger la version JAR ex\u00e9cutable de Sweet Home 3D disponible sur Maintenant que vous avez install\u00e9 les outils requis, voyons comment vous pouvez programmer votre premier plug-in pour Sweet Home 3D.<\/p>\n\n Tout d’abord, cr\u00e9ez une nouvelle sous-classe de com.eteks.sweethome3d.plugin.Plugin en choisissant l’\u00e9l\u00e9ment de menu Fichier > Nouveau > Classe<\/em> dans Eclipse.<\/p>\n\n Dans la bo\u00eete de dialogue Nouvelle classe Java<\/em>, entrez VolumePlugin comme nom de classe, entrez un package (ici le package choisi \u00e9tait com.eteks.test), et choisissez com.eteks.sweethome3d.plugin.Plugin comme super classe de VolumePlugin. Une fois cela fait, cliquez sur Comme vous pouvez le deviner d’apr\u00e8s le commentaire TODO, vous devez maintenant modifier l’impl\u00e9mentation de la m\u00e9thode getActions pour renvoyer une action de plug-in capable de calculer le volume des meubles mobiles. Remplacez return null\u00a0; par l’instruction suivante\u00a0: <\/p>\n\n et choisissez \u00c9dition > Correction rapide<\/em> dans le menu Eclipse pour cr\u00e9er la classe manquante VolumeAction, comme indiqu\u00e9 sur la figure\u00a04.<\/p>\n\n Dans la bo\u00eete de dialogue Nouvelle classe Java<\/em> qui appara\u00eet, cochez la case Type englobant<\/em> pour cr\u00e9er une classe interne de VolumePlugin et cliquez sur Terminer<\/em>. Cela cr\u00e9era la classe VolumeAction qui h\u00e9rite de la classe com.eteks.sweethome3d.plugin.PluginAction et contient une m\u00e9thode execute vide\u00a0: <\/p>\n\n Cette m\u00e9thode est celle que Sweet Home 3D appellera lorsque l’utilisateur lancera l’action du plug-in\u00a0; c’est donc l’endroit o\u00f9 vous devez impl\u00e9menter comment calculer le volume des meubles et l’afficher\u00a0:<\/p>\n\n Maintenant que vous avez sp\u00e9cifi\u00e9 ce que vous voulez que le plug-in fasse, vous devez d\u00e9crire comment l’utilisateur lancera cette nouvelle action. Vous avez le choix entre ajouter un nouvel \u00e9l\u00e9ment de menu<\/strong> \u00e0 un menu, et\/ou un nouveau bouton<\/strong> \u00e0 la barre d’outils. Ce choix se fait en d\u00e9finissant les propri\u00e9t\u00e9s appropri\u00e9es de l’action du plug-in lors de sa cr\u00e9ation. Par exemple, si vous voulez que les utilisateurs lancent l’action de volume avec l’\u00e9l\u00e9ment de menu Calculer le volume<\/em> trouv\u00e9 dans le menu Outils<\/em>, vous ajouterez le constructeur suivant \u00e0 la classe VolumnAction\u00a0: <\/p>\n\n La classe de plug-in VolumePlugin<\/a> est maintenant programm\u00e9e, et presque pr\u00eate \u00e0 fonctionner comme un plug-in dans Sweet Home 3D. Les deux derni\u00e8res choses \u00e0 faire sont\u00a0: <\/p>\n\n Un fichier ApplicationPlugin.properties<\/tt>\n d\u00e9crit le nom du plug-in, sa classe, les versions minimales de Sweet Home 3D et Java sous lesquelles il est pris en charge,\n et les aspects juridiques. Choisissez Fichier > Nouveau > Fichier<\/i> dans\n le menu Eclipse, entrez le nom de fichier ApplicationPlugin.properties<\/tt> et cliquez sur Terminer<\/i>, comme indiqu\u00e9\n sur la figure\u00a05. <\/p>\n\n Entrez ensuite la description suivante<\/a> dans le nouveau fichier et enregistrez-le\u00a0:<\/p>\n\n Le JAR du plug-in contient les fichiers class<\/tt> cr\u00e9\u00e9s \u00e0 partir de la compilation du fichier VolumePlugin.java<\/tt>,\n et le fichier ApplicationPlugin.properties<\/tt>. Comme Eclipse compile un fichier Java d\u00e8s que vous l’enregistrez, vous\n n’avez qu’\u00e0 choisir Fichier > Exporter…<\/i> dans le menu et s\u00e9lectionnez Java > Fichier JAR<\/i> dans la bo\u00eete de dialogue Exporter<\/i>\n qui s’affichera. Dans l’assistant Le plug-in<\/a> que vous avez d\u00e9velopp\u00e9 s’ex\u00e9cutera dans Sweet Home 3D, soit avec la version Java Web Start<\/a>, la version installateurs<\/a>, ou le fichier SweetHome3D-7.5.jar<\/a> que vous avez t\u00e9l\u00e9charg\u00e9 pr\u00e9c\u00e9demment. Comme ce dernier est un JAR ex\u00e9cutable, vous pouvez l’ex\u00e9cuter en double-cliquant dessus ou avec la commande suivante\u00a0: <\/p>\n\n Le plug-in<\/a> que vous avez d\u00e9velopp\u00e9 s’ex\u00e9cutera dans Sweet Home 3D, soit avec la version Java Web Start<\/a>, la version installateurs<\/a>, ou le fichier SweetHome3D-7.5.jar<\/a> que vous avez t\u00e9l\u00e9charg\u00e9 pr\u00e9c\u00e9demment. Comme ce dernier est un JAR ex\u00e9cutable, vous pouvez l’ex\u00e9cuter en double-cliquant dessus ou avec la commande suivante\u00a0: <\/p>\n\n Tant que vous testez, vous pr\u00e9f\u00e9rerez probablement ex\u00e9cuter Sweet Home 3D avec cette commande, pour pouvoir lire dans la console la trace de pile des exceptions lev\u00e9es lors de l’ex\u00e9cution de votre plug-in.<\/p>\n\n Une fois Sweet Home 3D lanc\u00e9, vous verrez le nouveau menu et son \u00e9l\u00e9ment appara\u00eetre comme indiqu\u00e9 sur la figure\u00a07\u00a0:<\/p>\n\n Si vous choisissez le nouvel \u00e9l\u00e9ment de menu pour l’exemple de maison<\/a> cr\u00e9\u00e9 dans le guide de l’utilisateur<\/a>, vous obtiendrez le r\u00e9sultat suivant\u00a0:<\/p>\n\n Si vous avez besoin de d\u00e9boguer votre plug-in depuis Eclipse, cr\u00e9ez une configuration de d\u00e9bogage en suivant ces \u00e9tapes\u00a0:<\/p>\n\n Chaque fois que vous modifiez le code source de votre plug-in, n’oubliez pas de g\u00e9n\u00e9rer le JAR du plug-in<\/a> avant de lancer la configuration de d\u00e9bogage que vous avez cr\u00e9\u00e9e. Pour acc\u00e9l\u00e9rer le processus d’exportation JAR dans Eclipse, passez \u00e0 la deuxi\u00e8me \u00e9tape de l’assistant d’exportation JAR et s\u00e9lectionnez l’option Enregistrer la description de ce JAR dans l’espace de travail<\/em>. Cela ajoutera un nouvel \u00e9l\u00e9ment dans le projet avec un \u00e9l\u00e9ment de menu contextuel Cr\u00e9er un JAR<\/em>. <\/p>\n<\/div>\n\n Une fois pr\u00eat, votre plug-in peut \u00eatre d\u00e9ploy\u00e9 sur l’ordinateur d’autres utilisateurs de Sweet Home 3D en le copiant simplement dans leur dossier de plug-ins<\/a>. \u00c0 partir de la version\u00a01.6, un fichier de plug-in peut \u00e9galement \u00eatre install\u00e9 dans le dossier des plug-ins de Sweet Home\u00a03D en double-cliquant dessus, si son extension est SH3P (modifiez simplement l’extension du fichier de .zip \u00e0 .sh3p). Si le fait de double-cliquer sur un fichier .sh3p ne lance pas Sweet Home\u00a03D (le plus probable sous Linux), vous pouvez \u00e9galement installer un plug-in avec la commande suivante dans une fen\u00eatre Terminal<\/em> (o\u00f9 Pour cesser d’utiliser un plug-in, supprimez son fichier du dossier des plug-ins et relancez Sweet Home\u00a03D.<\/p>\n\n Si vous voulez que votre plug-in puisse fonctionner avec tous les installateurs de Sweet Home\u00a03D<\/a> disponibles sur ce site Web, veillez \u00e0 ce qu’il reste conforme \u00e0 Java\u00a05, en s\u00e9lectionnant La programmation du premier plug-in vous a montr\u00e9 la vue d’ensemble. Voici quelques informations suppl\u00e9mentaires qui vous aideront \u00e0 aller plus loin. <\/p>\n\n La documentation la plus utile pour d\u00e9velopper un nouveau plug-in est l’API Sweet Home 3D<\/a> (Interface de programmation applicative), g\u00e9n\u00e9r\u00e9e avec l’outil javadoc. Sweet Home 3D est bas\u00e9 sur une architecture MVC (Model View Controller), il est donc essentiel de comprendre comment sa couche Mod\u00e8le est organis\u00e9e. La figure 13 (\u00e9galement disponible au format PDF<\/a>) pr\u00e9sente presque toutes les classes et interfaces disponibles dans la version 1.5 du package com.eteks.sweethome3d.model<\/a> qui correspond \u00e0 cette couche Mod\u00e8le. <\/p>\n\n [uml_diagram slug=\u00a0\u00bbmodel-classes-diagram\u00a0\u00bb map_name=\u00a0\u00bbmodel-classes-diagram\u00a0\u00bb caption=\u00a0\u00bbFigure 13. UML diagram of com.eteks.sweethome3d.model package\u00a0\u00bb caption_small=\u00a0\u00bb(click on a class to view its javadoc)\u00a0\u00bb]<\/p>\n\n La classe centrale de la couche Mod\u00e8le est la classe HomeApplication<\/a> (10), la superclasse abstraite de la classe principale de l’application SweetHome3D<\/a>. L’instance de cette classe donne acc\u00e8s aux instances Home<\/a> (7) actuellement \u00e9dit\u00e9es, et \u00e0 l’objet UserPreferences<\/a> (11) qui stocke l’unit\u00e9 de longueur<\/a> utilis\u00e9e (12), le catalogue de meubles<\/a> (14) et le catalogue de textures<\/a> (15) \u00e0 partir desquels l’utilisateur choisit des meubles<\/a> (17) et des textures<\/a> (18). Ces objets impl\u00e9mentent l’interface Selectable<\/a> (1) ainsi que l’objet ObserverCamera<\/a> (4), qui stocke l’emplacement de la cam\u00e9ra dans le mode Visiteur virtuel<\/em>. Toutes les informations externes g\u00e9r\u00e9es par les objets Mod\u00e8le, comme l’ic\u00f4ne et le mod\u00e8le 3D d’un meuble<\/a> (16), ou l’image d’une texture<\/a> (20) sont accessibles via l’interface Content<\/a> (19), impl\u00e9ment\u00e9e par la classe URLContent<\/a> et d’autres classes du package com.eteks.sweethome3d.tools<\/a>. <\/p>\n\n Ce diagramme UML devrait vous aider \u00e0 comprendre quelles classes sont disponibles dans le mod\u00e8le Sweet Home 3D et comment vous pouvez y acc\u00e9der, mais vous remarquerez probablement qu’aucun constructeur et aucun mutateur (ou setter si vous pr\u00e9f\u00e9rez) n’y sont cit\u00e9s. C’est juste par manque de place, mais vous pouvez les utiliser sans probl\u00e8me dans une classe de plug-in. Notez \u00e9galement que toute modification d’un objet existant du mod\u00e8le sera notifi\u00e9e aux composants affich\u00e9s soit avec des PropertyChangeEvent<\/a>s, avec des CollectionEvent<\/a>s (8) ou avec des SelectionEvent<\/a>s (6), permettant ainsi \u00e0 tous les changements d’\u00eatre refl\u00e9t\u00e9s imm\u00e9diatement \u00e0 l’\u00e9cran. <\/p>\n\n Le mod\u00e8le Sweet Home 3D n’est pas<\/strong> thread safe pour des raisons de performance. Toutes les modifications<\/strong> d’un objet appartenant au mod\u00e8le doivent \u00eatre effectu\u00e9es dans l’Event Dispatch Thread. <\/p>\n<\/div>\n\n L’architecture des classes de plug-in est beaucoup plus simple \u00e0 comprendre que celle de la couche Mod\u00e8le. Le package com.eteks.sweethome3d.plugin<\/a> ne contient que trois classes parmi lesquelles vous \u00eates cens\u00e9 utiliser uniquement les classes Plugin<\/a> et PluginAction<\/a>, comme le montre la figure 14 (\u00e9galement disponible au format PDF<\/a>). <\/p>\n\n [uml_diagram slug=\u00a0\u00bbplugin-classes-diagram\u00a0\u00bb map_name=\u00a0\u00bbplugin-classes-diagram\u00a0\u00bb caption=\u00a0\u00bbFigure 14. UML diagram of com.eteks.sweethome3d.plugin package\u00a0\u00bb caption_small=\u00a0\u00bb(click on a class to view its javadoc)\u00a0\u00bb]<\/p>\n\n Une instance de PluginManager<\/a> (1) est cr\u00e9\u00e9e au lancement de l’application et recherche les plug-ins install\u00e9s dans le dossier des plug-ins<\/a> de l’utilisateur. Chaque fois qu’une nouvelle maison est \u00e9dit\u00e9e, ce gestionnaire instancie et configure un objet Plugin<\/a> (3) pour chaque plug-in trouv\u00e9 au moment du lancement. Ensuite, il appelle la m\u00e9thode getActions<\/a> pour r\u00e9cup\u00e9rer toutes les actions<\/a> (4) qui seront ajout\u00e9es en tant qu’\u00e9l\u00e9ments de menu et\/ou boutons de la barre d’outils dans la fen\u00eatre de la maison. Chaque action est une instance de PluginAction<\/a>, qui ressemble \u00e0 la classe Action<\/a>, avec sa m\u00e9thode execute<\/a> et ses propri\u00e9t\u00e9s<\/a> modifiables (2). <\/p>\n\n Notez que la classe Plugin<\/a> vous donne acc\u00e8s \u00e0 une instance UndoableEditSupport<\/a> via sa m\u00e9thode getUndoableEditSupport<\/a>. D\u00e8s que vous modifiez une maison ou ses objets (meubles, murs…) dans la m\u00e9thode execute d’une instance PluginAction<\/a>, vous devez \u00e9galement poster un objet UndoableEdit<\/a> au support d’\u00e9dition annulable retourn\u00e9 par la m\u00e9thode getUndoableEditSupport, sinon les utilisateurs ne pourront pas annuler\/r\u00e9tablir correctement les modifications que vous avez apport\u00e9es. <\/p>\n\n Si vous pr\u00e9voyez de d\u00e9velopper un plug-in pour la communaut\u00e9 des utilisateurs de Sweet Home 3D, essayez de localiser les cha\u00eenes qu’il affiche, que ce soit dans le nom des actions et le menu ou dans les bo\u00eetes de dialogue que vous cr\u00e9erez (ou au moins pr\u00e9parez sa localisation). Deux constructeurs de la classe PluginAction<\/a> vous aideront \u00e0 organiser la traduction des propri\u00e9t\u00e9s des actions avec des fichiers .properties, et si vous avez besoin de traduire d’autres cha\u00eenes dans votre plug-in (comme celles de la bo\u00eete de dialogue affich\u00e9e par le plug-in test\u00e9<\/a>), r\u00e9utilisez ces fichiers .properties avec la classe Java ResourceBundle<\/a>.T\u00e9l\u00e9charger et installer Eclipse<\/h3>\n\n
eclipse.exe<\/code> (sous Windows), eclipse.app<\/code> (sous Mac OS X) ou eclipse<\/code> (sous Linux).![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/eclipse.png\")
T\u00e9l\u00e9charger et installer la biblioth\u00e8que Sweet Home 3D<\/h3>\n\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/addToBuildPath.png\")
Programmation d’un plug-in<\/h2>\n\n
Cr\u00e9ation de la classe de plug-in<\/h3>\n\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/newJavaClass.png\")
package com.eteks.test;
return new PluginAction<\/strong> [] {new VolumeAction<\/strong>()}; <\/pre>\n\n![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/quickFix.png\")
public class VolumeAction<\/strong> extends PluginAction<\/strong> { public class VolumeAction<\/strong> extends PluginAction<\/strong> { public VolumeAction<\/strong>() {\n
Cr\u00e9ation du fichier de description du plug-in<\/h3>\n\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/newFile.png\")
name<\/strong>=Volume des meubles mobiles
Cr\u00e9ation du JAR du plug-in<\/h3>\n\n
\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/jarExport.png\")
Test du plug-in<\/h3>\n\n
java -jar \/chemin<\/em>\/vers<\/em>\/SweetHome3D-7.5.jar<\/pre>\n\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/pluginMenu.png\")
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/pluginInAction.png\")
D\u00e9bogage du plug-in<\/h3>\n\n
\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/debugConfiguration.png\")
\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/classpathConfiguration.png\")
\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/sourcepathConfiguration.png\")
\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/eclipseDebug.png\")
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/09\/warning-1.gif\")
<\/figure>\n\n\n\nD\u00e9ploiement du plug-in<\/h3>\n\n
SweetHome3D<\/code> est le nom du fichier ex\u00e9cutable fourni avec les installateurs de Sweet Home\u00a03D)\u00a0:<\/p>\n\n\/chemin\/vers\/<\/em>SweetHome3D \/chemin\/vers\/<\/em>plugin.sh3p<\/pre>\n\n
<\/figure>\n\n\n\n1.5<\/code> dans le champ Niveau de conformit\u00e9 du compilateur<\/em> disponible dans la section Compilateur Java<\/em> de la bo\u00eete de dialogue affich\u00e9e par l’\u00e9l\u00e9ment de menu Projet > Propri\u00e9t\u00e9s<\/em> d’Eclipse.javaMinimumVersion<\/code> dans le fichier ApplicationPlugin.properties<\/code> de votre plug-in en cons\u00e9quence.<\/p>\n<\/div>\n\nAller plus loin<\/h2>\n\n
API Sweet Home 3D – Javadoc<\/h3>\n\n
Architecture des classes de mod\u00e8le<\/h3>\n\n
\n
![\"\"](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/11\/Frame-281.png\")
<\/figure>\n\n\n\nArchitecture des classes de plug-in<\/h3>\n\n
Localisation<\/h3>\n\n
![format PDF<\/a>) pr\u00e9sente presque toutes les classes et interfaces disponibles dans la version 1.5 du package](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/modelClassesDiagram.png\"){kind=link}
![format PDF<\/a>). <\/p>\n\n[uml_diagram slug=\u00a0\u00bbplugin-classes-diagram\u00a0\u00bb map_name=\u00a0\u00bbplugin-classes-diagram\u00a0\u00bb caption=\u00a0\u00bbFigure 14. UML diagram of com.eteks.sweethome3d.plugin package\u00a0\u00bb caption_small=\u00a0\u00bb(click on a class to view its javadoc)\u00a0\u00bb]<\/p>\n\nUne instance de PluginManager<\/a> (1) est cr\u00e9\u00e9e au lancement de l’application et recherche les plug-ins install\u00e9s dans le dossier des plug-ins<\/a> de l’utilisateur. Chaque fois qu’une nouvelle maison est \u00e9dit\u00e9e, ce gestionnaire instancie et configure un objet Plugin<\/a> (3) pour chaque plug-in trouv\u00e9 au moment du lancement. Ensuite, il appelle la m\u00e9thode getActions<\/a> pour r\u00e9cup\u00e9rer toutes les actions<\/a> (4) qui seront ajout\u00e9es en tant qu’\u00e9l\u00e9ments de menu et\/ou boutons de la barre d’outils dans la fen\u00eatre de la maison. Chaque action est une instance de PluginAction<\/a>, qui ressemble \u00e0 la classe Action<\/a>, avec sa m\u00e9thode execute<\/a> et ses propri\u00e9t\u00e9s<\/a> modifiables (2). <\/p>\n\nNotez que la classe Plugin<\/a> vous donne acc\u00e8s \u00e0 une instance UndoableEditSupport<\/a> via sa m\u00e9thode getUndoableEditSupport<\/a>. D\u00e8s que vous modifiez une maison ou ses objets (meubles, murs…) dans la m\u00e9thode execute d’une instance PluginAction<\/a>, vous devez \u00e9galement poster un objet UndoableEdit<\/a> au support d’\u00e9dition annulable retourn\u00e9 par la m\u00e9thode getUndoableEditSupport, sinon les utilisateurs ne pourront pas annuler\/r\u00e9tablir correctement les modifications que vous avez apport\u00e9es. <\/p>\n\nLocalisation<\/h3>\n\nSi vous pr\u00e9voyez de d\u00e9velopper un plug-in pour la communaut\u00e9 des utilisateurs de Sweet Home 3D, essayez de localiser les cha\u00eenes qu’il affiche, que ce soit dans le nom des actions et le menu ou dans les bo\u00eetes de dialogue que vous cr\u00e9erez (ou au moins pr\u00e9parez sa localisation). Deux constructeurs de la classe PluginAction<\/a> vous aideront \u00e0 organiser la traduction des propri\u00e9t\u00e9s des actions avec des fichiers .properties, et si vous avez besoin de traduire d’autres cha\u00eenes dans votre plug-in (comme celles de la bo\u00eete de dialogue affich\u00e9e par le plug-in test\u00e9<\/a>), r\u00e9utilisez ces fichiers .properties avec la classe Java ResourceBundle<\/a>.](\"https:\/\/www.sweethome3d.com\/wp-content\/uploads\/2025\/12\/pluginClassesDiagram.png\"){kind=link}