Workbench creation/fr

Introduction
Cette page vous montrera comment ajouter un nouvel atelier à l'interface de FreeCAD. Les ateliers sont des conteneurs pour les commandes de FreeCAD. Ils peuvent être codés en Python, en C++, ou dans un mélange des deux, ce qui a l'avantage d'allier la vitesse du C++ à la flexibilité du Python. Dans tous les cas, cependant, votre atelier sera lancé par un ensemble de deux fichiers Python. Il peut s'agir d'ateliers "internes", inclus dans la distribution de FreeCAD, ou d'ateliers "externes", distribués via le Gestionnaire des extensions ou installés manuellement par téléchargement depuis un dépôt en ligne. Les ateliers internes peuvent être codés en C++, Python, ou une combinaison des deux, alors que les ateliers externes doivent être en Python uniquement.

La structure Atelier
Vous avez besoin d'un dossier, avec le nom de votre choix, placé dans le répertoire Mod de l'utilisateur, avec un fichier et, éventuellement, un fichier. Le fichier Init est exécuté au démarrage de FreeCAD et le fichier est exécuté immédiatement après, mais uniquement lorsque FreeCAD démarre en mode GUI. C'est tout ce dont FreeCAD a besoin pour trouver votre atelier au démarrage et l'ajouter à son interface.

Le répertoire User Mod est un sous-répertoire du répertoire de données de l'application utilisateur (vous pouvez trouver ce dernier en tapant dans la console Python):
 * Sous Linux, il s'agit généralement de  ou.
 * Sous Windows, il s'agit de, qui est généralement.
 * Sur macOS, il s'agit généralement de.

Le répertoire Mod devrait ressembler à ceci:

Dans ces fichiers, vous pouvez faire ce que vous voulez. Ils sont généralement utilisés comme ceci :


 * Dans le fichier Init.py, vous ajoutez simplement quelques éléments utilisés même lorsque FreeCAD fonctionne en mode console, par exemple les importateurs et les exportateurs de fichiers


 * Dans le fichier InitGui.py, vous définissez généralement un atelier, qui contient un nom, une icône et une série de commandes FreeCAD (voir ci-dessous). Cet fichier Python définit également les fonctions exécutées lors du chargement de FreeCAD (essayez d'en faire le moins possible à ce niveau, afin de ne pas ralentir le démarrage). Un autre est exécuté lorsque l'atelier est activé (c'est là que vous ferez le plus du travail) et un troisième lorsque l'atelier est désactivé (vous pouvez donc supprimer des éléments si nécessaire).

La structure et le contenu des fichiers d'un atelier décrits ici constituent la manière classique de créer un nouvel atelier. Il est possible d'utiliser une légère variation dans la structure des fichiers lors de la création d'un nouvel atelier Python. Cette méthode alternative est mieux décrite comme un "atelier à espacement de noms", ouvrant la possibilité d'utiliser pip pour installer l'atelier. Les deux structures fonctionnent, il s'agit donc plutôt d'une question de préférence lors de la création d'un nouvel atelier. Le style et la structure pour les ateliers présentés ici sont disponibles dans l'espace de noms global de FreeCAD, alors que pour le style et la structure alternatifs, l'atelier réside dans un espace de noms dédié. Pour plus d'informations sur le sujet, voir En relation.

La structure d'atelier en C++
Si vous allez coder votre atelier en Python, vous n'avez pas besoin de prendre de précautions particulières, et pouvez simplement placer vos autres fichiers Python avec vos fichiers Init.py et InitGui.py. Lorsque vous travaillez en C++, cependant, vous devez faire plus attention, et commencer par respecter une règle fondamentale de FreeCAD : La séparation de votre environnement de travail entre une partie App (qui peut fonctionner en mode console, sans aucun élément GUI), et une partie Gui, qui ne sera chargée que lorsque FreeCAD fonctionnera avec son environnement GUI complet. Ainsi, lors du développement d'un atelier en C++, vous allez très probablement créer deux modules, un App et un Gui. Ces deux modules doivent bien sûr être appelables depuis Python. Tout module FreeCAD (App ou Gui) consiste, au minimum, en un fichier init de module. Voici un fichier typique AppMyModuleGui.cpp :

Le fichier Init.py
Vous pouvez choisir la licence de votre choix pour votre atelier, mais sachez que si vous souhaitez que votre atelier soit intégré et distribué avec le code source de FreeCAD à un moment donné, il doit être LGPL2+, comme dans l'exemple ci-dessus. Voir Licence.

Les fonctions et  vous permettent de fournir le nom et l'extension d'un type de fichier, ainsi qu'un module Python responsable de son importation. Dans l'exemple ci-dessus, un module gérera les fichiers. Voir Extraits de codes pour plus d'exemples.

Ateliers en Python
Ceci est le fichier InitGui.py:

En dehors de cela, vous pouvez faire ce que vous voulez : vous pouvez insérer tout votre code d'atelier dans le fichier InitGui.py si vous le souhaitez, mais il est généralement plus pratique de placer les différentes fonctions de votre atelier dans des fichiers séparés. Ainsi ces fichiers sont plus petits et plus faciles à lire. Ensuite, vous importerez ces fichiers dans votre fichier InitGui.py. Vous pouvez organiser ces fichiers comme bon vous semble, un bon exemple est en avoir un pour chaque commande FreeCAD que vous ajoutez.

Préférences
Vous pouvez ajouter une page Préférences pour votre atelier Python. Les pages Préférences recherchent une icône de préférence avec un nom spécifique dans le système de ressources Qt. Si votre icône ne se trouve pas dans le système de ressources ou si son nom n'est pas correct, votre icône n'apparaîtra pas sur la page Préférences.

Ajouter votre icône d'atelier :
 * l’icône des préférences doit être nommée "preferences-" + "nom du module" + ".svg" (en minuscules)
 * créez un fichier qrc contenant les noms de tous les icônes
 * dans le répertoire *.py principal, exécutez pyside-rcc -o myResources.py myqrc.qrc
 * dans InitGui.py, ajouter importer myResource(.py)
 * mettre à jour votre référentiel (git) avec myResources.py et myqrc.qrc

Vous devrez refaire les étapes si vous ajoutez/modifiez des icônes.

@kbwbe a créé un joli script pour compiler des ressources pour l'atelier A2Plus. Voir ci-dessous.

Ajouter votre/vos page(s) de préférence :
 * Vous devez compiler le plugin Qt Designer qui vous permet d’ajouter des paramètres de préférence avec Qt Designer
 * Créer un widget vide dans Qt Designer (sans boutons ni quoi que ce soit)
 * Concevez votre page de préférences, de nombreux paramètres qui doivent être enregistrés (préférences) doivent être l’un des widgets Gui::Pref* ajoutés par le plug-in)
 * Dans ces cas-là, veillez à renseigner PrefName (le nom de votre valeur de préférence) et PrefPath (ex: Mod/MyWorkbenchName), qui sauvegardera votre valeur sous BaseApp/Preferences/Mod/MyWorkbenchName
 * Enregistrez le fichier d'interface utilisateur dans votre atelier, assurez-vous qu'il est géré par cmake.
 * Dans votre atelier, par exemple dans le fichier InitGui, dans la méthode Initialize (mais tout autre endroit fonctionne également), ajoutez : FreeCADGui.addPreferencePage ("/path/to/myUiFile.ui", "MyGroup"), "MyGroup" étant l'un des groupes de préférences de la gauche. FreeCAD recherchera automatiquement un fichier "preferences-mygroup.svg" dans ses emplacements connus (que vous pouvez étendre avec FreeCADGui.addIconPath)
 * Assurez-vous que la méthode addPreferencePage n’est appelée qu’une fois, sinon votre page de préférence sera ajoutée plusieurs fois

Distribution
Pour distribuer votre atelier Python, vous pouvez soit simplement héberger les fichiers dans un endroit quelconque et demander à vos utilisateurs de les télécharger et de les placer manuellement dans leur répertoire Mod, ou vous pouvez les héberger dans un dépôt git en ligne (GitHub, GitLab, Framagit et Debian Salsa sont actuellement des emplacements supportés) et les configurer pour que le Gestionnaire des extensions les installe. Les instructions pour l'inclusion dans la liste officielle des modules complémentaires de FreeCAD peuvent être trouvées sur le Dépôt GitHub des extensions de FreeCAD. Pour utiliser le gestionnaire des extensions, un fichier de métadonnées package.xml doit être inclus, qui indique au gestionnaire des extensions comment trouver l'icône de votre atelier, et permet d'afficher une description, un numéro de version, etc. Il peut également être utilisé pour spécifier d'autres ateliers ou paquets Python dont votre atelier dépend, qui le bloquent ou qu'il est destiné à remplacer.

Pour un guide rapide sur la façon de créer un fichier package.xml de base et d'ajouter un atelier au Gestionnaire des extensions voir : Ajouter un atelier au gestionnaire des extensions.

En outre, vous pouvez inclure un fichier de métadonnées distinct décrivant vos dépendances Python. Il peut s'agir soit d'un fichier appelé metadata.txt décrivant les dépendances externes de votre atelier (soit d'autres addons, ateliers ou modules Python), soit d'un fichier requirements.txt décrivant vos dépendances Python. Notez que si vous utilisez un fichier requirements.txt, seuls les noms des paquets spécifiés sont utilisés pour la résolution des dépendances : les options de la commande pip, les options include et les informations de version ne sont pas prises en charge par le gestionnaire d'addons. Les utilisateurs peuvent exécuter manuellement le fichier d'exigences en utilisant pip si ces fonctionnalités sont requises.

Le format du fichier metadata.txt est du texte brut, avec trois lignes optionnelles :

Chaque ligne doit consister en une liste d'éléments, séparés par des virgules, dont dépend votre atelier. Les ateliers peuvent être soit un atelier FreeCAD interne, par exemple "FEM", soit une extension externe, par exemple "Curves". Les bibliothèques Python requises et optionnelles doivent être spécifiées avec leur nom Python canonique, tel que vous l'utiliseriez avec. Par exemple :

Vous pouvez également inclure un script qui est exécuté lorsque votre paquet est désinstallé. Il s'agit d'un fichier appelé "uninstall.py" situé au niveau supérieur de votre extension. Il est exécuté lorsqu'un utilisateur désinstalle votre extension à l'aide du gestionnaire des extensions. Utilisez-le pour nettoyer tout ce que votre extension a pu faire sur le système de l'utilisateur et qui ne devrait pas persister après la disparition de l'extension (par exemple, suppression des fichiers de cache, etc.).

Pour que votre extension soit lue correctement par le gestionnaire des extensions, vous pouvez activer un "mode développeur" dans lequel le gestionnaire des extensions examine toutes les extensions disponibles et s'assure que leurs métadonnées contiennent les éléments requis. Pour activer ce mode, sélectionnez :, voir Réglage des préférences.

Ateliers en C++
Si vous voulez coder votre atelier en C++, vous souhaiterez probablement coder aussi sa définition elle-même en C++ (bien que cela ne soit pas nécessaire : vous pouvez également coder uniquement les outils en C++, et laisser la définition de de l'atelier en Python). Dans ce cas, le fichier InitGui.py devient très simple : il peut contenir une seule ligne :

où MyModule est votre atelier C++ complet, incluant les commandes et la définition de l'atelier.

Le codage des ateliers C++ fonctionne de manière assez similaire. Il s'agit d'un fichier Workbench.cpp typique à inclure dans la partie interface graphique de votre module :

Préférences
Vous pouvez également ajouter une page de préférences pour les ateliers C++. Les étapes sont similaires à celles de Python.

Distribution
Il y a deux options pour distribuer un atelier C++, vous pouvez soit héberger vous-même des versions précompilées pour les différents systèmes d'exploitation, soit demander à ce que votre code soit intégré au code source de FreeCAD. Comme mentionné ci-dessus, cela nécessite une licence LGPL2+, et vous devez d'abord présenter votre atelier à la communauté dans le forum de FreeCAD pour revue.

Commandes FreeCAD
Les commandes FreeCAD constituent le bloc de construction de base de l'interface FreeCAD. Ils peuvent apparaître sous la forme d'un bouton dans les barres d'outils et d'une entrée de menu dans les menus. Mais c'est la même commande. Une commande est une simple classe Python, qui doit contenir un couple attributs et fonctions prédéfinis, définissant le nom de la commande, son icône et l'action à effectuer lorsque la commande est activée.

Définition des commandes en C++
De même, vous pouvez coder vos commandes en C++, typiquement dans un fichier Commands.cpp dans votre module Gui. Ceci est un fichier Commands.cpp typique :

"Compiler" votre fichier ressources
compileA2pResources.py depuis l'atelier A2Plus :

En relation

 * Traduction et ateliers externes
 * Discussion sur le forum - Namespaced Workbenches
 * freecad.workbench_starterkit