Create a FeaturePython object part I/fr

Introduction
Les objets FeaturePython (également appelés Objets créés par script) 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.
 * Sauvegarde et restauration des données (également appelées sérialisation) via des objets sans intégrer de script dans le fichier de document FreeCAD.
 * Une liberté créative pour adapter FreeCAD à n'importe quelle tâche.

Sur cette page, nous allons construire un exemple de travail d'une classe personnalisée FeaturePython, en identifiant tous les composants principaux et en comprenant comment tout fonctionne au fur et à mesure.

Comment ça marche?
FreeCAD est livré 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 une personnalisation avec une classe Python définie par l'utilisateur.

Cette classe Python personnalisée prend une référence à l'un de ces objets et le modifie. Par exemple, la classe Python peut ajouter des propriétés à l'objet ou le lier à d'autres objets. De plus, la classe Python peut implémenter certaines méthodes pour permettre à l'objet de répondre aux événements du document, ce qui permet de piéger les modifications de propriété de l'objet et de recalculer le document.

Lorsque vous travaillez avec des classes personnalisées et des objets FeaturePython, il est important de savoir que la classe personnalisée et son état ne sont pas enregistrés dans le document car cela nécessiterait l'incorporation d'un script dans un fichier de document FreeCAD, ce qui poserait un risque de sécurité important. Seul l'objet FeaturePython lui-même est enregistré (sérialisé). Mais comme le chemin du module de script est stocké dans le document, un utilisateur n'a qu'à installer le code de classe Python personnalisé en tant que module importable, suivant la même structure de dossier, pour retrouver la fonctionnalité perdue.

En haut

Mise en place
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 de FreeCAD, tapez dans la console Python de FreeCAD :
 * Sous Linux, il s'agit généralement de.
 * Sous Windows, c'est, ce qui est généralement.
 * Sous Mac OSX, il s'agit généralement de.

Maintenant, nous devons créer des fichiers.
 * Dans le dossier, créez un nouveau dossier appelé.
 * Dans le dossier, créez un fichier vide :.
 * Dans le dossier, créez un nouveau dossier appelé.
 * Dans le dossier, créez deux fichiers : et  (laissez les deux cases vides pour l'instant).

La structure de votre dossier devrait ressembler à ceci:

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

Le dossier est l'endroit pour jouer avec les nouveaux objets FeaturePython et le dossier  est le module dans lequel nous allons travailler. indique à Python qu'il y a un module importable dans le dossier et sera le fichier de classe pour notre nouvel objet FeaturePython.

Une fois nos chemins et fichiers de module créés, nous assurons que FreeCAD est correctement configuré:
 * Démarrez FreeCAD (si vous ne l'avez pas déjà fait).
 * Activez la Vue rapport.
 * Activez la console Python voir FreeCAD Scripting Basics.

Enfin, naviguez jusqu'au dossier et ouvrez  dans votre éditeur de code préféré. Nous ne modifierons que ce fichier.

En haut

Un objet FeaturePython
Commençons par écrire notre classe et son constructeur:

La méthode se décompose comme suit:

Ajoutez le code suivant en haut du fichier :

La méthode se décompose comme suit:

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

En haut

Test du code
Nous pouvons maintenant tester notre nouvel objet. Enregistrez votre code et revenez à FreeCAD. Assurez-vous que vous avez ouvert un nouveau document, vous pouvez le faire en appuyant sur + ou en sélectionnant.

Dans la console Python, tapez ce qui suit:

Maintenant, nous devons créer notre objet:

Vous devriez voir apparaître un nouvel objet dans la Vue en arborescence étiqueté "my_box".

Notez que l'icône est grise. FreeCAD nous dit que l'objet ne peut rien afficher dans la Vue 3D. Cliquez sur l'objet et regardez ses propriétés dans l'Éditeur de propriétés. Il n'y a pas grand-chose là-bas, juste le nom de l'objet.

Notez également qu'il y a une petite coche bleue à côté de l'objet FeaturePython dans l'arborescence. En effet, lorsqu'un objet est créé ou modifié, il est "touché" et doit être recalculé. Appuyez sur le bouton pour y parvenir. Nous ajouterons du code pour automatiser cela plus tard.

Jetons un oeil aux attributs de notre objet:

Cela retournera:

Il y a beaucoup d'attributs car nous accédons à l'objet FeaturePyton natif de FreeCAD créé à la première ligne de notre méthode. La propriété que nous avons ajoutée dans notre méthode  est là aussi.

Inspectons-la avec la méthode :

Cela retournera:

Nous pouvons voir notre propriété. Vérifions:

Cela retournera:

Il s'agit bien de la valeur assignée, nous savons donc que nous accédons à la classe personnalisée via 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 :

For a complete reference of methods available to implement on FeautrePython classes, see FeaturePython methods.

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