Create a FeaturePython object part I/fr

Introduction
Les objets FeaturePython (également appelés «objets scriptés») offrent aux utilisateurs la possibilité d'étendre FreeCAD avec des objets qui s'intègrent de manière transparente dans le framework FreeCAD.

Cela favorise:
 * Le prototypage rapide de nouveaux objets et outils avec des classes personnalisées de Python.
 * La sérialisation via les objets 'App::Property' sans incorporer de scripts dans le fichier document FreeCAD.
 * Une liberté créative pour adapter FreeCAD à n'importe quelle tâche!

Ce wiki vous fournira une compréhension complète de l'utilisation des objets FeaturePython et des classes Python personnalisées dans FreeCAD. Nous allons construire un exemple complet et fonctionnel d'une classe personnalisée FeaturePython, identifiant tous les principaux composants et comprendre de manieère fine dont tout cela fonctionne au fur et à mesure.

Comment ça marche?
FreeCAD est fourni avec un certain nombre de types d'objets par défaut pour gérer différents types de géométrie. Certains d'entre eux ont des alternatives 'FeaturePython' qui permettent la personnalisation de l'utilisateur avec une classe python personnalisée.

La classe personnalisée de Python prend simplement une référence à l'un de ces objets et le modifie de plusieurs façons. Par exemple, la classe Python peut ajouter des propriétés directement à l'objet, en modifiant d'autres propriétés lorsqu'il est recalculé ou en le liant à d'autres objets. De plus, la classe Python implémente certaines méthodes pour lui permettre de répondre aux événements du document, ce qui permet de piéger les changements de propriétés des objets et les recalculs du document.

Il est important de se rappeler, cependant, que pour autant que l'on puisse accomplir avec des classes personnalisées et des objets FeaturePython, quand vient le temps d'enregistrer le document, seul l'objet FeaturePython lui-même est sérialisé. La classe personnalisée et son état ne sont pas conservés entre les rechargements de documents. Cela nécessiterait d'incorporer un script dans le fichier de document FreeCAD, ce qui pose un risque de sécurité important, tout comme les risques posés par embedding VBA macros in Microsoft Office documents.

top

Configuration de votre environnement de développement
Pour commencer, les classes d'objets FeaturePython doivent agir comme des modules importables dans FreeCAD. Cela signifie que vous devez les placer dans un chemin qui existe dans votre environnement Python (ou l'ajouter spécifiquement). Pour les besoins de ce tutoriel, nous allons utiliser le dossier Macro utilisateur FreeCAD, mais si vous avez une autre idée en tête, n'hésitez pas à l'utiliser à la place!

Si vous ne savez pas où se trouve le dossier Macro FreeCAD, saisissez 'FreeCAD.getUserMacroDir(True)' dans la console Python de FreeCAD. L'endroit est configurable mais, par défaut, pour s'y rendre:
 * Windows: tapez '%APPDATA%/FreeCAD/Macro' dans la barre de chemin de fichier en haut de l'Explorateur
 * Linux: accédez à /home/USERNAME/.FreeCAD/Macro
 * Mac: accédez à /Users/USERNAME/Library/Preferences/FreeCAD/Macro

Maintenant, nous devons créer des fichiers.
 * Dans le dossier Macro, créez un nouveau dossier appelé fpo.
 * Dans le dossier fpo, créez un fichier vide: __init__.py.
 * Dans le dossier fpo, créez un nouveau dossier appelé box.
 * Dans le dossier de la boîte, créez deux fichiers: __init__.py et box.py (laissez les deux vides pour l'instant)

La structure de votre répertoire devrait ressembler à ceci:

Macro/ |--> fpo/ |--> __init__.py        |--> box/ |--> __init__.py            |--> box.py

Remarques:
 * Le dossier fpo fournit un endroit propice pour jouer avec les nouveaux objets FeaturePython et le dossier box est le module dans lequel nous travaillerons.
 * '__init__.py indique à Python que dans le dossier se trouve un module importable et box.py sera le fichier de classe pour notre nouvel objet FeaturePython.

Avec nos chemins de modules et fichiers créés, assurez-vous que FreeCAD est correctement configuré:

Finally, navigate to the folder and open  in your favorite code editor. We will only edit that file.

top

Un objet FeaturePython très basique
Commençons par écrire notre classe et son constructeur:

La méthode breakdown 

Dans le fichier box.py en haut, ajoutez le code suivant:

La méthode breakdown 

La méthode  n'est pas requise mais elle fournit un bon moyen d'encapsuler le code de création d'objet.

top

Test du code
Maintenant, nous pouvons essayer notre nouvel objet. Enregistrez votre code et revenez à FreeCAD, assurez-vous d'avoir ouvert un nouveau document. Vous pouvez le faire en appuyant sur CTRL+n ou en sélectionnant Fichier -> Nouveau

Dans la console Python, tapez ce qui suit:

Maintenant, nous devons créer notre objet:

Vous devriez voir un nouvel objet apparaître dans l'arborescence en haut à gauche intitulé my_box. Notez que l'icône est grise. FreeCAD nous dit simplement que l'objet n'est pas en mesure d'afficher quoi que ce soit dans la vue 3D... pour l'instant. Cliquez sur l'objet et notez ce qui apparaît dans le panneau de propriétés en dessous. Il n'y a pas grand-chose juste le nom de l'objet. Nous devrons ajouter quelques propriétés sous peu. Rendons également le référencement de notre nouvel objet un peu plus pratique:

Note that the icon is gray. FreeCAD is telling us that the object is not able to display anything in the 3D view. Click on the object and look at its properties in the Property editor. There is not much there, just the name of the object.

Also note that there is a small blue check mark next to the FeaturePython object in the Tree view. That is because when an object is created or changed it is "touched" and needs to be recomputed. Pressing the button will accomplish this. We will add some code to automate this later.

Et puis nous devrions jeter un oeil aux attributs de notre objet:

This will return:

Il y a beaucoup d'attributs parce que nous accédons à l'objet FreeCAD FeaturePyton natif que nous avons créé dans la première ligne de notre

Inspectons cela en appelant le

This will return:

Une fois que nous avons inspecté la propriété Proxy, nous pouvons voir notre

This will return:

Bien sûr, il retourne la valeur que nous avons assignée, donc nous savons que nous accédons à la classe personnalisée elle-même par le biais de l'objet FeaturePython.

C'était amusant! Mais voyons maintenant si nous pouvons rendre notre classe un peu plus intéressante ... et peut-être plus utile.

top

Ajout de propriétés
Les propriétés sont l'élément vital d'une classe FeaturePython. Heureusement, FreeCAD prend en charge un certain nombre de types de propriétés personnalisées de FeaturePython pour les classes FeaturePython. Ces propriétés sont attachées directement à l'objet FeaturePython lui-même et entièrement sérialisées lorsque le fichier est enregistré. Cela signifie que, sauf si vous souhaitez sérialiser les données vous-même, vous devrez trouver un moyen de les ancrer dans un type de propriété pris en charge. L'ajout de propriétés se fait tout simplement en utilisant le

Adding properties is done using the method. The syntax for the method is:

add_property(type, name, section, description)

Essayons d'ajouter une propriété à notre classe box. Basculez vers votre éditeur de code et passez à la

Ensuite, à la fin de la méthode, ajoutez:

Notez comment nous utilisons la référence à l'objet FeaturePython (sérialisable),

Quoi qu'il en soit, une fois que vous avez terminé, enregistrez les modifications et revenez à FreeCAD. Avant de pouvoir observer les modifications que nous avons apportées à notre code, nous devons recharger le module. Cela peut être accompli en redémarrant FreeCAD, mais le redémarrage de FreeCAD chaque fois que nous apportons une modification au code de classe python peut devenir un peu gênant. Pour le rendre plus facile, essayez ce qui suit dans la console Python:

Cela rechargera le module box, incorporant les modifications que vous avez apportées au fichier box.py comme si vous aviez redémarré FreeCAD. Le module étant rechargé, voyons maintenant ce que nous obtenons lorsque nous créons un objet:

Vous devriez voir le nouvel objet boîte apparaître dans l'arborescence à gauche. Mais avant de quitter le sujet des propriétés pour le moment, revenons en arrière et ajoutons quelques propriétés qui rendraient un objet boîte personnalisé *vraiment* utile: à savoir length, width et height. Revenez à votre code source et ajoutez les propriétés suivantes à
 * Sélectionnez-le et regardez le panneau des propriétés. Là, vous devriez voir la propriété 'Description'.
 * Passez la souris sur le nom de la propriété à gauche et voyez l'infobulle apparaître avec le texte de description que vous avez fourni.
 * Sélectionnez le champ et saisissez ce que vous voulez. Vous remarquerez que les commandes de mise à jour Python sont exécutées et affichées dans la console lorsque vous tapez des lettres et que la propriété change.

top

Let's add some more properties. Return to your source code and add the following properties to the method:

And let's also add some code to recompute the document automatically. Add the following line above the statement in the  method :

Maintenant, testez vos modifications comme suit:
 * Enregistrez vos modifications et revenez à FreeCAD.
 * Supprimez tous les objets existants et rechargez votre module.
 * Enfin, créez un autre objet boîte à partir de la ligne de commande en appelant



Now, test your changes as follows:
 * Save your changes and reload your module.
 * Delete all objects in the Tree view.
 * Create a new box object from the Python console by calling.

Once the box is created and you've checked to make sure it has been recomputed, select the object and look at its properties. You should note two things:
 * A new property group: Dimensions.
 * Three new properties: Height, Length and Width.

Note also how the properties have units. More specifically, they have taken on the linear units set in the user preferences.

No doubt you noticed that three different values were entered for the dimensions: a floating-point value and two different strings ( and ). The type assumes floating-point values are in millimeters, string values are parsed according to the units specified, and in the GUI all values are converted to the units specified in the user preferences ( in the image). This built-in behavior makes the type ideal for dimensions.

top

Piège à événements
Le dernier élément requis pour un objet FeaturePython de base est le piégeage des événements. Plus précisément, nous devons piéger l'événement, qui est appelé lorsque l'objet est recalculé. Il y a plusieurs autres événements au niveau du document qui peuvent être piégés dans notre objet, à la fois dans l'objet FeaturePython lui-même et dans le ViewProvider, que nous couvrirons dans une autre section. Ajoutez ce qui suit après la fonction :

Add the following after the function:

Testez le code comme suit:
 * Enregistrez les modifications et rechargez le module box dans la console python FreeCAD.
 * Supprimer tous les objets dans l'arborescence.
 * Recréez l'objet boîte.

Vous devriez voir le résultat dans la console Python, grâce à l'appel  que nous avons ajouté à la méthode.

That's it, you now know how to build a basic, functional FeaturePython object!

top

Le code terminé
top